org.wildfly.transaction.client

Class LocalUserTransaction

java.lang.Object

org.wildfly.transaction.client.LocalUserTransaction

All Implemented Interfaces:

Serializable, UserTransaction

public final class LocalUserTransaction
extends Object
implements UserTransaction, Serializable

A UserTransaction instance that controls the transaction state of the current local provider.

Author:

David M. Lloyd

See Also:

Serialized Form

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 LocalUserTransaction	getInstance() Get the singleton instance.
int	getStatus() Get the status of the transaction associated with the calling thread.
boolean	isAvailable()
void	rollback() Rolls back the transaction associated with the calling thread.
void	setAvailability(boolean available)
void	setRollbackOnly() Mark the transaction associated with the calling thread for rollback only.
void	setTransactionTimeout(int seconds) Change the transaction timeout for transactions started by the calling thread with the UserTransaction.begin() method.

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: UserTransaction

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

Specified by:

begin in interface UserTransaction

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: UserTransaction

Commit the transaction associated with the calling thread.

Specified by:

commit in interface UserTransaction

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: UserTransaction

Rolls back the transaction associated with the calling thread.

Specified by:

rollback in interface UserTransaction

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: UserTransaction

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

Specified by:

setRollbackOnly in interface UserTransaction

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: UserTransaction

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

Specified by:

getStatus in interface UserTransaction

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.

setTransactionTimeout

public void setTransactionTimeout(int seconds)
                           throws SystemException

Description copied from interface: UserTransaction

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

Specified by:

setTransactionTimeout in interface UserTransaction

Parameters:

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

Throws:

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

setAvailability

public void setAvailability(boolean available)

isAvailable

public boolean isAvailable()

getInstance

public static LocalUserTransaction getInstance()

Get the singleton instance.

Returns:

the singleton instance