xdi2.messaging.container

Interface MessagingContainer

All Known Implementing Classes:

AbstractMessagingContainer, EchoMessagingContainer, FileMessagingContainer, GraphMessagingContainer, NullMessagingContainer

public interface MessagingContainer

A MessagingContainer can process XDI messages and produce a result graph.

Author:

markus

Method Summary

Modifier and Type	Method and Description
void	execute(MessageEnvelope messageEnvelope, ExecutionContext executionContext, ExecutionResult executionResult) Executes a messaging request against this messaging container.
XDIArc	getOwnerPeerRootXDIArc() Returns the owner peer root XDI arc of the messaging container.
XDIAddress	getOwnerXDIAddress() Returns the owner XDI address of the messaging container.
void	init() This method gets called when the messaging container is initialized.
void	shutdown() This method gets called when the messaging container is no longer needed.

Method Detail

init

void init()
   throws Exception

This method gets called when the messaging container is initialized.

Throws:

Exception

shutdown

void shutdown()
       throws Exception

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

Throws:

Exception

execute

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

Executes a messaging request against this messaging container.

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

getOwnerPeerRootXDIArc

XDIArc getOwnerPeerRootXDIArc()

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

getOwnerXDIAddress

XDIAddress getOwnerXDIAddress()

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