oracle.tmm.jta

Class TrmUserTransaction

java.lang.Object

oracle.tmm.jta.TrmUserTransaction

All Implemented Interfaces:

javax.transaction.UserTransaction

public class TrmUserTransaction
extends java.lang.Object
implements javax.transaction.UserTransaction

The OTMM user transaction defines the methods that allow an application to explicitly manage transaction boundaries.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TrmUserTransaction.TrmUserTransactionBuilder

Constructor Summary

Constructors

Constructor and Description
TrmUserTransaction() Initialize a new OTMM user transaction
TrmUserTransaction(TrmUserTransaction.TrmUserTransactionBuilder builder)

Method Summary

Modifier and Type	Method and Description
void	begin() Creates a new transaction and associates it with the current thread.
void	begin(java.lang.Boolean enlist)
void	commit() Commit the transaction associated with the current thread.
protected void	finalize() finalize make sure relevant ThreadLocal objects are removed in case of bug in application code where commit/rollback has not been called.
int	getStatus() Obtain the status of the transaction associated with the current thread.
java.lang.String	getTransactionID() Get OTMM user transaction ID associated with the current thread
java.lang.String	getTxnExternalUrl() Get OTMM user transaction external URL
java.lang.String	getTxnInternalUrl() Get OTMM user transaction internal URL
java.lang.String	getTxnUrl()
void	resume() Resume the transaction.
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 timeout) Modify the timeout value that is associated with transactions started by the current thread with the begin method.
void	suspend() Suspend the transaction.

Methods inherited from class java.lang.Object

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

Constructor Detail

TrmUserTransaction

public TrmUserTransaction()

Initialize a new OTMM user transaction

TrmUserTransaction

TrmUserTransaction(TrmUserTransaction.TrmUserTransactionBuilder builder)

Method Detail

begin

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

Creates a new transaction and associates it with the current thread.

Specified by:

begin in interface javax.transaction.UserTransaction

Throws:

java.lang.IllegalStateException - The IllegalStateException is thrown to indicate the method is invoked at a wrong time

javax.transaction.SystemException - The SystemException is thrown to indicate the OTMM has encountered an unexpected error condition

begin

public void begin(java.lang.Boolean enlist)
           throws java.lang.IllegalStateException,
                  javax.transaction.SystemException

Throws:

java.lang.IllegalStateException

javax.transaction.SystemException

commit

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

Commit 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.UserTransaction

Throws:

javax.transaction.RollbackException - - Thrown to indicate that the transaction has been rolled back rather than committed based on status/exception returned by transaction coordinator.

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 based on status/exception returned by transaction coordinator.

javax.transaction.HeuristicRollbackException - - Thrown to indicate that a heuristic decision was made and that all relevant updates have been rolled back based on status/exception returned by transaction coordinator.

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 an unexpected error condition is encountered.

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.

Specified by:

rollback in interface javax.transaction.UserTransaction

Throws:

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 an unexpected error condition is encountered.

suspend

public void suspend()
             throws java.lang.IllegalStateException

Suspend the transaction. This affects only the local transaction state. This is intended to ensure that the client jax-rs filter for outgoing requests do not perform transaction.

Throws:

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

resume

public void resume()
            throws java.lang.IllegalStateException

Resume the transaction. This affects only the local transaction state. This is intended to ensure that the client jax-rs filter for outgoing requests starts performing transaction specific operations again.

Throws:

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

getTransactionID

public java.lang.String getTransactionID()
                                  throws java.lang.IllegalStateException

Get OTMM user transaction ID associated with the current thread

Returns:

returns the GTRID.

Throws:

java.lang.IllegalStateException - Thrown if the current UserTransaction instance/object has not been used to begin a transaction

setRollbackOnly

public void setRollbackOnly()
                     throws java.lang.IllegalStateException

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

Throws:

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

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

Returns:

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

Throws:

javax.transaction.SystemException - - Thrown if an unexpected error condition is encountered.

setTransactionTimeout

public void setTransactionTimeout(int timeout)

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

Parameters:

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

finalize

protected void finalize()

finalize make sure relevant ThreadLocal objects are removed in case of bug in application code where commit/rollback has not been called.

Overrides:

finalize in class java.lang.Object

getTxnInternalUrl

public java.lang.String getTxnInternalUrl()
                                   throws java.lang.IllegalStateException

Get OTMM user transaction internal URL

Returns:

OTMM user transaction internal URL

Throws:

java.lang.IllegalStateException - The IllegalStateException is thrown to indicate the method is invoked at a wrong time

getTxnExternalUrl

public java.lang.String getTxnExternalUrl()
                                   throws java.lang.IllegalStateException

Get OTMM user transaction external URL

Returns:

OTMM user transaction external URL

Throws:

java.lang.IllegalStateException - The IllegalStateException is thrown to indicate the method is invoked at a wrong time

getTxnUrl

public java.lang.String getTxnUrl()
                           throws java.lang.IllegalStateException

Throws:

java.lang.IllegalStateException