xdi2.messaging.container.interceptor

Interface MessageInterceptor

All Superinterfaces:

Extension<MessagingContainer>, Interceptor<MessagingContainer>

All Known Implementing Classes:

AbstractMessageInterceptor, DigestInterceptor, ExecuteCommandInterceptor, FromInterceptor, HttpTransportDataInterceptor, LinkContractInterceptor, ManipulatingInterceptor, MessagePolicyInterceptor, RedirectInterceptor, RefInterceptor, SecretTokenInterceptor, SignatureInterceptor, ToInterceptor

public interface MessageInterceptor
extends Interceptor<MessagingContainer>

Interceptor that is executed before and after a message is executed.

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(Message message, ExecutionContext executionContext, ExecutionResult executionResult) Run after a message is executed.
InterceptorResult	before(Message message, ExecutionContext executionContext, ExecutionResult executionResult) Run before a message 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(Message message,
                         ExecutionContext executionContext,
                         ExecutionResult executionResult)
                  throws Xdi2MessagingException

Run before a message is executed.

Parameters:

message - The message to process.

executionResult - The execution result.

executionContext - The current execution context.

Returns:

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

Throws:

Xdi2MessagingException

after

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

Run after a message is executed.

Parameters:

message - The message to process.

executionResult - The execution result.

executionContext - The current execution context.

Returns:

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

Throws:

Xdi2MessagingException