com.oracle.tuxedo.tjatmi

Class TuxTransactionManager

java.lang.Object

com.oracle.tuxedo.tjatmi.TuxTransactionManager

All Implemented Interfaces:

javax.naming.Referenceable, javax.transaction.TransactionManager, javax.transaction.UserTransaction

public class TuxTransactionManager
extends java.lang.Object
implements javax.transaction.TransactionManager, javax.transaction.UserTransaction, javax.naming.Referenceable

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.
com.oracle.tuxedo.tjatmi.TuxTransaction	getCurrentTransaction() Get the transaction currently associated with the current thread context.
int	getDefaultTransactionTimeout() Get the default transaction timeout value asscociated with current transaction manager.
javax.naming.Reference	getReference() Retrieves the Reference of this object.
int	getStatus() Obtain the status of the transaction associated with the current thread.
javax.transaction.Transaction	getTransaction() Get the transaction object that represents the transaction context of the calling thread.
static javax.transaction.TransactionManager	getTransactionManager()
static javax.transaction.UserTransaction	getUserTransaction()
void	resume(javax.transaction.Transaction tobj) 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 subsequent invocations of the begin method.
javax.transaction.Transaction	suspend() Suspend the transaction currently associated with the calling thread and return a Transaction object that represents the transaction context being suspended.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

begin

public void begin()
           throws javax.transaction.NotSupportedException,
                  javax.transaction.SystemException

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

Specified by:

begin in interface javax.transaction.TransactionManager

Specified by:

begin in interface javax.transaction.UserTransaction

Throws:

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

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

See Also:

TransactionManager.begin()

commit

public void commit()
            throws javax.transaction.RollbackException,
                   javax.transaction.HeuristicRollbackException,
                   javax.transaction.HeuristicMixedException,
                   java.lang.SecurityException,
                   java.lang.IllegalStateException,
                   javax.transaction.SystemException

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 javax.transaction.TransactionManager

Specified by:

commit in interface javax.transaction.UserTransaction

Throws:

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

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

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

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

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

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

See Also:

TransactionManager.commit()

rollback

public void rollback()
              throws java.lang.IllegalStateException,
                     java.lang.SecurityException,
                     javax.transaction.SystemException

Roll back the transaction associated with the current thread. When this method completes, the thread is no longer associated with a transaction. Note: We cleanup current transaction context even if the rollback throws an exception.

Specified by:

rollback in interface javax.transaction.TransactionManager

Specified by:

rollback in interface javax.transaction.UserTransaction

Throws:

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

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

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

See Also:

TransactionManager.rollback()

suspend

public javax.transaction.Transaction suspend()
                                      throws javax.transaction.SystemException

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 javax.transaction.TransactionManager

Returns:

Transaction object representing the suspended transaction.

Throws:

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

See Also:

TransactionManager.suspend()

resume

public void resume(javax.transaction.Transaction tobj)
            throws javax.transaction.InvalidTransactionException,
                   java.lang.IllegalStateException,
                   javax.transaction.SystemException

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 javax.transaction.TransactionManager

Parameters:

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

Throws:

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

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

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

See Also:

TransactionManager.resume(javax.transaction.Transaction)

setRollbackOnly

public void setRollbackOnly()
                     throws java.lang.IllegalStateException,
                            javax.transaction.SystemException

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 javax.transaction.TransactionManager

Specified by:

setRollbackOnly in interface javax.transaction.UserTransaction

Throws:

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

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

See Also:

TransactionManager.setRollbackOnly()

setTransactionTimeout

public void setTransactionTimeout(int seconds)
                           throws javax.transaction.SystemException

Modify the timeout value that is associated with transactions started by subsequent invocations of 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 javax.transaction.TransactionManager

Specified by:

setTransactionTimeout in interface javax.transaction.UserTransaction

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:

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

See Also:

TransactionManager.setTransactionTimeout(int)

getStatus

public int getStatus()
              throws javax.transaction.SystemException

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

Specified by:

getStatus in interface javax.transaction.TransactionManager

Specified by:

getStatus in interface javax.transaction.UserTransaction

Returns:

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

Throws:

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

See Also:

TransactionManager.getStatus()

getTransaction

public javax.transaction.Transaction getTransaction()
                                             throws javax.transaction.SystemException

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

Specified by:

getTransaction in interface javax.transaction.TransactionManager

Returns:

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

Throws:

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

See Also:

TransactionManager.getTransaction()

getTransactionManager

public static javax.transaction.TransactionManager getTransactionManager()

getUserTransaction

public static javax.transaction.UserTransaction getUserTransaction()

getCurrentTransaction

public com.oracle.tuxedo.tjatmi.TuxTransaction getCurrentTransaction()

Get the transaction currently associated with the current thread context.

Returns:

the current transaction or null if no transaction has been started on the current thread.

getDefaultTransactionTimeout

public int getDefaultTransactionTimeout()

Get the default transaction timeout value asscociated with current transaction manager.

Returns:

the current default transaction timeout value.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getReference

public javax.naming.Reference getReference()
                                    throws javax.naming.NamingException

Retrieves the Reference of this object. (Currently not supported, always return null).

Specified by:

getReference in interface javax.naming.Referenceable

Returns:

The Reference of this object. (Currently, not supported. and always return null).

Throws:

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