AbstractMessagingTarget (xdi2-messaging 0.7.2 API)

java.lang.Object
- xdi2.messaging.target.impl.AbstractMessagingTarget

All Implemented Interfaces:

MessagingTarget

Direct Known Subclasses:

EchoMessagingTarget, GraphMessagingTarget, NullMessagingTarget
```
public abstract class AbstractMessagingTarget
extends Object
implements MessagingTarget
```
The AbstractMessagingTarget provides the following functionality: - Implementation of execute() with a message envelope (all messages in the envelope and all operations in the messages will be executed). - Implementation of execute() with a message (all operations in the messages will be executed). - Support for interceptors and contributors. - Maintaining an "execution context" object where state can be kept between individual phases. Subclasses must do the following: - Implement execute() with an operation.

Author:

markus

Constructor Summary

Constructors
Constructor and Description

AbstractMessagingTarget()

AbstractMessagingTarget(XDIArc ownerPeerRootXDIArc)

Constructors
Constructor and Description
`AbstractMessagingTarget()`
`AbstractMessagingTarget(XDIArc ownerPeerRootXDIArc)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`after(MessageEnvelope messageEnvelope, MessageResult messageResult, ExecutionContext executionContext)`
`void`	`after(Message message, MessageResult messageResult, ExecutionContext executionContext)`
`void`	`after(Operation operation, MessageResult operationMessageResult, ExecutionContext executionContext)`
`void`	`before(MessageEnvelope messageEnvelope, MessageResult messageResult, ExecutionContext executionContext)`
`void`	`before(Message message, MessageResult messageResult, ExecutionContext executionContext)`
`void`	`before(Operation operation, MessageResult operationMessageResult, ExecutionContext executionContext)`
`void`	`exception(MessageEnvelope messageEnvelope, MessageResult messageResult, ExecutionContext executionContext, Xdi2MessagingException ex)`
`void`	`execute(MessageEnvelope messageEnvelope, MessageResult messageResult, ExecutionContext executionContext)` Executes a message envelope by executing all its messages.
`void`	`execute(Message message, MessageResult messageResult, ExecutionContext executionContext)` Executes a message by executing all its operations.
`void`	`execute(Operation operation, MessageResult operationMessageResult, ExecutionContext executionContext)` Executes an operation.
`void`	`execute(XDIAddress targetAddress, Operation operation, MessageResult operationMessageResult, ExecutionContext executionContext)` Executes a target address.
`void`	`execute(XDIStatement targetStatement, Operation operation, MessageResult operationMessageResult, ExecutionContext executionContext)` Executes a target statement.
`AddressHandler`	`getAddressHandler(XDIAddress targetAddress)`
`ContributorMap`	`getContributors()`
`InterceptorList<MessagingTarget>`	`getInterceptors()`
`XDIArc`	`getOwnerPeerRootXDIArc()` Returns the owner peer root XRI of the messaging target.
`StatementHandler`	`getStatementHandler(XDIStatement targetStatement)`
`void`	`init()` This method gets called when the messaging target is initialized.
`void`	`setContributors(ContributorMap contributors)`
`void`	`setInterceptors(InterceptorList<MessagingTarget> interceptors)`
`void`	`setOwnerPeerRootXDIArc(XDIArc ownerPeerRootXDIArc)`
`void`	`shutdown()` This method gets called when the messaging target is no longer needed.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractMessagingTarget

public AbstractMessagingTarget(XDIArc ownerPeerRootXDIArc)

AbstractMessagingTarget
```
public AbstractMessagingTarget()
```

Method Detail

init
```
public void init()
          throws Exception
```
Description copied from interface: MessagingTarget

This method gets called when the messaging target is initialized.

Specified by:

init in interface MessagingTarget

Throws:

Exception

shutdown
```
public void shutdown()
              throws Exception
```
Description copied from interface: MessagingTarget

This method gets called when the messaging target is no longer needed.

Specified by:

shutdown in interface MessagingTarget

Throws:

Exception

execute
```
public void execute(MessageEnvelope messageEnvelope,
           MessageResult messageResult,
           ExecutionContext executionContext)
             throws Xdi2MessagingException
```
Executes a message envelope by executing all its messages.

Specified by:

execute in interface MessagingTarget

Parameters:
messageEnvelope - The XDI message envelope containing XDI messages to be executed.
messageResult - The message result.
executionContext - An "execution context" object that carries state between messaging targets, interceptors and contributors.

Throws:

Xdi2MessagingException

execute
```
public void execute(Message message,
           MessageResult messageResult,
           ExecutionContext executionContext)
             throws Xdi2MessagingException
```
Executes a message by executing all its operations.

Parameters:
message - The XDI message containing XDI operations to be executed.
messageResult - The message result.
executionContext - An "execution context" object that carries state between messaging targets, interceptors and contributors.

Throws:

Xdi2MessagingException

execute
```
public void execute(Operation operation,
           MessageResult operationMessageResult,
           ExecutionContext executionContext)
             throws Xdi2MessagingException
```
Executes an operation.

Parameters:
operation - The XDI operation.
operationMessageResult - The operation's message result.
executionContext - An "execution context" object that carries state between messaging targets, interceptors and contributors.

Throws:

Xdi2MessagingException

execute
```
public void execute(XDIAddress targetAddress,
           Operation operation,
           MessageResult operationMessageResult,
           ExecutionContext executionContext)
             throws Xdi2MessagingException
```
Executes a target address.

Parameters:
targetAddress - The target address.
operation - The XDI operation.
operationMessageResult - The operation's message result.
executionContext - An "execution context" object that carries state between messaging targets, interceptors and contributors.

Throws:

Xdi2MessagingException

execute
```
public void execute(XDIStatement targetStatement,
           Operation operation,
           MessageResult operationMessageResult,
           ExecutionContext executionContext)
             throws Xdi2MessagingException
```
Executes a target statement.

Parameters:
targetStatement - The target statement.
operation - The XDI operation.
operationMessageResult - The operation's message result.
executionContext - An "execution context" object that carries state between messaging targets, interceptors and contributors.

Throws:

Xdi2MessagingException

before

public void before(MessageEnvelope messageEnvelope,
          MessageResult messageResult,
          ExecutionContext executionContext)
            throws Xdi2MessagingException

Throws:: Xdi2MessagingException

before

public void before(Message message,
          MessageResult messageResult,
          ExecutionContext executionContext)
            throws Xdi2MessagingException

Throws:: Xdi2MessagingException

before

public void before(Operation operation,
          MessageResult operationMessageResult,
          ExecutionContext executionContext)
            throws Xdi2MessagingException

Throws:: Xdi2MessagingException

after

public void after(MessageEnvelope messageEnvelope,
         MessageResult messageResult,
         ExecutionContext executionContext)
           throws Xdi2MessagingException

Throws:: Xdi2MessagingException

after

public void after(Message message,
         MessageResult messageResult,
         ExecutionContext executionContext)
           throws Xdi2MessagingException

Throws:: Xdi2MessagingException

after

public void after(Operation operation,
         MessageResult operationMessageResult,
         ExecutionContext executionContext)
           throws Xdi2MessagingException

Throws:: Xdi2MessagingException

exception

public void exception(MessageEnvelope messageEnvelope,
             MessageResult messageResult,
             ExecutionContext executionContext,
             Xdi2MessagingException ex)
               throws Xdi2MessagingException

Throws:: Xdi2MessagingException

getAddressHandler

public AddressHandler getAddressHandler(XDIAddress targetAddress)
                                 throws Xdi2MessagingException

Throws:: Xdi2MessagingException

getStatementHandler

public StatementHandler getStatementHandler(XDIStatement targetStatement)
                                     throws Xdi2MessagingException

Throws:: Xdi2MessagingException

getOwnerPeerRootXDIArc
```
public XDIArc getOwnerPeerRootXDIArc()
```
Description copied from interface: MessagingTarget

Returns the owner peer root XRI of the messaging target. This may be null.

Specified by:

getOwnerPeerRootXDIArc in interface MessagingTarget

setOwnerPeerRootXDIArc

public void setOwnerPeerRootXDIArc(XDIArc ownerPeerRootXDIArc)

getInterceptors

public InterceptorList<MessagingTarget> getInterceptors()

setInterceptors

public void setInterceptors(InterceptorList<MessagingTarget> interceptors)

getContributors

public ContributorMap getContributors()

setContributors

public void setContributors(ContributorMap contributors)

Class AbstractMessagingTarget

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractMessagingTarget

AbstractMessagingTarget

Method Detail

init

shutdown

execute

execute

execute

execute

execute

before

before

before

after

after

after

exception

getAddressHandler

getStatementHandler

getOwnerPeerRootXDIArc

setOwnerPeerRootXDIArc

getInterceptors

setInterceptors

getContributors

setContributors