com.soa.message

Interface TransactedExchange

public interface TransactedExchange

Holds information about a message exchange in a transaction. A transaction may consist of multiple exchanges executed in sequence. Each exchange may also spawn multiple exchanges of it's own, creating a hierarchy of exchanges in one transaction.

Method Summary

Modifier and Type	Method and Description
TransactedExchange	addChildExchange(java.lang.String exchangeId) Adds a message exchange to this exchange as a child.
void	addChildExchange(TransactedExchange transactedExchange) Adds a message exchange to this exchange as a child.
java.util.List<TransactedExchange>	getChildExchanges() Returns the list of child exchanges.
java.lang.String	getExchangeId() Returns the message exchange ID.
TransactedExchange	getParentExchange() Returns the parent, or originating, exchange (if any).
java.util.Map	getProperties() Provides direct access to the Map of properties for the exchange.
java.lang.Object	getProperty(java.lang.String name) Returns the property with the given name.
java.util.Set	getPropertyNames() Returns the names of the properties associated with the exchange.
boolean	isTransactionTrackingEnabled() Returns whether or not transaction tracking is enabled.
void	setIsTransactionTrackingEnabled(boolean isTransactionTrackingEnabled) Changes whether or not transaction tracking is enabled.
void	setProperty(java.lang.String name, java.lang.Object property) Adds or replaces a property.

Method Detail

getExchangeId

java.lang.String getExchangeId()

Returns the message exchange ID.

Returns:

Exchange ID.

getParentExchange

TransactedExchange getParentExchange()

Returns the parent, or originating, exchange (if any).

Returns:

Parent TransactedExchange.

addChildExchange

TransactedExchange addChildExchange(java.lang.String exchangeId)

Adds a message exchange to this exchange as a child.

Parameters:

exchangeId - ID of the message exchange.

Returns:

TransactedExchange instance that can be used to further describe the child exchange.

addChildExchange

void addChildExchange(TransactedExchange transactedExchange)

Adds a message exchange to this exchange as a child.

Parameters:

transactedExchange - TransactedExchange representing the child exchange.

getChildExchanges

java.util.List<TransactedExchange> getChildExchanges()

Returns the list of child exchanges.

Returns:

List of TransactedExchanges. The list is not mutable.

isTransactionTrackingEnabled

boolean isTransactionTrackingEnabled()

Returns whether or not transaction tracking is enabled.

Returns:

true if enabled, false if not.

setIsTransactionTrackingEnabled

void setIsTransactionTrackingEnabled(boolean isTransactionTrackingEnabled)

Changes whether or not transaction tracking is enabled.

Parameters:

isTransactionTrackingEnabled - true to enable, false to not.

getProperty

java.lang.Object getProperty(java.lang.String name)

Returns the property with the given name.

Parameters:

name - Name of the property.

Returns:

Object holding the value of the requested property, null if none found.

setProperty

void setProperty(java.lang.String name,
                 java.lang.Object property)

Adds or replaces a property.

Parameters:

name - Name of the property.

property - Value of the property.

getPropertyNames

java.util.Set getPropertyNames()

Returns the names of the properties associated with the exchange. Changes made to the Set are reflected in the exchange, so if a name is removed from the Set, the property is removed from the exchange. Names cannot be added however.

Returns:

Set of String property names.

getProperties

java.util.Map getProperties()

Provides direct access to the Map of properties for the exchange.

Returns:

Map of properties keyed by Strings.