VariablesInterceptor (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.impl.VariablesInterceptor

All Implemented Interfaces:

Cloneable, Extension<MessagingTarget>, Interceptor<MessagingTarget>, MessageEnvelopeInterceptor, MessageResultInterceptor, TargetInterceptor, Prototype<VariablesInterceptor>
```
public class VariablesInterceptor
extends AbstractInterceptor<MessagingTarget>
implements MessageEnvelopeInterceptor, TargetInterceptor, MessageResultInterceptor, Prototype<VariablesInterceptor>
```
This interceptor can replace XDI variables in a $add operation with automatically generated persistent addresses.

Author:

markus

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

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

Constructor Summary

Constructors
Constructor and Description

VariablesInterceptor()

Constructors
Constructor and Description
`VariablesInterceptor()`

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.
`void`	`finish(MessageResult messageResult, ExecutionContext executionContext)` Run on the message result after it is complete for final adjustments.
`VariablesInterceptor`	`instanceFor(Prototype.PrototypingContext prototypingContext)`
`XDIAddress`	`targetAddress(XDIAddress targetAddress, Operation operation, MessageResult messageResult, ExecutionContext executionContext)` Replaces or skips the target address before it is executed.
`XDIStatement`	`targetStatement(XDIStatement targetStatement, Operation operation, MessageResult messageResult, ExecutionContext executionContext)` Replaces or skips the target statement before it 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
  - VariablesInterceptor
```
public VariablesInterceptor()
```
- Method Detail
  - instanceFor
```
public VariablesInterceptor instanceFor(Prototype.PrototypingContext prototypingContext)
```
    Specified by:
    
    instanceFor in interface Prototype<VariablesInterceptor>
  - 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
  - targetStatement
```
public XDIStatement targetStatement(XDIStatement targetStatement,
                           Operation operation,
                           MessageResult messageResult,
                           ExecutionContext executionContext)
                             throws Xdi2MessagingException
```
    Description copied from interface: TargetInterceptor
    
    Replaces or skips the target statement before it is executed.
    
    Specified by:
    
    targetStatement in interface TargetInterceptor
    
    Parameters:
    targetStatement - The target statement.
    operation - The operation to process.
    messageResult - The message result.
    executionContext - The current execution context.
    
    Returns:
    The new target statement, or the original target statement, or null to skip.
    
    Throws:
    
    Xdi2MessagingException
  - targetAddress
```
public XDIAddress targetAddress(XDIAddress targetAddress,
                       Operation operation,
                       MessageResult messageResult,
                       ExecutionContext executionContext)
                         throws Xdi2MessagingException
```
    Description copied from interface: TargetInterceptor
    
    Replaces or skips the target address before it is executed.
    
    Specified by:
    
    targetAddress in interface TargetInterceptor
    
    Parameters:
    targetAddress - The target address.
    operation - The operation to process.
    messageResult - The message result.
    executionContext - The current execution context.
    
    Returns:
    The new target address, or the original target address, or null to skip.
    
    Throws:
    
    Xdi2MessagingException
  - finish
```
public void finish(MessageResult messageResult,
          ExecutionContext executionContext)
            throws Xdi2MessagingException
```
    Description copied from interface: MessageResultInterceptor
    
    Run on the message result after it is complete for final adjustments.
    
    Specified by:
    
    finish in interface MessageResultInterceptor
    
    Parameters:
    messageResult - The message result.
    executionContext - The current execution context.
    
    Throws:
    
    Xdi2MessagingException

Class VariablesInterceptor

Nested Class Summary

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

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

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

VariablesInterceptor

Method Detail

instanceFor

before

after

exception

targetStatement

targetAddress

finish