org.objectweb.jotm
Class TransactionSynchronizationRegistryImpl

java.lang.Object
  org.objectweb.jotm.TransactionSynchronizationRegistryImpl

All Implemented Interfaces:

Referenceable, TransactionSynchronizationRegistry

public class TransactionSynchronizationRegistryImpl
extends Object
implements Referenceable, TransactionSynchronizationRegistry

Constructor Summary

TransactionSynchronizationRegistryImpl()

Method Summary

static TransactionSynchronizationRegistryImpl	getInstance() Return an opaque object to represent the transaction bound to the current thread at the time this method is called.
Reference	getReference() Retrieves the Reference of this object.
Object	getResource(Object key) Get an object from the map of resources being managed for the current transaction.
boolean	getRollbackOnly() Get the rollbackOnly status of the transaction bound to the current thread.
Object	getTransactionKey()
int	getTransactionStatus() Returns the status of the transaction bound to the current thread.
void	putResource(Object key, Object value) Add an object to the map of resources being managed for the current transaction.
void	registerInterposedSynchronization(Synchronization sync) Register a Synchronization instance with special ordering semantics.
void	setRollbackOnly() Set the rollbackOnly status of the transaction bound to the current thread.

Methods inherited from class java.lang.Object

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

Constructor Detail

TransactionSynchronizationRegistryImpl

public TransactionSynchronizationRegistryImpl()

Method Detail

getInstance

public static TransactionSynchronizationRegistryImpl getInstance()

Return an opaque object to represent the transaction bound to the current thread at the time this method is called. The returned object overrides hashCode and equals methods to allow its use as the key in a java.util.HashMap for use by the caller. If there is no transaction currently active, null is returned.

The returned object will return the same hashCode and compare equal to all other objects returned by calling this method from any component executing in the same transaction context in the same application server.

The toString method returns a String that might be usable by a human reader to usefully understand the transaction context. The result of the toString method is otherwise not defined. Specifically, there is no forward or backward compatibility guarantee for the result returned by the toString method.

The object is not necessarily serializable, and is not useful outside the virtual machine from which it was obtained.

Returns:

the TSR

getTransactionKey

public Object getTransactionKey()

Specified by:

getTransactionKey in interface TransactionSynchronizationRegistry

Returns:

An object representing the current transaction, or null if no transaction is active.

putResource

public void putResource(Object key,
                        Object value)

Add an object to the map of resources being managed for the current transaction. The supplied key must be of a caller- defined class so as not to conflict with other users. The class of the key must guarantee that the hashCode and equals methods are suitable for keys in a map. The key and value are not examined or used by the implementation.

Specified by:

putResource in interface TransactionSynchronizationRegistry

Parameters:

key - The key for looking up the associated value object.

value - The value object to keep track of.

Throws:

IllegalStateException - Thrown if the current thread is not associated with a transaction.

getResource

public Object getResource(Object key)

Get an object from the map of resources being managed for the current transaction. The key must have been supplied earlier by a call to putResouce in the same transaction. If the key cannot be found in the current resource map, null is returned.

Specified by:

getResource in interface TransactionSynchronizationRegistry

Parameters:

key - The key for looking up the associated value object.

Returns:

The value object, or null if not found.

Throws:

IllegalStateException - Thrown if the current thread is not associated with a transaction.

registerInterposedSynchronization

public void registerInterposedSynchronization(Synchronization sync)
                                       throws IllegalStateException

Register a Synchronization instance with special ordering semantics. The beforeCompletion method on the registered Synchronization will be called after all user and system component beforeCompletion callbacks, but before the 2-phase commit process starts. This allows user and system components to flush state changes to the caching manager, during their SessionSynchronization callbacks, and allows managers to flush state changes to Connectors, during the callbacks registered with this method. Similarly, the afterCompletion callback will be called after 2-phase commit completes but before any user and system afterCompletion callbacks.

The beforeCompletion callback will be invoked in the transaction context of the current transaction bound to the thread of the caller of this method, which is the same transaction context active at the time this method is called. Allowable methods include access to resources, for example, Connectors. No access is allowed to user components, for example, timer services or bean methods, as these might change the state of POJOs, or plain old Java objects, being managed by the caching manager.

The afterCompletion callback will be invoked in an undefined transaction context. No access is permitted to resources or user components as defined above. Resources can be closed, but no transactional work can be performed with them.

Other than the transaction context, no component J2EE context is active during either of the callbacks.

Specified by:

registerInterposedSynchronization in interface TransactionSynchronizationRegistry

Parameters:

sync - The synchronization callback object.

Throws:

IllegalStateException - Thrown if the current thread is not associated with a transaction.

getTransactionStatus

public int getTransactionStatus()

Returns the status of the transaction bound to the current thread. This is the result of executing getStatus method on the TransactionManager, in the current transaction context.

Specified by:

getTransactionStatus in interface TransactionSynchronizationRegistry

Returns:

The status of the current transaction.

setRollbackOnly

public void setRollbackOnly()

Set the rollbackOnly status of the transaction bound to the current thread.

Specified by:

setRollbackOnly in interface TransactionSynchronizationRegistry

Throws:

IllegalStateException - Thrown if the current thread is not associated with a transaction.

getRollbackOnly

public boolean getRollbackOnly()

Get the rollbackOnly status of the transaction bound to the current thread.

Specified by:

getRollbackOnly in interface TransactionSynchronizationRegistry

Returns:

true, if the current transaction is marked for rollback only.

Throws:

IllegalStateException - Thrown if the current thread is not associated with a transaction.

getReference

public Reference getReference()
                       throws NamingException

Retrieves the Reference of this object.

Specified by:

getReference in interface Referenceable

Returns:

The non-null Reference of this object.

Throws:

NamingException - If a naming exception was encountered while retrieving the reference.