AbstractMessageEnvelopeInterceptor (xdi2-messaging 0.7.2 API)

java.lang.Object
- xdi2.messaging.target.impl.AbstractExtension<CONTAINER>
- - xdi2.messaging.target.interceptor.AbstractInterceptor<MessagingTarget>
  - - xdi2.messaging.target.interceptor.AbstractMessageEnvelopeInterceptor

All Implemented Interfaces:: Extension<MessagingTarget>, Interceptor<MessagingTarget>, MessageEnvelopeInterceptor

public abstract class AbstractMessageEnvelopeInterceptor
extends AbstractInterceptor<MessagingTarget>
implements MessageEnvelopeInterceptor

Nested Class Summary
- Nested classes/interfaces inherited from interface xdi2.messaging.target.Extension
  Extension.InitPriorityComparator, Extension.ShutdownPriorityComparator

Field Summary
- Fields inherited from class xdi2.messaging.target.impl.AbstractExtension
  DEFAULT_INIT_PRIORITY, DEFAULT_SHUTDOWN_PRIORITY

Constructor Summary

Constructors
Constructor and Description

AbstractMessageEnvelopeInterceptor()

Constructors
Constructor and Description
`AbstractMessageEnvelopeInterceptor()`

Method Summary

Methods
Modifier and Type	Method and Description
`InterceptorResult`	`after(MessageEnvelope messageEnvelope, MessageResult messageResult, ExecutionContext executionContext)` Run after a message envelope is executed.
`InterceptorResult`	`before(MessageEnvelope messageEnvelope, MessageResult messageResult, ExecutionContext executionContext)` Run before a message envelope is executed.
`void`	`exception(MessageEnvelope messageEnvelope, MessageResult messageResult, ExecutionContext executionContext, Exception ex)` Run if an exception occurs while a message envelope is executed.

Methods inherited from class xdi2.messaging.target.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.target.Extension
clearDisabled, clearDisabledForMessage, clearDisabledForMessageEnvelope, clearDisabledForOperation, getInitPriority, getShutdownPriority, init, setDisabled, setDisabledForMessage, setDisabledForMessageEnvelope, setDisabledForOperation, shutdown, skip

- Constructor Detail
  - AbstractMessageEnvelopeInterceptor
```
public AbstractMessageEnvelopeInterceptor()
```
- Method Detail
  - before
```
public InterceptorResult before(MessageEnvelope messageEnvelope,
                       MessageResult messageResult,
                       ExecutionContext executionContext)
                         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.
    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
```
public InterceptorResult after(MessageEnvelope messageEnvelope,
                      MessageResult messageResult,
                      ExecutionContext executionContext)
                        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.
    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
```
public void exception(MessageEnvelope messageEnvelope,
             MessageResult messageResult,
             ExecutionContext executionContext,
             Exception ex)
```
    Description copied from interface: MessageEnvelopeInterceptor
    
    Run if an exception occurs while a message envelope is executed.
    
    Specified by:
    
    exception in interface MessageEnvelopeInterceptor

Class AbstractMessageEnvelopeInterceptor

Nested Class Summary

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

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class xdi2.messaging.target.impl.AbstractExtension

Methods inherited from class java.lang.Object

Methods inherited from interface xdi2.messaging.target.Extension

Constructor Detail

AbstractMessageEnvelopeInterceptor

Method Detail

before

after

exception