com.soa.message

Interface MessageTransaction

All Superinterfaces:

java.lang.AutoCloseable

All Known Implementing Classes:

SimpleTransaction

public interface MessageTransaction
extends java.lang.AutoCloseable

Represents a transaction executed within the messaging system. A transaction may be implemented with more than one message exchange. Not all message exchanges are part of a transaction.

Method Summary

Modifier and Type	Method and Description
void	addClosable(java.lang.AutoCloseable closeable)
TransactedExchange	addExchange(java.lang.String exchangeId) Adds an exchange to the transaction.
TransactedExchange	getExchange(java.lang.String exchangeId) Returns the exchange in the transaction with the given ID (if present).
java.util.List	getExchanges() Returns an ordered list of exchange ID's that have been executed within the context of the transaction.
java.util.Map	getProperties() Provides direct access to the Map of properties for the transaction.
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 context.
java.lang.String	getTransactionID() Returns a unique identifier for a transaction.
void	setProperty(java.lang.String name, java.lang.Object property) Adds or replaces a property.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

getTransactionID

java.lang.String getTransactionID()

Returns a unique identifier for a transaction.

Returns:

Unique identifier of the transaction.

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 context. Changes made to the Set are reflected in the context, so if a name is removed from the Set, the property is removed from the context. 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 transaction.

Returns:

Map of properties keyed by Strings.

getExchanges

java.util.List getExchanges()

Returns an ordered list of exchange ID's that have been executed within the context of the transaction.

Returns:

addExchange

TransactedExchange addExchange(java.lang.String exchangeId)

Adds an exchange to the transaction.

Parameters:

exchangeId - ID of the exchange.

Returns:

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

getExchange

TransactedExchange getExchange(java.lang.String exchangeId)

Returns the exchange in the transaction with the given ID (if present).

Parameters:

exchangeId - ID of the exchange.

Returns:

TransactedExchange describing the exchange, null if not found.

addClosable

void addClosable(java.lang.AutoCloseable closeable)