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

All Implemented Interfaces:

Cloneable, Extension<MessagingTarget>, Interceptor<MessagingTarget>, TargetInterceptor, Prototype<ReadOnlyInterceptor>
```
public class ReadOnlyInterceptor
extends AbstractInterceptor<MessagingTarget>
implements TargetInterceptor, Prototype<ReadOnlyInterceptor>
```
This interceptor throws an exception when $add, $mod or $del operations are attempted on given contexts of the target graph.

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

ReadOnlyInterceptor()

Constructors
Constructor and Description
`ReadOnlyInterceptor()`

Method Summary

Methods
Modifier and Type	Method and Description
`XDIAddress[]`	`getReadOnlyAddresses()`
`ReadOnlyInterceptor`	`instanceFor(Prototype.PrototypingContext prototypingContext)`
`void`	`setReadOnlyAddresses(String[] readOnlyAddresses)`
`void`	`setReadOnlyAddresses(XDIAddress[] readOnlyAddresses)`
`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
  - ReadOnlyInterceptor
```
public ReadOnlyInterceptor()
```
- Method Detail
  - instanceFor
```
public ReadOnlyInterceptor instanceFor(Prototype.PrototypingContext prototypingContext)
```
    Specified by:
    
    instanceFor in interface Prototype<ReadOnlyInterceptor>
  - 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
  - getReadOnlyAddresses
```
public XDIAddress[] getReadOnlyAddresses()
```
  - setReadOnlyAddresses
```
public void setReadOnlyAddresses(XDIAddress[] readOnlyAddresses)
```
  - setReadOnlyAddresses
```
public void setReadOnlyAddresses(String[] readOnlyAddresses)
```

Class ReadOnlyInterceptor

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

ReadOnlyInterceptor

Method Detail

instanceFor

targetStatement

targetAddress

getReadOnlyAddresses

setReadOnlyAddresses

setReadOnlyAddresses