org.jboss.tm
Class TransactionImpl

java.lang.Object
  extended byorg.jboss.tm.TransactionImpl
All Implemented Interfaces:
TimeoutTarget (src) , Transaction (src)

public class TransactionImpl
extends java.lang.Object
implements Transaction (src) , TimeoutTarget (src)

Our Transaction implementation.

See Also:
TxManager (src)

Method Summary
 void associateCurrentThread()
           
 void commit()
          Attempt to commit this transaction.
 boolean delistResource(XAResource (src)  xaRes, int flag)
          Delist an XA resource from this transaction.
 void disassociateCurrentThread()
           
 boolean enlistResource(XAResource (src)  xaRes)
          Enlist an XA resource with this transaction.
 boolean equals(java.lang.Object obj)
           
 GlobalId (src) getGlobalId()
          Returns the global id of this transaction.
 LocalId (src) getLocalId()
          Returns the local id of this transaction.
 long getLocalIdValue()
          Returns the local id of this transaction.
 int getStatus()
          Get the status of the transaction.
 long getTimeLeftBeforeTimeout()
           
 XidImpl (src) getXid()
          Returns the xid of this transaction.
 int hashCode()
           
 void registerSynchronization(Synchronization (src)  s)
          Register a Synchronization (src) callback with this transaction.
 void rollback()
          Rolls back this transaction.
 void setRollbackOnly()
          Mark the transaction so that the only possible outcome is a rollback.
 void timedOut(Timeout (src)  timeout)
          Called when our timeout expires.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Method Detail

timedOut

public void timedOut(Timeout (src)  timeout)
Called when our timeout expires.

Specified by:
timedOut in interface TimeoutTarget (src)

commit

public void commit()
            throws RollbackException (src) ,
                   HeuristicMixedException (src) ,
                   HeuristicRollbackException (src) ,
                   java.lang.SecurityException,
                   java.lang.IllegalStateException,
                   SystemException (src) 
Description copied from interface: Transaction (src)
Attempt to commit this transaction.

Specified by:
commit in interface Transaction (src)
Throws:
java.lang.SecurityException - If the caller is not allowed to commit this transaction.
SystemException (src) - If the transaction service fails in an unexpected way.
RollbackException (src) - If the transaction was marked for rollback only, the transaction is rolled back and this exception is thrown.
HeuristicMixedException (src) - If a heuristic decision was made and some some parts of the transaction have been committed while other parts have been rolled back.
HeuristicRollbackException (src) - If a heuristic decision to roll back the transaction was made.
java.lang.IllegalStateException

rollback

public void rollback()
              throws java.lang.IllegalStateException,
                     java.lang.SecurityException,
                     SystemException (src) 
Description copied from interface: Transaction (src)
Rolls back this transaction.

Specified by:
rollback in interface Transaction (src)
Throws:
java.lang.IllegalStateException - If the transaction is in a state where it cannot be rolled back. This could be because the transaction is no longer active, or because it is in the prepared state.
SystemException (src) - If the transaction service fails in an unexpected way.
java.lang.SecurityException

delistResource

public boolean delistResource(XAResource (src)  xaRes,
                              int flag)
                       throws java.lang.IllegalStateException,
                              SystemException (src) 
Description copied from interface: Transaction (src)
Delist an XA resource from this transaction.

Specified by:
delistResource in interface Transaction (src)
Returns:
true if the resource could be delisted from this transaction, otherwise false.
Throws:
java.lang.IllegalStateException - If the transaction is in a state where resources cannot be delisted. This could be because the transaction is no longer active.
SystemException (src) - If the transaction service fails in an unexpected way.

enlistResource

public boolean enlistResource(XAResource (src)  xaRes)
                       throws RollbackException (src) ,
                              java.lang.IllegalStateException,
                              SystemException (src) 
Description copied from interface: Transaction (src)
Enlist an XA resource with this transaction.

Specified by:
enlistResource in interface Transaction (src)
Returns:
true if the resource could be enlisted with this transaction, otherwise false.
Throws:
SystemException (src) - If the transaction service fails in an unexpected way.
RollbackException (src) - If the transaction is marked for rollback only.
java.lang.IllegalStateException - If the transaction is in a state where resources cannot be enlisted. This could be because the transaction is no longer active, or because it is in the prepared state.

getStatus

public int getStatus()
              throws SystemException (src) 
Description copied from interface: Transaction (src)
Get the status of the transaction.

Specified by:
getStatus in interface Transaction (src)
Returns:
The status of the transaction. This is one of the Status (src) constants.
Throws:
SystemException (src) - If the transaction service fails in an unexpected way.

registerSynchronization

public void registerSynchronization(Synchronization (src)  s)
                             throws RollbackException (src) ,
                                    java.lang.IllegalStateException,
                                    SystemException (src) 
Description copied from interface: Transaction (src)
Register a Synchronization (src) callback with this transaction.

Specified by:
registerSynchronization in interface Transaction (src)
Throws:
RollbackException (src) - If the transaction is marked for rollback only.
SystemException (src) - If the transaction service fails in an unexpected way.
java.lang.IllegalStateException - If the transaction is in a state where Synchronization (src) callbacks cannot be registered. This could be because the transaction is no longer active, or because it is in the prepared state.

setRollbackOnly

public void setRollbackOnly()
                     throws java.lang.IllegalStateException,
                            SystemException (src) 
Description copied from interface: Transaction (src)
Mark the transaction so that the only possible outcome is a rollback.

Specified by:
setRollbackOnly in interface Transaction (src)
Throws:
SystemException (src) - If the transaction service fails in an unexpected way.
java.lang.IllegalStateException - If the transaction is not in an active state.

associateCurrentThread

public void associateCurrentThread()

disassociateCurrentThread

public void disassociateCurrentThread()

hashCode

public int hashCode()

toString

public java.lang.String toString()

equals

public boolean equals(java.lang.Object obj)

getLocalIdValue

public long getLocalIdValue()
Returns the local id of this transaction. The local id is used as a transaction propagation context within the JBoss server, and in the TxManager for mapping local transaction ids to transactions.


getLocalId

public LocalId (src)  getLocalId()
Returns the local id of this transaction. The local id is used as a transaction propagation context within the JBoss server, and in the TxManager for mapping local transaction ids to transactions.


getGlobalId

public GlobalId (src)  getGlobalId()
Returns the global id of this transaction. Ths global id is used in the TxManager, which keeps a map from global ids to transactions.


getXid

public XidImpl (src)  getXid()
Returns the xid of this transaction.


getTimeLeftBeforeTimeout

public long getTimeLeftBeforeTimeout()