xdi2.messaging.container.interceptor.impl

Class VariablesInterceptor

java.lang.Object

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

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

xdi2.messaging.container.interceptor.impl.VariablesInterceptor

All Implemented Interfaces:

Cloneable, Extension<MessagingContainer>, Interceptor<MessagingContainer>, MessageEnvelopeInterceptor, OperationInterceptor, TargetInterceptor, Prototype<VariablesInterceptor>

public class VariablesInterceptor
extends AbstractInterceptor<MessagingContainer>
implements MessageEnvelopeInterceptor, OperationInterceptor, TargetInterceptor, Prototype<VariablesInterceptor>

This interceptor can replace XDI variables in a $add operation with automatically generated persistent addresses.

Author:

markus

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 inherited from class xdi2.messaging.container.impl.AbstractExtension

DEFAULT_INIT_PRIORITY, DEFAULT_SHUTDOWN_PRIORITY

Constructor Summary

Constructors

Constructor and Description
VariablesInterceptor()

Method Summary

Modifier and Type	Method and Description
InterceptorResult	after(MessageEnvelope messageEnvelope, ExecutionContext executionContext, ExecutionResult executionResult) Run after a message envelope is executed.
InterceptorResult	after(Operation operation, Graph operationResultGraph, ExecutionContext executionContext) Run after an operation is executed.
InterceptorResult	before(MessageEnvelope messageEnvelope, ExecutionContext executionContext, ExecutionResult executionResult) Run before a message envelope is executed.
InterceptorResult	before(Operation operation, Graph operationResultGraph, ExecutionContext executionContext) Run before an operation is executed.
void	exception(MessageEnvelope messageEnvelope, ExecutionContext executionContext, ExecutionResult executionResult, Exception ex) Run if an exception occurs while a message envelope is executed.
VariablesInterceptor	instanceFor(Prototype.PrototypingContext prototypingContext)
XDIAddress	targetAddress(XDIAddress targetAddress, Operation operation, Graph operationResultGraph, ExecutionContext executionContext) Replaces or skips the target address before it is executed.
XDIStatement	targetStatement(XDIStatement targetStatement, Operation operation, Graph operationResultGraph, ExecutionContext executionContext) Replaces or skips the target statement before it is executed.

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

Constructor Detail

VariablesInterceptor

public VariablesInterceptor()

Method Detail

instanceFor

public VariablesInterceptor instanceFor(Prototype.PrototypingContext prototypingContext)

Specified by:

instanceFor in interface Prototype<VariablesInterceptor>

before

public InterceptorResult before(MessageEnvelope messageEnvelope,
                                ExecutionContext executionContext,
                                ExecutionResult executionResult)
                         throws Xdi2MessagingException

Description copied from interface: MessageEnvelopeInterceptor

Run before a message envelope is executed.

Specified by:

before in interface MessageEnvelopeInterceptor

Parameters:

messageEnvelope - The message envelope to process.

executionContext - The current execution context.

executionResult - The executionResult.

Returns:

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

Throws:

Xdi2MessagingException

after

public InterceptorResult after(MessageEnvelope messageEnvelope,
                               ExecutionContext executionContext,
                               ExecutionResult executionResult)
                        throws Xdi2MessagingException

Description copied from interface: MessageEnvelopeInterceptor

Run after a message envelope is executed.

Specified by:

after in interface MessageEnvelopeInterceptor

Parameters:

messageEnvelope - The message envelope to process.

executionContext - The current execution context.

executionResult - The executionResult.

Returns:

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

Throws:

Xdi2MessagingException

exception

public void exception(MessageEnvelope messageEnvelope,
                      ExecutionContext executionContext,
                      ExecutionResult executionResult,
                      Exception ex)

Description copied from interface: MessageEnvelopeInterceptor

Run if an exception occurs while a message envelope is executed.

Specified by:

exception in interface MessageEnvelopeInterceptor

executionContext - The current execution context.

executionResult - The executionResult.

ex - The exception that occurred.

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

targetStatement

public XDIStatement targetStatement(XDIStatement targetStatement,
                                    Operation operation,
                                    Graph operationResultGraph,
                                    ExecutionContext executionContext)
                             throws Xdi2MessagingException

Description copied from interface: TargetInterceptor

Replaces or skips the target statement before it is executed.

Specified by:

targetStatement in interface TargetInterceptor

Parameters:

targetStatement - The target statement.

operation - The operation to process.

executionContext - The current execution context.

Returns:

The new target statement, or the original target statement, or null to skip.

Throws:

Xdi2MessagingException

targetAddress

public XDIAddress targetAddress(XDIAddress targetAddress,
                                Operation operation,
                                Graph operationResultGraph,
                                ExecutionContext executionContext)
                         throws Xdi2MessagingException

Description copied from interface: TargetInterceptor

Replaces or skips the target address before it is executed.

Specified by:

targetAddress in interface TargetInterceptor

Parameters:

targetAddress - The target address.

operation - The operation to process.

executionContext - The current execution context.

Returns:

The new target address, or the original target address, or null to skip.

Throws:

Xdi2MessagingException