javax.transaction

Interface TransactionManager

All Known Implementing Classes:

WebSphereExtendedJtaPlatform.TransactionManagerAdapter

public interface TransactionManager

The TransactionManager interface defines the methods that allow an application server to manage transactions on behalf of the applications.

User applications should not use this interface directly, but use UserTransaction insted if they need to do their own transaction management.

Internally, the transaction manager associates transactions with threads, and the methods here operate on the transaction associated with the calling thread.

Version:

$Revision$

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.
int	getStatus() Get the status of the transaction associated with the calling thread.
Transaction	getTransaction() Get the transaction associated with the calling thread.
void	resume(Transaction tobj) Resume the association of the calling thread with the given transaction.
void	rollback() Rolls back the transaction associated with the calling thread.
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 begin() method.
Transaction	suspend() Suspend the association the calling thread has to a transaction, and return the suspended transaction.

Method Detail

begin

void begin()
    throws NotSupportedException,
           SystemException

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

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

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

Commit the transaction associated with the calling thread.

Throws:

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

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

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

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.

rollback

void rollback()
       throws IllegalStateException,
              SecurityException,
              SystemException

Rolls back the transaction associated with the calling thread.

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

void setRollbackOnly()
              throws IllegalStateException,
                     SystemException

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

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

int getStatus()
       throws SystemException

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

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

Transaction getTransaction()
                    throws SystemException

Get the transaction associated with the calling thread.

Returns:

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

Throws:

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

setTransactionTimeout

void setTransactionTimeout(int seconds)
                    throws SystemException

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

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.

suspend

Transaction suspend()
             throws SystemException

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.

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

void resume(Transaction tobj)
     throws InvalidTransactionException,
            IllegalStateException,
            SystemException

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

Parameters:

tobj - 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.