xdi2.messaging.container.interceptor.impl.linkcontract

Class LinkContractInterceptor

java.lang.Object

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

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

xdi2.messaging.container.interceptor.impl.linkcontract.LinkContractInterceptor

All Implemented Interfaces:

Cloneable, Extension<MessagingContainer>, Interceptor<MessagingContainer>, MessageInterceptor, OperationInterceptor, TargetInterceptor, Prototype<LinkContractInterceptor>

public class LinkContractInterceptor
extends AbstractInterceptor<MessagingContainer>
implements MessageInterceptor, OperationInterceptor, TargetInterceptor, Prototype<LinkContractInterceptor>

This interceptor enforces link contracts while a message is executed.

Author:

animesh

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
LinkContractInterceptor()
LinkContractInterceptor(Graph linkContractsGraph)

Method Summary

Modifier and Type	Method and Description
InterceptorResult	after(Message message, ExecutionContext executionContext, ExecutionResult executionResult) Run after a message is executed.
InterceptorResult	after(Operation operation, Graph operationResultGraph, ExecutionContext executionContext) Run after an operation is executed.
InterceptorResult	before(Message message, ExecutionContext executionContext, ExecutionResult executionResult) Run before a message is executed.
InterceptorResult	before(Operation operation, Graph operationResultGraph, ExecutionContext executionContext) Run before an operation is executed.
static XDIAddress	getEvaluationResult(ExecutionContext executionContext)
static LinkContract	getLinkContract(ExecutionContext executionContext)
Graph	getLinkContractsGraph()
Graph	getLinkContractsGraph(ExecutionContext executionContext)
LinkContractInterceptor	instanceFor(Prototype.PrototypingContext prototypingContext)
static void	putEvaluationResult(ExecutionContext executionContext, XDIAddress evaluationResult)
static void	putLinkContract(ExecutionContext executionContext, LinkContract linkContract)
void	setLinkContractsGraph(Graph linkContractsGraph)
XDIAddress	targetAddress(XDIAddress targetXDIAddress, Operation operation, Graph operationResultGraph, ExecutionContext executionContext) Replaces or skips the target address before it is executed.
XDIStatement	targetStatement(XDIStatement targetXDIStatement, 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

LinkContractInterceptor

public LinkContractInterceptor(Graph linkContractsGraph)

LinkContractInterceptor

public LinkContractInterceptor()

Method Detail

instanceFor

public LinkContractInterceptor instanceFor(Prototype.PrototypingContext prototypingContext)

Specified by:

instanceFor in interface Prototype<LinkContractInterceptor>

before

public InterceptorResult before(Message message,
                                ExecutionContext executionContext,
                                ExecutionResult executionResult)
                         throws Xdi2MessagingException

Description copied from interface: MessageInterceptor

Run before a message is executed.

Specified by:

before in interface MessageInterceptor

Parameters:

message - The message to process.

executionContext - The current execution context.

executionResult - The execution result.

Returns:

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

Throws:

Xdi2MessagingException

after

public InterceptorResult after(Message message,
                               ExecutionContext executionContext,
                               ExecutionResult executionResult)
                        throws Xdi2MessagingException

Description copied from interface: MessageInterceptor

Run after a message is executed.

Specified by:

after in interface MessageInterceptor

Parameters:

message - The message to process.

executionContext - The current execution context.

executionResult - The execution result.

Returns:

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

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

targetAddress

public XDIAddress targetAddress(XDIAddress targetXDIAddress,
                                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:

targetXDIAddress - 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

targetStatement

public XDIStatement targetStatement(XDIStatement targetXDIStatement,
                                    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:

targetXDIStatement - 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

getLinkContractsGraph

public Graph getLinkContractsGraph(ExecutionContext executionContext)

getLinkContractsGraph

public Graph getLinkContractsGraph()

setLinkContractsGraph

public void setLinkContractsGraph(Graph linkContractsGraph)

getLinkContract

public static LinkContract getLinkContract(ExecutionContext executionContext)

putLinkContract

public static void putLinkContract(ExecutionContext executionContext,
                                   LinkContract linkContract)

getEvaluationResult

public static XDIAddress getEvaluationResult(ExecutionContext executionContext)

putEvaluationResult

public static void putEvaluationResult(ExecutionContext executionContext,
                                       XDIAddress evaluationResult)