xdi2.messaging.container.interceptor.impl

Class AbstractMessageEnvelopeInterceptor

java.lang.Object

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

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

xdi2.messaging.container.interceptor.impl.AbstractMessageEnvelopeInterceptor

All Implemented Interfaces:

Extension<MessagingContainer>, Interceptor<MessagingContainer>, MessageEnvelopeInterceptor

Direct Known Subclasses:

SkipLinkContractsInterceptor

public abstract class AbstractMessageEnvelopeInterceptor
extends AbstractInterceptor<MessagingContainer>
implements MessageEnvelopeInterceptor

Nested Class Summary

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

Extension.InitPriorityComparator, Extension.ShutdownPriorityComparator

Field Summary

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

DEFAULT_INIT_PRIORITY, DEFAULT_SHUTDOWN_PRIORITY

Constructor Summary

Constructors

Constructor and Description
AbstractMessageEnvelopeInterceptor()
AbstractMessageEnvelopeInterceptor(int initPriority, int shutdownPriority)

Method Summary

Modifier and Type	Method and Description
InterceptorResult	after(MessageEnvelope messageEnvelope, ExecutionContext executionContext, ExecutionResult executionResult) Run after a message envelope is executed.
InterceptorResult	before(MessageEnvelope messageEnvelope, ExecutionContext executionContext, ExecutionResult executionResult) Run before a message envelope is executed.
void	exception(MessageEnvelope messageEnvelope, ExecutionContext executionContext, ExecutionResult executionResult, Exception ex) Run if an exception occurs while a message envelope 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

AbstractMessageEnvelopeInterceptor

public AbstractMessageEnvelopeInterceptor(int initPriority,
                                          int shutdownPriority)

AbstractMessageEnvelopeInterceptor

public AbstractMessageEnvelopeInterceptor()

Method Detail

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.