-
- All Superinterfaces:
- Extension<MessagingTarget>, Interceptor<MessagingTarget>
- All Known Implementing Classes:
- AbstractMessageEnvelopeInterceptor, ExecuteCommandInterceptor, RefInterceptor, VariablesInterceptor, WriteListenerInterceptor
public interface MessageEnvelopeInterceptor extends Interceptor<MessagingTarget>
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.target.Extension
Extension.InitPriorityComparator, Extension.ShutdownPriorityComparator
-
-
Method Summary
Methods Modifier and Type Method and Description InterceptorResultafter(MessageEnvelope messageEnvelope, MessageResult messageResult, ExecutionContext executionContext)Run after a message envelope is executed.InterceptorResultbefore(MessageEnvelope messageEnvelope, MessageResult messageResult, ExecutionContext executionContext)Run before a message envelope is executed.voidexception(MessageEnvelope messageEnvelope, MessageResult messageResult, ExecutionContext executionContext, Exception ex)Run if an exception occurs while a message envelope is executed.-
Methods inherited from interface xdi2.messaging.target.Extension
clearDisabled, clearDisabledForMessage, clearDisabledForMessageEnvelope, clearDisabledForOperation, getInitPriority, getShutdownPriority, init, setDisabled, setDisabledForMessage, setDisabledForMessageEnvelope, setDisabledForOperation, shutdown, skip
-
-
-
-
Method Detail
-
before
InterceptorResult before(MessageEnvelope messageEnvelope, MessageResult messageResult, ExecutionContext executionContext) throws Xdi2MessagingException
Run before a message envelope is executed.- Parameters:
messageEnvelope- The message envelope to process.messageResult- The message result.executionContext- The current execution context.- Returns:
- True, if the message envelope has been fully handled and the server should stop processing it.
- Throws:
Xdi2MessagingException
-
after
InterceptorResult after(MessageEnvelope messageEnvelope, MessageResult messageResult, ExecutionContext executionContext) throws Xdi2MessagingException
Run after a message envelope is executed.- Parameters:
messageEnvelope- The message envelope to process.messageResult- The message result.executionContext- The current execution context.- Returns:
- True, if the message envelope has been fully handled and the server should stop processing it.
- Throws:
Xdi2MessagingException
-
exception
void exception(MessageEnvelope messageEnvelope, MessageResult messageResult, ExecutionContext executionContext, Exception ex)
Run if an exception occurs while a message envelope is executed.
-
-