org.wildfly.transaction.client

Class ContextTransactionManager

java.lang.Object

org.wildfly.transaction.client.ContextTransactionManager

All Implemented Interfaces:

TransactionManager

public final class ContextTransactionManager
extends Object
implements TransactionManager

The singleton, global transaction manager for the local instance.

Author:

David M. Lloyd

Method Summary

Modifier and Type	Method and Description
void	begin() Starts a new transaction, and associate it with the calling thread.
void	commit() Commit the transaction associated with the calling thread.
static int	getGlobalDefaultTransactionTimeout() Get the global default transaction timeout.
static ContextTransactionManager	getInstance() Get the transaction manager instance.
int	getStatus() Get the status of the transaction associated with the calling thread.
AbstractTransaction	getTransaction() Get the transaction associated with the calling thread.
int	getTransactionTimeout()
void	resume(Transaction transaction) Resume the association of the calling thread with the given transaction.
void	rollback() Rolls back the transaction associated with the calling thread.
static int	setGlobalDefaultTransactionTimeout(int newTimeout) Set the global default transaction timeout, returning the original value.
static int	setMaximumGlobalDefaultTransactionTimeout(int maximumTimeout) Set the maximum global default transaction timeout, returning the original value.
static int	setMinimumGlobalDefaultTransactionTimeout(int minimumTimeout) Set the minimum global default transaction timeout, returning the original value.
void	setRollbackOnly() Mark the transaction associated with the calling thread for rollback only.
void	setTransactionTimeout(int timeout) Change the transaction timeout for transactions started by the calling thread with the TransactionManager.begin() method.
AbstractTransaction	suspend() Suspend the association the calling thread has to a transaction, and return the suspended transaction.

Methods inherited from class java.lang.Object

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

Method Detail

begin

public void begin()
           throws NotSupportedException,
                  SystemException

Description copied from interface: TransactionManager

Starts a new transaction, and associate it with the calling thread.

Specified by:

begin in interface TransactionManager

Throws:

NotSupportedException - If the calling thread is already associated with a transaction, and nested transactions are not supported.

SystemException - If the transaction service fails in an unexpected way.

commit

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

Description copied from interface: TransactionManager

Commit the transaction associated with the calling thread.

Specified by:

commit in interface TransactionManager

Throws:

RollbackException - If the transaction was marked for rollback only, the transaction is rolled back and this exception is thrown.

HeuristicMixedException - If a heuristic decision was made and some some parts of the transaction have been committed while other parts have been rolled back.

HeuristicRollbackException - If a heuristic decision to roll back the transaction was made.

SecurityException - If the caller is not allowed to commit this transaction.

IllegalStateException - If the calling thread is not associated with a transaction.

SystemException - If the transaction service fails in an unexpected way.

rollback

public void rollback()
              throws IllegalStateException,
                     SecurityException,
                     SystemException

Description copied from interface: TransactionManager

Rolls back the transaction associated with the calling thread.

Specified by:

rollback in interface TransactionManager

Throws:

IllegalStateException - If the transaction is in a state where it cannot be rolled back. This could be because the calling thread is not associated with a transaction, or because it is in the prepared state.

SecurityException - If the caller is not allowed to roll back this transaction.

SystemException - If the transaction service fails in an unexpected way.

setRollbackOnly

public void setRollbackOnly()
                     throws IllegalStateException,
                            SystemException

Description copied from interface: TransactionManager

Mark the transaction associated with the calling thread for rollback only.

Specified by:

setRollbackOnly in interface TransactionManager

Throws:

IllegalStateException - If the transaction is in a state where it cannot be rolled back. This could be because the calling thread is not associated with a transaction, or because it is in the prepared state.

SystemException - If the transaction service fails in an unexpected way.

getStatus

public int getStatus()
              throws SystemException

Description copied from interface: TransactionManager

Get the status of the transaction associated with the calling thread.

Specified by:

getStatus in interface TransactionManager

Returns:

The status of the transaction. This is one of the Status constants. If no transaction is associated with the calling thread, Status.STATUS_NO_TRANSACTION is returned.

Throws:

SystemException - If the transaction service fails in an unexpected way.

getTransaction

public AbstractTransaction getTransaction()

Description copied from interface: TransactionManager

Get the transaction associated with the calling thread.

Specified by:

getTransaction in interface TransactionManager

Returns:

The transaction associated with the calling thread, or null if the calling thread is not associated with a transaction.

setTransactionTimeout

public void setTransactionTimeout(int timeout)

Description copied from interface: TransactionManager

Change the transaction timeout for transactions started by the calling thread with the TransactionManager.begin() method.

Specified by:

setTransactionTimeout in interface TransactionManager

Parameters:

timeout - The new timeout value, in seconds. If this parameter is 0, the timeout value is reset to the default value.

getTransactionTimeout

public int getTransactionTimeout()

suspend

public AbstractTransaction suspend()
                            throws SystemException

Description copied from interface: TransactionManager

Suspend the association the calling thread has to a transaction, and return the suspended transaction. When returning from this method, the calling thread is no longer associated with a transaction.

Specified by:

suspend in interface TransactionManager

Returns:

The transaction that the calling thread was associated with, or null if the calling thread was not associated with a transaction.

Throws:

SystemException - If the transaction service fails in an unexpected way.

resume

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

Description copied from interface: TransactionManager

Resume the association of the calling thread with the given transaction.

Specified by:

resume in interface TransactionManager

Parameters:

transaction - The transaction to be associated with the calling thread.

Throws:

InvalidTransactionException - If the argument does not represent a valid transaction.

IllegalStateException - If the calling thread is already associated with a transaction.

SystemException - If the transaction service fails in an unexpected way.

getInstance

public static ContextTransactionManager getInstance()

Get the transaction manager instance.

Returns:

the transaction manager instance (not null)

getGlobalDefaultTransactionTimeout

public static int getGlobalDefaultTransactionTimeout()

Get the global default transaction timeout.

Returns:

the global default transaction timeout in seconds (>= 1)

setGlobalDefaultTransactionTimeout

public static int setGlobalDefaultTransactionTimeout(int newTimeout)

Set the global default transaction timeout, returning the original value.

Parameters:

newTimeout - the new timeout value in seconds (must be >= 1)

Returns:

the previous timeout in seconds (>= 1)

setMinimumGlobalDefaultTransactionTimeout

public static int setMinimumGlobalDefaultTransactionTimeout(int minimumTimeout)

Set the minimum global default transaction timeout, returning the original value. The new timeout will not be less than the given minimum.

Parameters:

minimumTimeout - the minimum timeout value in seconds (must be >= 1)

Returns:

the previous timeout in seconds (>= 1)

setMaximumGlobalDefaultTransactionTimeout

public static int setMaximumGlobalDefaultTransactionTimeout(int maximumTimeout)

Set the maximum global default transaction timeout, returning the original value. The new timeout will not be greater than the given maximum.

Parameters:

maximumTimeout - the maximum timeout value in seconds (must be >= 1)

Returns:

the previous timeout in seconds (>= 1)