xdi2.messaging.container.interceptor.impl

Class ManipulatingInterceptor

java.lang.Object

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

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

xdi2.messaging.container.interceptor.impl.ManipulatingInterceptor

All Implemented Interfaces:

Cloneable, Extension<MessagingContainer>, Interceptor<MessagingContainer>, MessageEnvelopeInterceptor, MessageInterceptor, Prototype<ManipulatingInterceptor>

public class ManipulatingInterceptor
extends AbstractInterceptor<MessagingContainer>
implements MessageEnvelopeInterceptor, MessageInterceptor, Prototype<ManipulatingInterceptor>

This uses a list of manipulators that can manipulate an incoming message envelope or message.

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
ManipulatingInterceptor()

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(Message message, ExecutionContext executionContext, ExecutionResult executionResult) Run after a message is executed.
InterceptorResult	before(MessageEnvelope messageEnvelope, ExecutionContext executionContext, ExecutionResult executionResult) Run before a message envelope is executed.
InterceptorResult	before(Message message, ExecutionContext executionContext, ExecutionResult executionResult) Run before a message is executed.
ManipulationContext	createManipulationContext(ExecutionContext executionContext)
void	exception(MessageEnvelope messageEnvelope, ExecutionContext executionContext, ExecutionResult executionResult, Exception ex) Run if an exception occurs while a message envelope is executed.
static ExecutionContext	getExecutionContext(ManipulationContext manipulationContext)
static ManipulatingInterceptor	getManipulatingInterceptor(ManipulationContext manipulationContext)
static ManipulationContext	getManipulationContext(ExecutionContext executionContext)
ManipulatorList	getManipulators()
ManipulatingInterceptor	instanceFor(Prototype.PrototypingContext prototypingContext)
static void	putExecutionContext(ManipulationContext manipulationContext, ExecutionContext executionContext)
static void	putManipulatingInterceptor(ManipulationContext manipulationContext, ManipulatingInterceptor manipulatingInterceptor)
static void	putManipulationContext(ExecutionContext executionContext, ManipulationContext manipulationContext)
void	setManipulators(ManipulatorList manipulators)

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

ManipulatingInterceptor

public ManipulatingInterceptor()

Method Detail

instanceFor

public ManipulatingInterceptor instanceFor(Prototype.PrototypingContext prototypingContext)

Specified by:

instanceFor in interface Prototype<ManipulatingInterceptor>

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

createManipulationContext

public ManipulationContext createManipulationContext(ExecutionContext executionContext)

getManipulators

public ManipulatorList getManipulators()

setManipulators

public void setManipulators(ManipulatorList manipulators)

getManipulationContext

public static ManipulationContext getManipulationContext(ExecutionContext executionContext)

putManipulationContext

public static void putManipulationContext(ExecutionContext executionContext,
                                          ManipulationContext manipulationContext)

getManipulatingInterceptor

public static ManipulatingInterceptor getManipulatingInterceptor(ManipulationContext manipulationContext)

putManipulatingInterceptor

public static void putManipulatingInterceptor(ManipulationContext manipulationContext,
                                              ManipulatingInterceptor manipulatingInterceptor)

getExecutionContext

public static ExecutionContext getExecutionContext(ManipulationContext manipulationContext)

putExecutionContext

public static void putExecutionContext(ManipulationContext manipulationContext,
                                       ExecutionContext executionContext)