LinkContractInterceptor (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.linkcontract.LinkContractInterceptor

All Implemented Interfaces:

Cloneable, Extension<MessagingTarget>, Interceptor<MessagingTarget>, MessageInterceptor, TargetInterceptor, Prototype<LinkContractInterceptor>
```
public class LinkContractInterceptor
extends AbstractInterceptor<MessagingTarget>
implements MessageInterceptor, TargetInterceptor, Prototype<LinkContractInterceptor>
```
This interceptor enforces link contracts while a message is executed.

Author:

animesh

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

LinkContractInterceptor()

LinkContractInterceptor(Graph linkContractsGraph)

Constructors
Constructor and Description
`LinkContractInterceptor()`
`LinkContractInterceptor(Graph linkContractsGraph)`

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.
`XDIAddress`	`getDefaultLinkContractAddress()`
`static LinkContract`	`getLinkContract(ExecutionContext executionContext)`
`Graph`	`getLinkContractsGraph()`
`void`	`init(MessagingTarget messagingTarget)`
`LinkContractInterceptor`	`instanceFor(Prototype.PrototypingContext prototypingContext)`
`static void`	`putLinkContract(ExecutionContext executionContext, LinkContract linkContract)`
`void`	`setDefaultLinkContractAddress(XDIAddress defaultLinkContractAddress)`
`void`	`setLinkContractsGraph(Graph linkContractsGraph)`
`XDIAddress`	`targetAddress(XDIAddress targetXDIAddress, Operation operation, MessageResult messageResult, ExecutionContext executionContext)` Replaces or skips the target address before it is executed.
`XDIStatement`	`targetStatement(XDIStatement targetXDIStatement, 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, 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, setDisabled, setDisabledForMessage, setDisabledForMessageEnvelope, setDisabledForOperation, shutdown, skip

- Constructor Detail
  - LinkContractInterceptor
```
public LinkContractInterceptor(Graph linkContractsGraph)
```
  - LinkContractInterceptor
```
public LinkContractInterceptor()
```
- Method Detail
  - instanceFor
```
public LinkContractInterceptor instanceFor(Prototype.PrototypingContext prototypingContext)
```
    Specified by:
    
    instanceFor in interface Prototype<LinkContractInterceptor>
  - init
```
public void init(MessagingTarget messagingTarget)
          throws Exception
```
    Specified by:
    
    init in interface Extension<MessagingTarget>
    
    Overrides:
    
    init in class AbstractExtension<MessagingTarget>
    
    Throws:
    
    Exception
  - 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
  - targetAddress
```
public XDIAddress targetAddress(XDIAddress targetXDIAddress,
                       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:
    targetXDIAddress - 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
  - targetStatement
```
public XDIStatement targetStatement(XDIStatement targetXDIStatement,
                           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:
    targetXDIStatement - 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
  - getLinkContractsGraph
```
public Graph getLinkContractsGraph()
```
  - setLinkContractsGraph
```
public void setLinkContractsGraph(Graph linkContractsGraph)
```
  - getDefaultLinkContractAddress
```
public XDIAddress getDefaultLinkContractAddress()
```
  - setDefaultLinkContractAddress
```
public void setDefaultLinkContractAddress(XDIAddress defaultLinkContractAddress)
```
  - getLinkContract
```
public static LinkContract getLinkContract(ExecutionContext executionContext)
```
  - putLinkContract
```
public static void putLinkContract(ExecutionContext executionContext,
                   LinkContract linkContract)
```

Class LinkContractInterceptor

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

LinkContractInterceptor

LinkContractInterceptor

Method Detail

instanceFor

init

before

after

targetAddress

targetStatement

getLinkContractsGraph

setLinkContractsGraph

getDefaultLinkContractAddress

setDefaultLinkContractAddress

getLinkContract

putLinkContract