xdi2.messaging.container.impl

Class AbstractMessagingContainer

java.lang.Object

xdi2.messaging.container.impl.AbstractMessagingContainer

All Implemented Interfaces:

MessagingContainer

Direct Known Subclasses:

EchoMessagingContainer, GraphMessagingContainer, NullMessagingContainer

public abstract class AbstractMessagingContainer
extends Object
implements MessagingContainer

The AbstractMessagingContainer 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
AbstractMessagingContainer()
AbstractMessagingContainer(XDIArc ownerPeerRootXDIArc)

Method Summary

Modifier and Type	Method and Description
void	addStandardExtensions()
protected void	after(MessageEnvelope messageEnvelope, ExecutionContext executionContext, ExecutionResult executionResult)
protected void	after(Message message, ExecutionContext executionContext, ExecutionResult executionResult)
protected void	after(Operation operation, Graph operationResultGraph, ExecutionContext executionContext)
protected boolean	before(MessageEnvelope messageEnvelope, ExecutionContext executionContext, ExecutionResult executionResult)
protected boolean	before(Message message, ExecutionContext executionContext, ExecutionResult executionResult)
protected boolean	before(Operation operation, Graph operationResultGraph, ExecutionContext executionContext)
protected void	exception(MessageEnvelope messageEnvelope, ExecutionContext executionContext, ExecutionResult executionResult, Xdi2MessagingException ex)
void	execute(MessageEnvelope messageEnvelope, ExecutionContext executionContext, ExecutionResult executionResult) Executes a messaging request against this messaging container.
void	execute(Message message, ExecutionContext executionContext, ExecutionResult executionResult) Executes a message by executing all its operations.
void	execute(Operation operation, ExecutionContext executionContext, ExecutionResult executionResult) Executes an operation.
void	execute(Operation operation, Graph operationResultGraph, ExecutionContext executionContext) Executes an operation.
void	execute(XDIAddress targetXDIAddress, Operation operation, Graph operationResultGraph, ExecutionContext executionContext) Executes a target address.
void	execute(XDIStatement targetXDIStatement, Operation operation, Graph operationResultGraph, ExecutionContext executionContext) Executes a target statement.
protected AddressHandler	getAddressHandler(XDIAddress targetAddress)
ContributorMap	getContributors()
InterceptorList<MessagingContainer>	getInterceptors()
XDIArc	getOwnerPeerRootXDIArc() Returns the owner peer root XDI arc of the messaging container.
XDIAddress	getOwnerXDIAddress() Returns the owner XDI address of the messaging container.
protected StatementHandler	getStatementHandler(XDIStatement targetStatement)
void	init() This method gets called when the messaging container is initialized.
void	setContributors(ContributorMap contributors)
void	setInterceptors(InterceptorList<MessagingContainer> interceptors)
void	setOwnerPeerRootXDIArc(XDIArc ownerPeerRootXDIArc)
void	setOwnerXDIAddress(XDIAddress ownerXDIAddress)
void	shutdown() This method gets called when the messaging container is no longer needed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractMessagingContainer

public AbstractMessagingContainer(XDIArc ownerPeerRootXDIArc)

AbstractMessagingContainer

public AbstractMessagingContainer()

Method Detail

init

public void init()
          throws Exception

Description copied from interface: MessagingContainer

This method gets called when the messaging container is initialized.

Specified by:

init in interface MessagingContainer

Throws:

Exception

shutdown

public void shutdown()
              throws Exception

Description copied from interface: MessagingContainer

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

Specified by:

shutdown in interface MessagingContainer

Throws:

Exception

execute

public void execute(MessageEnvelope messageEnvelope,
                    ExecutionContext executionContext,
                    ExecutionResult executionResult)
             throws Xdi2MessagingException

Executes a messaging request against this messaging container.

Specified by:

execute in interface MessagingContainer

Parameters:

messageEnvelope - The XDI message envelope to be executed.

executionContext - An "execution context" object that carries state between messaging containers, interceptors and contributors.

executionResult - The execution result produced by executing the messaging request.

Throws:

Xdi2MessagingException

execute

public void execute(Message message,
                    ExecutionContext executionContext,
                    ExecutionResult executionResult)
             throws Xdi2MessagingException

Executes a message by executing all its operations.

Parameters:

message - The XDI message containing XDI operations to be executed.

executionContext - An "execution context" object that carries state between messaging containers, interceptors and contributors.

executionResult - The execution result produced by executing the messaging request.

Throws:

Xdi2MessagingException

execute

public void execute(Operation operation,
                    ExecutionContext executionContext,
                    ExecutionResult executionResult)
             throws Xdi2MessagingException

Executes an operation.

Parameters:

operation - The XDI operation.

executionContext - An "execution context" object that carries state between messaging containers, interceptors and contributors.

executionResult - The execution result produced by executing the messaging request.

Throws:

Xdi2MessagingException

execute

public void execute(Operation operation,
                    Graph operationResultGraph,
                    ExecutionContext executionContext)
             throws Xdi2MessagingException

Executes an operation.

Parameters:

operation - The XDI operation.

operationResultGraph - The graph for result statements from this operation.

executionResult - The execution result produced by executing the messaging request.

Throws:

Xdi2MessagingException

execute

public void execute(XDIAddress targetXDIAddress,
                    Operation operation,
                    Graph operationResultGraph,
                    ExecutionContext executionContext)
             throws Xdi2MessagingException

Executes a target address.

Parameters:

targetXDIAddress - The target address.

operation - The XDI operation.

operationResultGraph - The operation's result graph.

executionContext - An "execution context" object that carries state between messaging containers, interceptors and contributors.

Throws:

Xdi2MessagingException

execute

public void execute(XDIStatement targetXDIStatement,
                    Operation operation,
                    Graph operationResultGraph,
                    ExecutionContext executionContext)
             throws Xdi2MessagingException

Executes a target statement.

Parameters:

targetXDIStatement - The target statement.

operation - The XDI operation.

operationResultGraph - The operation's result graph.

executionContext - An "execution context" object that carries state between messaging containers, interceptors and contributors.

Throws:

Xdi2MessagingException

addStandardExtensions

public void addStandardExtensions()

before

protected boolean before(MessageEnvelope messageEnvelope,
                         ExecutionContext executionContext,
                         ExecutionResult executionResult)
                  throws Xdi2MessagingException

Throws:

Xdi2MessagingException

before

protected boolean before(Message message,
                         ExecutionContext executionContext,
                         ExecutionResult executionResult)
                  throws Xdi2MessagingException

Throws:

Xdi2MessagingException

before

protected boolean before(Operation operation,
                         Graph operationResultGraph,
                         ExecutionContext executionContext)
                  throws Xdi2MessagingException

Throws:

Xdi2MessagingException

after

protected void after(MessageEnvelope messageEnvelope,
                     ExecutionContext executionContext,
                     ExecutionResult executionResult)
              throws Xdi2MessagingException

Throws:

Xdi2MessagingException

after

protected void after(Message message,
                     ExecutionContext executionContext,
                     ExecutionResult executionResult)
              throws Xdi2MessagingException

Throws:

Xdi2MessagingException

after

protected void after(Operation operation,
                     Graph operationResultGraph,
                     ExecutionContext executionContext)
              throws Xdi2MessagingException

Throws:

Xdi2MessagingException

exception

protected void exception(MessageEnvelope messageEnvelope,
                         ExecutionContext executionContext,
                         ExecutionResult executionResult,
                         Xdi2MessagingException ex)
                  throws Xdi2MessagingException

Throws:

Xdi2MessagingException

getAddressHandler

protected AddressHandler getAddressHandler(XDIAddress targetAddress)
                                    throws Xdi2MessagingException

Throws:

Xdi2MessagingException

getStatementHandler

protected StatementHandler getStatementHandler(XDIStatement targetStatement)
                                        throws Xdi2MessagingException

Throws:

Xdi2MessagingException

getOwnerPeerRootXDIArc

public XDIArc getOwnerPeerRootXDIArc()

Description copied from interface: MessagingContainer

Returns the owner peer root XDI arc of the messaging container. This may be null.

Specified by:

getOwnerPeerRootXDIArc in interface MessagingContainer

setOwnerPeerRootXDIArc

public void setOwnerPeerRootXDIArc(XDIArc ownerPeerRootXDIArc)

getOwnerXDIAddress

public XDIAddress getOwnerXDIAddress()

Description copied from interface: MessagingContainer

Returns the owner XDI address of the messaging container. This may be null.

Specified by:

getOwnerXDIAddress in interface MessagingContainer

setOwnerXDIAddress

public void setOwnerXDIAddress(XDIAddress ownerXDIAddress)

getInterceptors

public InterceptorList<MessagingContainer> getInterceptors()

setInterceptors

public void setInterceptors(InterceptorList<MessagingContainer> interceptors)

getContributors

public ContributorMap getContributors()

setContributors

public void setContributors(ContributorMap contributors)