xdi2.messaging.container.interceptor

Interface MessageEnvelopeInterceptor

All Superinterfaces:

Extension<MessagingContainer>, Interceptor<MessagingContainer>

All Known Implementing Classes:

AbstractMessageEnvelopeInterceptor, DeferResultInterceptor, ExecuteCommandInterceptor, ManipulatingInterceptor, SkipLinkContractsInterceptor, VariablesInterceptor, WriteListenerInterceptor

public interface MessageEnvelopeInterceptor
extends Interceptor<MessagingContainer>

Interceptor that is executed before and after a message envelope is executed, as well as when an exception occurs while executing the message envelope.

Author:

markus

Nested Class Summary

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

Extension.InitPriorityComparator, Extension.ShutdownPriorityComparator

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 interface xdi2.messaging.container.Extension

clearDisabled, clearDisabledForMessage, clearDisabledForMessageEnvelope, clearDisabledForOperation, getInitPriority, getShutdownPriority, init, setDisabled, setDisabledForMessage, setDisabledForMessageEnvelope, setDisabledForOperation, shutdown, skip

Method Detail

before

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

Run before a message envelope is executed.

Parameters:

messageEnvelope - The message envelope to process.

executionResult - The executionResult.

executionContext - The current execution context.

Returns:

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

Throws:

Xdi2MessagingException

after

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

Run after a message envelope is executed.

Parameters:

messageEnvelope - The message envelope to process.

executionResult - The executionResult.

executionContext - The current execution context.

Returns:

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

Throws:

Xdi2MessagingException

exception

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

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

Parameters:

executionResult - The executionResult.

executionContext - The current execution context.

ex - The exception that occurred.