xdi2.messaging.container.interceptor.impl.push

Class PushOutInterceptor

java.lang.Object

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

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

xdi2.messaging.container.interceptor.impl.push.PushOutInterceptor

All Implemented Interfaces:

Cloneable, Extension<MessagingContainer>, ExecutionResultInterceptor, Interceptor<MessagingContainer>, OperationInterceptor, Prototype<PushOutInterceptor>

public class PushOutInterceptor
extends AbstractInterceptor<MessagingContainer>
implements ExecutionResultInterceptor, OperationInterceptor, Prototype<PushOutInterceptor>

This interceptor executes push link contracts while a message is executed.

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 PushGateway	DEFAULT_PUSH_GATEWAY

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

DEFAULT_INIT_PRIORITY, DEFAULT_SHUTDOWN_PRIORITY

Constructor Summary

Constructors

Constructor and Description
PushOutInterceptor()
PushOutInterceptor(Graph pushLinkContractsGraph, PushGateway pushGateway)

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.
void	finish(MessagingContainer messagingContainer, ExecutionContext executionContext, ExecutionResult executionResult) Run on the execution context and result after it has been finished.
PushGateway	getPushGateway()
Graph	getPushLinkContractsGraph()
Graph	getPushLinkContractsGraph(ExecutionContext executionContext)
PushOutInterceptor	instanceFor(Prototype.PrototypingContext prototypingContext)
void	setPushGateway(PushGateway pushGateway)
void	setPushLinkContractsGraph(Graph pushLinkContractsGraph)

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_PUSH_GATEWAY

public static final PushGateway DEFAULT_PUSH_GATEWAY

Constructor Detail

PushOutInterceptor

public PushOutInterceptor(Graph pushLinkContractsGraph,
                          PushGateway pushGateway)

PushOutInterceptor

public PushOutInterceptor()

Method Detail

instanceFor

public PushOutInterceptor instanceFor(Prototype.PrototypingContext prototypingContext)

Specified by:

instanceFor in interface Prototype<PushOutInterceptor>

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

finish

public void finish(MessagingContainer messagingContainer,
                   ExecutionContext executionContext,
                   ExecutionResult executionResult)
            throws Xdi2MessagingException

Description copied from interface: ExecutionResultInterceptor

Run on the execution context and result after it has been finished.

Specified by:

finish in interface ExecutionResultInterceptor

Parameters:

messagingContainer - The current messaging container.

executionContext - The current execution context.

executionResult - The current execution result.

Throws:

Xdi2MessagingException

getPushLinkContractsGraph

public Graph getPushLinkContractsGraph(ExecutionContext executionContext)

getPushLinkContractsGraph

public Graph getPushLinkContractsGraph()

setPushLinkContractsGraph

public void setPushLinkContractsGraph(Graph pushLinkContractsGraph)

getPushGateway

public PushGateway getPushGateway()

setPushGateway

public void setPushGateway(PushGateway pushGateway)