com.ibm.broker.plugin

Class MbMessageAssembly

java.lang.Object

com.ibm.broker.plugin.MbMessageAssembly

public class MbMessageAssembly
extends java.lang.Object

MbMessageAssembly is the top level structure used to pass messages between nodes. As well as the message itself, it also contains the exception list and the local and global environments all represented by MbMessage objects.

Warning: caching MbMessageAssembly objects over multiple message flow invocations is unsupported because the internal state may be reset at the end of the current message invocation.

Constructor Summary

Constructors

Constructor and Description
MbMessageAssembly(MbMessageAssembly assembly, MbMessage message) Semi-copy constructor for MbMessageAssembly.
MbMessageAssembly(MbMessageAssembly assembly, MbMessage localEnvironment, MbMessage exceptionList, MbMessage message) Semi-copy constructor for MbMessageAssembly.
MbMessageAssembly(MbMessageAssembly assembly, MbMessage localEnvironment, MbMessage globalEnvironment, MbMessage exceptionList, MbMessage message) Deprecated. a new global environment should not be created. Use alternative constructor

Method Summary

Modifier and Type	Method and Description
MbMessage	getExceptionList() Gets the exception list associated with the assembly.
MbMessage	getGlobalEnvironment() Gets the global environment associated with the assembly.
MbMessage	getLocalEnvironment() Gets the local environment associated with the assembly.
MbMessage	getMessage() Gets the message associated with the assembly.
java.lang.String	toString() Returns a String representation of the MbMessage.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MbMessageAssembly

public MbMessageAssembly(MbMessageAssembly assembly,
                         MbMessage message)
                  throws MbException

Semi-copy constructor for MbMessageAssembly.

Parameters:

assembly - The MbMessageAssembly upon which the new assembly is based.

message - The new message object to add to the assembly.

Throws:

MbException

MbMessageAssembly

public MbMessageAssembly(MbMessageAssembly assembly,
                         MbMessage localEnvironment,
                         MbMessage globalEnvironment,
                         MbMessage exceptionList,
                         MbMessage message)
                  throws MbException

Deprecated. a new global environment should not be created. Use alternative constructor

Semi-copy constructor for MbMessageAssembly.

Parameters:

assembly - The MbMessageAssembly upon which the new assembly is based.

localEnvironment - The MbMessage representing the local environment.

globalEnvironment - The MbMessage representing the global environment.

exceptionList - The MbMessage representing the exception list.

message - The MbMessage representing the message.

Throws:

MbException

MbMessageAssembly

public MbMessageAssembly(MbMessageAssembly assembly,
                         MbMessage localEnvironment,
                         MbMessage exceptionList,
                         MbMessage message)
                  throws MbException

Semi-copy constructor for MbMessageAssembly.

Parameters:

assembly - The MbMessageAssembly upon which the new assembly is based.

localEnvironment - The MbMessage representing the local environment.

exceptionList - The MbMessage representing the exception list.

message - The MbMessage representing the message.

Throws:

MbException

Method Detail

getMessage

public MbMessage getMessage()
                     throws MbException

Gets the message associated with the assembly.

Returns:

An MbMessage representing the message data.

Throws:

MbException

getLocalEnvironment

public MbMessage getLocalEnvironment()
                              throws MbException

Gets the local environment associated with the assembly.

Returns:

An MbMessage representing the internal local environment.

Throws:

MbException

getGlobalEnvironment

public MbMessage getGlobalEnvironment()
                               throws MbException

Gets the global environment associated with the assembly.

Returns:

An MbMessage representing the internal global environment.

Throws:

MbException

getExceptionList

public MbMessage getExceptionList()
                           throws MbException

Gets the exception list associated with the assembly.

Returns:

An MbMessage representing the internal exception list.

Throws:

MbException

toString

public java.lang.String toString()

Returns a String representation of the MbMessage.

Overrides:

toString in class java.lang.Object

Returns:

String representing the message.