org.infinispan.commons.tx

Class TransactionManagerImpl

java.lang.Object

org.infinispan.commons.tx.TransactionManagerImpl

All Implemented Interfaces:

TransactionManager

Direct Known Subclasses:

EmbeddedBaseTransactionManager, RemoteTransactionManager

public abstract class TransactionManagerImpl
extends Object
implements TransactionManager

A simple TransactionManager implementation.

It provides the basic to handle Transactions and supports any XAResource.

Implementation notes:

• The state is kept in memory only.
• Does not support recover.
• Does not support multi-thread transactions. Although it is possible to execute the transactions in multiple threads, this transaction manager does not wait for them to complete. It is the application responsibility to wait before invoking commit() or rollback()
• The transaction should not block. It is no possible to setTransactionTimeout(int) and this transaction manager won't rollback the transaction if it takes too long.

If you need any of the requirements above, please consider use another implementation.

Also, it does not implement any 1-phase-commit optimization.

Since:

9.1

Author:

Bela Ban, Pedro Ruivo

Field Summary

Fields

Modifier and Type	Field and Description
protected UUID	transactionManagerId

Constructor Summary

Constructors

Constructor and Description
TransactionManagerImpl()

Method Summary

Modifier and Type	Method and Description
void	begin() Create a new transaction and associate it with the current thread.
void	commit() Complete the transaction associated with the current thread.
protected abstract Transaction	createTransaction()
static void	dissociateTransaction()
int	getStatus() Obtain the status of the transaction associated with the current thread.
Transaction	getTransaction() Get the transaction object that represents the transaction context of the calling thread.
void	resume(Transaction tx) Resume the transaction context association of the calling thread with the transaction represented by the supplied Transaction object.
void	rollback() Roll back the transaction associated with the current thread.
void	setRollbackOnly() Modify the transaction associated with the current thread such that the only possible outcome of the transaction is to roll back the transaction.
void	setTransactionTimeout(int seconds) Modify the timeout value that is associated with transactions started by the current thread with the begin method.
Transaction	suspend() Suspend the transaction currently associated with the calling thread and return a Transaction object that represents the transaction context being suspended.

Methods inherited from class java.lang.Object

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

Field Detail

transactionManagerId

protected final UUID transactionManagerId

Constructor Detail

TransactionManagerImpl

public TransactionManagerImpl()

Method Detail

dissociateTransaction

public static void dissociateTransaction()

getTransaction

public Transaction getTransaction()

Description copied from interface: TransactionManager

Get the transaction object that represents the transaction context of the calling thread.

Specified by:

getTransaction in interface TransactionManager

Returns:

the Transaction object representing the transaction associated with the calling thread.

begin

public void begin()
           throws NotSupportedException,
                  SystemException

Description copied from interface: TransactionManager

Create a new transaction and associate it with the current thread.

Specified by:

begin in interface TransactionManager

Throws:

NotSupportedException - Thrown if the thread is already associated with a transaction and the Transaction Manager implementation does not support nested transactions.

SystemException - Thrown if the transaction manager encounters an unexpected error condition.

commit

public void commit()
            throws RollbackException,
                   HeuristicMixedException,
                   HeuristicRollbackException,
                   SecurityException,
                   IllegalStateException,
                   SystemException

Description copied from interface: TransactionManager

Complete the transaction associated with the current thread. When this method completes, the thread is no longer associated with a transaction.

Specified by:

commit in interface TransactionManager

Throws:

RollbackException - Thrown to indicate that the transaction has been rolled back rather than committed.

HeuristicMixedException - Thrown to indicate that a heuristic decision was made and that some relevant updates have been committed while others have been rolled back.

HeuristicRollbackException - Thrown to indicate that a heuristic decision was made and that all relevant updates have been rolled back.

SecurityException - Thrown to indicate that the thread is not allowed to commit the transaction.

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

SystemException - Thrown if the transaction manager encounters an unexpected error condition.

rollback

public void rollback()
              throws IllegalStateException,
                     SecurityException,
                     SystemException

Description copied from interface: TransactionManager

Roll back the transaction associated with the current thread. When this method completes, the thread is no longer associated with a transaction.

Specified by:

rollback in interface TransactionManager

Throws:

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

SecurityException - Thrown to indicate that the thread is not allowed to roll back the transaction.

SystemException - Thrown if the transaction manager encounters an unexpected error condition.

setRollbackOnly

public void setRollbackOnly()
                     throws IllegalStateException,
                            SystemException

Description copied from interface: TransactionManager

Modify the transaction associated with the current thread such that the only possible outcome of the transaction is to roll back the transaction.

Specified by:

setRollbackOnly in interface TransactionManager

Throws:

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

SystemException - Thrown if the transaction manager encounters an unexpected error condition.

getStatus

public int getStatus()
              throws SystemException

Description copied from interface: TransactionManager

Obtain the status of the transaction associated with the current thread.

Specified by:

getStatus in interface TransactionManager

Returns:

The transaction status. If no transaction is associated with the current thread, this method returns the Status.NoTransaction value.

Throws:

SystemException - Thrown if the transaction manager encounters an unexpected error condition.

setTransactionTimeout

public void setTransactionTimeout(int seconds)
                           throws SystemException

Description copied from interface: TransactionManager

Modify the timeout value that is associated with transactions started by the current thread with the begin method.

If an application has not called this method, the transaction service uses some default value for the transaction timeout.

Specified by:

setTransactionTimeout in interface TransactionManager

Parameters:

seconds - The value of the timeout in seconds. If the value is zero, the transaction service restores the default value. If the value is negative a SystemException is thrown.

Throws:

SystemException - Thrown if the transaction manager encounters an unexpected error condition.

suspend

public Transaction suspend()
                    throws SystemException

Description copied from interface: TransactionManager

Suspend the transaction currently associated with the calling thread and return a Transaction object that represents the transaction context being suspended. If the calling thread is not associated with a transaction, the method returns a null object reference. When this method returns, the calling thread is not associated with a transaction.

Specified by:

suspend in interface TransactionManager

Returns:

Transaction object representing the suspended transaction.

Throws:

SystemException - Thrown if the transaction manager encounters an unexpected error condition.

resume

public void resume(Transaction tx)
            throws InvalidTransactionException,
                   IllegalStateException,
                   SystemException

Description copied from interface: TransactionManager

Resume the transaction context association of the calling thread with the transaction represented by the supplied Transaction object. When this method returns, the calling thread is associated with the transaction context specified.

Specified by:

resume in interface TransactionManager

Parameters:

tx - The Transaction object that represents the transaction to be resumed.

Throws:

InvalidTransactionException - Thrown if the parameter transaction object contains an invalid transaction.

IllegalStateException - Thrown if the thread is already associated with another transaction.

SystemException - Thrown if the transaction manager encounters an unexpected error condition.

createTransaction

protected abstract Transaction createTransaction()