ToInterceptor (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.ToInterceptor

All Implemented Interfaces:

Cloneable, Extension<MessagingTarget>, Interceptor<MessagingTarget>, MessageInterceptor, Prototype<ToInterceptor>
```
public class ToInterceptor
extends AbstractInterceptor<MessagingTarget>
implements MessageInterceptor, Prototype<ToInterceptor>
```
This interceptor checks if the target peer root XRI of a message matches the owner peer root XRI of the messaging target.

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

ToInterceptor()

Constructors
Constructor and Description
`ToInterceptor()`

Method Summary

Methods
Modifier and Type	Method and Description
`InterceptorResult`	`after(Message message, MessageResult messageResult, ExecutionContext executionContext)` Run after a message is executed.
`InterceptorResult`	`before(Message message, MessageResult messageResult, ExecutionContext executionContext)` Run before a message is executed.
`XDIArc`	`getDefaultToPeerRootXDIArc()`
`ToInterceptor`	`instanceFor(Prototype.PrototypingContext prototypingContext)`
`void`	`setDefaultToPeerRootXDIArc(XDIArc defaultToPeerRootXDIArc)`

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
  - ToInterceptor
```
public ToInterceptor()
```
- Method Detail
  - instanceFor
```
public ToInterceptor instanceFor(Prototype.PrototypingContext prototypingContext)
```
    Specified by:
    
    instanceFor in interface Prototype<ToInterceptor>
  - before
```
public InterceptorResult before(Message message,
                       MessageResult messageResult,
                       ExecutionContext executionContext)
                         throws Xdi2MessagingException
```
    Description copied from interface: MessageInterceptor
    
    Run before a message is executed.
    
    Specified by:
    
    before in interface MessageInterceptor
    
    Parameters:
    message - The message to process.
    messageResult - The message result.
    executionContext - The current execution context.
    
    Returns:
    True, if the message has been fully handled and the server should stop processing it.
    
    Throws:
    
    Xdi2MessagingException
  - after
```
public InterceptorResult after(Message message,
                      MessageResult messageResult,
                      ExecutionContext executionContext)
                        throws Xdi2MessagingException
```
    Description copied from interface: MessageInterceptor
    
    Run after a message is executed.
    
    Specified by:
    
    after in interface MessageInterceptor
    
    Parameters:
    message - The message to process.
    messageResult - The message result.
    executionContext - The current execution context.
    
    Returns:
    True, if the message has been fully handled and the server should stop processing it.
    
    Throws:
    
    Xdi2MessagingException
  - getDefaultToPeerRootXDIArc
```
public XDIArc getDefaultToPeerRootXDIArc()
```
  - setDefaultToPeerRootXDIArc
```
public void setDefaultToPeerRootXDIArc(XDIArc defaultToPeerRootXDIArc)
```

Class ToInterceptor

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

ToInterceptor

Method Detail

instanceFor

before

after

getDefaultToPeerRootXDIArc

setDefaultToPeerRootXDIArc