com.adobe.cq.social.scf

Interface OperationExtension<T>

Type Parameters:

T - operationType

All Known Subinterfaces:

CalendarOperationsExtension, CommentOperationExtension, CommunityGroupOperationExtension, CommunityMemberGroupProfileOperationExtension, CommunityMemberUserProfileOperationExtension, EnablementLearningPathModelOperationExtension, EnablementResourceModelOperationExtension, FileLibraryOperationExtension, FollowingOperationExtension, ForumOperationExtension, InheritedOperationExtension<T>, JournalOperationExtension, MessagingOperationExtension, ModerationOperationExtension, NotificationOperationsExtension, QnaForumOperationExtension, ReviewOperationExtension, SubscriptionCollectionOperationExtension, TallyOperationExtension, TranslationOperationExtension, UserPreferenceOperationExtension

All Known Implementing Classes:

AbstractOperationExtensionService

public interface OperationExtension<T>

An extension that might be called by an operation service before and after the specified operation is performed.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_ORDER
static java.lang.String	PROP_EXTENSION_ORDER

Method Summary

Modifier and Type	Method and Description
void	afterAction(Operation operation, Session session, T component, java.util.Map<java.lang.String,java.lang.Object> requestParameters) Callback method after the operation is performed.
void	beforeAction(Operation operation, Session session, Resource resource, java.util.Map<java.lang.String,java.lang.Object> requestParameters) Callback method before the operation is performed; the extension can abort the operation by throw an OperationException with appropriate HTTP error code.
java.lang.String	getName()
java.util.List<? extends Operation>	getOperationsToHookInto()
int	getOrder()

Field Detail

DEFAULT_ORDER

static final int DEFAULT_ORDER

See Also:

Constant Field Values

PROP_EXTENSION_ORDER

static final java.lang.String PROP_EXTENSION_ORDER

See Also:

Constant Field Values

Method Detail

getOrder

int getOrder()

Returns:

the extension calling order

getName

java.lang.String getName()

Returns:

the name of the operation.

getOperationsToHookInto

java.util.List<? extends Operation> getOperationsToHookInto()

Returns:

list of operations for which this extension should be applied to.

beforeAction

void beforeAction(Operation operation,
                  Session session,
                  Resource resource,
                  java.util.Map<java.lang.String,java.lang.Object> requestParameters)
           throws OperationException

Callback method before the operation is performed; the extension can abort the operation by throw an OperationException with appropriate HTTP error code.

Parameters:

operation - the requested Operation.

session - the session used by the operation.

resource - the resource on which the operation is being performed. The Session of this resource belongs to the original request.

requestParameters - the parameters that have been passed as part of the request to perform the operation.

Throws:

OperationException - thrown if any one of the operations extensions throws an exception. This aborts the operations.

afterAction

void afterAction(Operation operation,
                 Session session,
                 T component,
                 java.util.Map<java.lang.String,java.lang.Object> requestParameters)
          throws OperationException

Callback method after the operation is performed.

Parameters:

operation - requested Operation.

session - the session that is being used to perform the operation.

component - the resource on which the operation is being performed. The Session of this resource belongs to the original request.

requestParameters - the parameters that have been passed as part of the request to perform the operation.

Throws:

OperationException - thrown if any one of the operations extensions throws an exception.