xdi2.messaging.container.interceptor.impl.send

Class SendInterceptor

java.lang.Object

xdi2.messaging.container.impl.AbstractExtension<CONTAINER>

xdi2.messaging.container.interceptor.impl.AbstractInterceptor<MessagingContainer>

xdi2.messaging.container.interceptor.impl.send.SendInterceptor

All Implemented Interfaces:

Cloneable, Extension<MessagingContainer>, Interceptor<MessagingContainer>, OperationInterceptor, Prototype<SendInterceptor>

public class SendInterceptor
extends AbstractInterceptor<MessagingContainer>
implements OperationInterceptor, Prototype<SendInterceptor>

This interceptor can process $send operations.

Nested Class Summary

Nested classes/interfaces inherited from interface xdi2.messaging.container.Extension

Extension.InitPriorityComparator, Extension.ShutdownPriorityComparator

Nested classes/interfaces inherited from interface xdi2.messaging.container.Prototype

Prototype.PrototypingContext

Field Summary

Fields

Modifier and Type	Field and Description
static XDIAgent	DEFAULT_XDI_AGENT

Fields inherited from class xdi2.messaging.container.impl.AbstractExtension

DEFAULT_INIT_PRIORITY, DEFAULT_SHUTDOWN_PRIORITY

Constructor Summary

Constructors

Constructor and Description
SendInterceptor()
SendInterceptor(XDIAgent xdiAgent, Collection<Manipulator> manipulators)

Method Summary

Modifier and Type	Method and Description
InterceptorResult	after(Operation operation, Graph operationResultGraph, ExecutionContext executionContext) Run after an operation is executed.
InterceptorResult	before(Operation operation, Graph operationResultGraph, ExecutionContext executionContext) Run before an operation is executed.
static List<MessageBase<?>>	getForwardingMessagesOrMessageTemplates(ExecutionContext executionContext)
List<MessageBase<?>>	getForwardingMessagesOrMessageTemplates(Operation operation, ExecutionContext executionContext)
Collection<Manipulator>	getManipulators()
static Boolean	getNewId(ExecutionContext executionContext)
XDIAgent	getXdiAgent()
SendInterceptor	instanceFor(Prototype.PrototypingContext prototypingContext)
static void	putForwardingMessagesOrMessageTemplates(ExecutionContext executionContext, List<MessageBase<?>> forwardingMessages)
static void	putNewId(ExecutionContext executionContext, Boolean newId)
void	setManipulators(Collection<Manipulator> manipulators)
void	setXdiAgent(XDIAgent xdiAgent)

Methods inherited from class xdi2.messaging.container.impl.AbstractExtension

clearDisabled, clearDisabledForMessage, clearDisabledForMessageEnvelope, clearDisabledForOperation, getInitPriority, getShutdownPriority, init, setDisabled, setDisabledForMessage, setDisabledForMessageEnvelope, setDisabledForOperation, shutdown, skip

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface xdi2.messaging.container.Extension

clearDisabled, clearDisabledForMessage, clearDisabledForMessageEnvelope, clearDisabledForOperation, getInitPriority, getShutdownPriority, init, setDisabled, setDisabledForMessage, setDisabledForMessageEnvelope, setDisabledForOperation, shutdown, skip

Field Detail

DEFAULT_XDI_AGENT

public static final XDIAgent DEFAULT_XDI_AGENT

Constructor Detail

SendInterceptor

public SendInterceptor(XDIAgent xdiAgent,
                       Collection<Manipulator> manipulators)

SendInterceptor

public SendInterceptor()

Method Detail

instanceFor

public SendInterceptor instanceFor(Prototype.PrototypingContext prototypingContext)
                            throws Xdi2MessagingException

Specified by:

instanceFor in interface Prototype<SendInterceptor>

Throws:

Xdi2MessagingException

before

public InterceptorResult before(Operation operation,
                                Graph operationResultGraph,
                                ExecutionContext executionContext)
                         throws Xdi2MessagingException

Description copied from interface: OperationInterceptor

Run before an operation is executed.

Specified by:

before in interface OperationInterceptor

Parameters:

operation - The operation to process.

operationResultGraph - The operation's message result.

executionContext - The current execution context.

Returns:

Interceptor result that specifies how the operation should be further processed.

Throws:

Xdi2MessagingException

after

public InterceptorResult after(Operation operation,
                               Graph operationResultGraph,
                               ExecutionContext executionContext)
                        throws Xdi2MessagingException

Description copied from interface: OperationInterceptor

Run after an operation is executed.

Specified by:

after in interface OperationInterceptor

Parameters:

operation - The operation to process.

operationResultGraph - The operation's message result.

executionContext - The current execution context.

Returns:

Interceptor result that specifies how the operation should be further processed.

Throws:

Xdi2MessagingException

getForwardingMessagesOrMessageTemplates

public List<MessageBase<?>> getForwardingMessagesOrMessageTemplates(Operation operation,
                                                                    ExecutionContext executionContext)
                                                             throws Xdi2MessagingException

Throws:

Xdi2MessagingException

getXdiAgent

public XDIAgent getXdiAgent()

setXdiAgent

public void setXdiAgent(XDIAgent xdiAgent)

getManipulators

public Collection<Manipulator> getManipulators()

setManipulators

public void setManipulators(Collection<Manipulator> manipulators)

getForwardingMessagesOrMessageTemplates

public static List<MessageBase<?>> getForwardingMessagesOrMessageTemplates(ExecutionContext executionContext)

putForwardingMessagesOrMessageTemplates

public static void putForwardingMessagesOrMessageTemplates(ExecutionContext executionContext,
                                                           List<MessageBase<?>> forwardingMessages)

getNewId

public static Boolean getNewId(ExecutionContext executionContext)

putNewId

public static void putNewId(ExecutionContext executionContext,
                            Boolean newId)