Class TrmUserTransaction

java.lang.Object
oracle.tmm.jta.TrmUserTransaction
All Implemented Interfaces:
javax.transaction.UserTransaction

public class TrmUserTransaction extends Object implements javax.transaction.UserTransaction
The OTMM(MicroTx) user transaction defines the methods that allow an application to explicitly manage transaction boundaries.
  • Field Details

    • gtrid

      public String gtrid
    • txnUrl

      public String txnUrl
    • txnInternalUrl

      public String txnInternalUrl
    • txnExternalUrl

      public String txnExternalUrl
    • timeout

      public int timeout
    • rollbackOnly

      public boolean rollbackOnly
    • suspended

      public boolean suspended
    • insProperties

      public Map<String,Object> insProperties
  • Constructor Details

    • TrmUserTransaction

      public TrmUserTransaction()
      Initialize a new OTMM(MicroTx) user transaction
  • Method Details

    • begin

      public void begin() throws IllegalStateException, javax.transaction.SystemException
      Creates a new transaction and associates it with the current thread.
      Specified by:
      begin in interface javax.transaction.UserTransaction
      Throws:
      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(MicroTx) has encountered an unexpected error condition
    • begin

      public void begin(Boolean enlist) throws IllegalStateException, javax.transaction.SystemException
      Throws:
      IllegalStateException
      javax.transaction.SystemException
    • startTCSGlobalTransaction

      public void startTCSGlobalTransaction() throws IllegalStateException, javax.transaction.SystemException
      Start the Golbal Transaction with the TCS
      Throws:
      IllegalStateException
      javax.transaction.SystemException
    • commit

      public void commit() throws javax.transaction.RollbackException, javax.transaction.HeuristicMixedException, javax.transaction.HeuristicRollbackException, SecurityException, 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.
      SecurityException - - Thrown to indicate that the thread is not allowed to commit the transaction.
      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 IllegalStateException, 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:
      SecurityException - - Thrown to indicate that the thread is not allowed to commit the transaction.
      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 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:
      IllegalStateException - Thrown if the current thread is not associated with a transaction.
    • resume

      public void resume() throws 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:
      IllegalStateException - Thrown if the current thread is not associated with a transaction.
    • getTransactionID

      public String getTransactionID() throws IllegalStateException
      Get OTMM(MicroTx) user transaction ID associated with the current thread
      Returns:
      returns the GTRID.
      Throws:
      IllegalStateException - Thrown if the current UserTransaction instance/object has not been used to begin a transaction
    • setRollbackOnly

      public void setRollbackOnly() throws 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:
      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.
    • getTxnInternalUrl

      public String getTxnInternalUrl() throws IllegalStateException
      Get OTMM(MicroTx) user transaction internal URL
      Returns:
      OTMM(MicroTx) user transaction internal URL
      Throws:
      IllegalStateException - The IllegalStateException is thrown to indicate the method is invoked at a wrong time
    • getTxnExternalUrl

      public String getTxnExternalUrl() throws IllegalStateException
      Get OTMM(MicroTx) user transaction external URL
      Returns:
      OTMM(MicroTx) user transaction external URL
      Throws:
      IllegalStateException - The IllegalStateException is thrown to indicate the method is invoked at a wrong time
    • getTxnUrl

      public String getTxnUrl() throws IllegalStateException
      Throws:
      IllegalStateException
    • setProperty

      public void setProperty(String propertyName, Object propertyValue)