org.objectweb.jotm
Class Current

java.lang.Object
  org.objectweb.jotm.Current

All Implemented Interfaces:

Serializable, Referenceable, TransactionManager, UserTransaction

public class Current
extends Object
implements UserTransaction, TransactionManager, Referenceable, Serializable

Current is the common implementation for UserTransaction.

• UserTransaction is used by clients that want to demarcate transactions themselves. It is referenceable through JNDI.

This object is unique in a VM, i. e. each application server has ONE Current object and each client program should normally issue only ONE lookup on JNDI.

Current also implements Referenceable and Serializable because of JNDI.

See Also:

Serialized Form

Constructor Summary

Current()
Default constructor.

Current(TransactionFactory tmfact)
Constructor for an application server.

Method Summary

int	actionXAResource(String xaAction, String xatx)
void	begin() Creates a new transaction and associate it with the current thread.
void	begin(Xid passxid) Creates a new inflow transaction and associates it with the current thread.
void	begin(Xid passxid, long timeout) Creates a new inflow transaction and associates it with the current thread.
void	clearThreadTx() Clear transaction from this thread if not known.
void	commit() Commits the transaction associated with the current thread.
void	forgetTx(Xid xid) Forget all about this transaction.
String[]	getAllRcTx() Get all Transactions that may require recovery.
String[]	getAllTx() Get all executing transactions.
String[]	getAllXaTx(String stx) Get all XAResources that may require recovery.
Xid[]	getAllXid() Get all Xid's associated with this transaction.
static boolean	getAppServer() Gets the Application Server enabled value
static Current	getCurrent() Returns the unique instance of the class or null if not initialized in case of plain client.
static boolean	getDefaultRecovery() Gets the default recovery value
int	getDefaultTimeout() Gets the default timeout value
static TransactionFactory	getJTM() Returns the TMFactory (in JTM)
Xid[]	getPreparedHeuristicXid() Get the Xid's of all prepared transactions.
TransactionContext	getPropagationContext(boolean hold) Get the transaction context associated with the current thread or null if the thread is not involved in a transaction.
Reference	getReference() Retrieves the Reference of this object.
int	getStatus() Returns the status of the transaction associated with the current thread.
int	getTotalBegunTransactions() Returns the total number of begun transactions.
int	getTotalCommittedTransactions() Returns the total number of committed transactions.
int	getTotalCurrentTransactions() Returns the current number of transactions.
int	getTotalExpiredTransactions() Returns the total number of rolled back transactions due to timeout.
int	getTotalRolledbackTransactions() Returns the total number of rolled back transactions.
Transaction	getTransaction() Gets the transaction object that represents the transaction context of the calling thread.
Integer[]	getTransactionCounters() Returns all counters.
static TransactionManager	getTransactionManager()
static TransactionRecovery	getTransactionRecovery() Returns the Transaction Recovery object
int	getTransactionTimeout() Gets the transaction timeout value
TransactionImpl	getTxByXid(Xid xid) Get the transaction referenced by Xid.
static UserTransaction	getUserTransaction()
XATerminator	getXATerminator() Gets the inflow transaction object that represents the transaction context of the calling thread.
void	resetAllTxTotalCounters() Resets total number of transactions.
void	resume(Transaction tobj) Resumes the transaction context association of the calling thread with the transaction represented by the supplied Transaction object.
void	rollback() Rolls back the transaction associated with the current thread.
static void	setAppServer(boolean appserver) Sets indicator if running with Application Server
static void	setDefaultRecovery(boolean recovery) Sets the default recovery value
void	setDefaultTimeout(int timeout) Sets the default timeout value
void	setPropagationContext(TransactionContext pctx, boolean isReply) Associate to the current thread a transaction represented by its transaction context.
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.
static void	setTMFactory(TransactionFactory tmfact) The TM factory is passed as an argument.
void	setTransactionRecovery(boolean recovery) Modifies the value of the recovery value that is associated with the transactions started by the current thread with the begin method.
void	setTransactionTimeout(int timeout) Modifies the value of the timeout value that is associated with the transactions started by the current thread with the begin method.
Transaction	suspend() Suspends the transaction currently associated with the calling thread and return a Transaction object that represents the transaction context being suspended.
static void	transactionRecovery() Initiate transaction recovery if enabled.

Methods inherited from class java.lang.Object

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

Constructor Detail

Current

public Current()

Default constructor. A client does not need the TMFactory.

Current

public Current(TransactionFactory tmfact)

Constructor for an application server. Typically called form the Jotm constructor. The TM factory is passed as an argument. Note that the TM factory can be either local or remote.

Parameters:

tmfact - TM Factory to use

Method Detail

getTransactionManager

public static TransactionManager getTransactionManager()

Returns:

the unique TransactionManager for the current server.

getUserTransaction

public static UserTransaction getUserTransaction()

Returns:

the unique UserTransaction.

setTMFactory

public static void setTMFactory(TransactionFactory tmfact)

The TM factory is passed as an argument. Note that the TM factory can be either local or remote.

Parameters:

tmfact - TM Factory to use

transactionRecovery

public static void transactionRecovery()

Initiate transaction recovery if enabled.

begin

public void begin()
           throws NotSupportedException,
                  SystemException

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

Specified by:

begin in interface TransactionManager

Specified by:

begin in interface UserTransaction

Throws:

NotSupportedException - Thrown if the thread is already associated with a transaction. (nested transaction are not supported)

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

begin

public void begin(Xid passxid)
           throws NotSupportedException,
                  SystemException

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

Parameters:

passxid - Xid of the inflow transaction.

Throws:

NotSupportedException - Thrown if the thread is already associated with a transaction. (nested transaction are not supported)

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

begin

public void begin(Xid passxid,
                  long timeout)
           throws NotSupportedException,
                  SystemException

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

Parameters:

passxid - Xid of the inflow transaction.

timeout - value of the timeout (in seconds). If the value is less than or equal to zero, the value will be set to the default value.

Throws:

NotSupportedException - Thrown if the thread is already associated with a transaction. (nested transaction are not supported)

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

getXATerminator

public XATerminator getXATerminator()
                             throws XAException

Gets the inflow transaction object that represents the transaction context of the calling thread.

Returns:

the XATerminator object representing the inflow transaction associated with the calling thread. If the calling thread is not associated with an inflow transaction, a null object reference is returned.

Throws:

XAException - Thrown if the transaction manager encounters an unexpected error condition

commit

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

Commits the transaction associated with the current thread. When this method completes, the thread becomes associated with no transaction.

Specified by:

commit in interface TransactionManager

Specified by:

commit in interface UserTransaction

Throws:

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

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

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

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.

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

rollback

public void rollback()
              throws IllegalStateException,
                     SecurityException,
                     SystemException

Rolls back the transaction associated with the current thread. When this method completes, the thread becomes associated with no transaction.

Specified by:

rollback in interface TransactionManager

Specified by:

rollback in interface UserTransaction

Throws:

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

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

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

setRollbackOnly

public void setRollbackOnly()
                     throws IllegalStateException,
                            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 TransactionManager

Specified by:

setRollbackOnly in interface UserTransaction

Throws:

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

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

getStatus

public int getStatus()
              throws SystemException

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

Specified by:

getStatus in interface TransactionManager

Specified by:

getStatus in interface UserTransaction

Returns:

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

Throws:

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

setTransactionTimeout

public void setTransactionTimeout(int timeout)
                           throws SystemException

Modifies the value of the timeout value that is associated with the 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 TransactionManager

Specified by:

setTransactionTimeout in interface UserTransaction

Parameters:

timeout - value of the timeout (in seconds). If the value is zero, the transaction service restores the default value.

Throws:

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

getTransactionTimeout

public int getTransactionTimeout()

Gets the transaction timeout value

Returns:

transaction timeout value (in seconds)

setTransactionRecovery

public void setTransactionRecovery(boolean recovery)
                            throws SystemException

Modifies the value of the recovery value that is associated with the transactions started by the current thread with the begin method. If an application has not called this method, the transaction service uses the default value of 'false' for recovery.

Parameters:

recovery - value of the recovery (true or false). If the value is false, recovery of transactions is disabled.

Throws:

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

getTransaction

public Transaction getTransaction()
                           throws SystemException

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

Specified by:

getTransaction in interface TransactionManager

Returns:

the Transaction object representing the transaction associated with the calling thread. If the calling thread is not associated with a transaction, a null object reference is returned.

Throws:

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

resume

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

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

Warning: No XA start is done here. We suppose it is already done after a getConnection().

The supposed programming model is:

1. getConnection()
2. SQL code
3. connection.close()

Specified by:

resume in interface TransactionManager

Parameters:

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

Throws:

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

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

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

suspend

public Transaction suspend()
                    throws SystemException

Suspends 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 null. When this method returns, the calling thread is associated with no transaction.

Warning: No XA start is done here. We suppose it is already done after a getConnection().

The supposed programming model is:

1. getConnection()
2. SQL code
3. connection.close()

Specified by:

suspend in interface TransactionManager

Returns:

Transaction object representing the suspended transaction.

Throws:

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

getReference

public Reference getReference()
                       throws NamingException

Retrieves the Reference of this object.

Specified by:

getReference in interface Referenceable

Returns:

The non-null Reference of this object.

Throws:

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

getCurrent

public static Current getCurrent()

Returns the unique instance of the class or null if not initialized in case of plain client.

Returns:

The Current object created

getJTM

public static TransactionFactory getJTM()

Returns the TMFactory (in JTM)

Returns:

TransactionFactory

getTransactionRecovery

public static TransactionRecovery getTransactionRecovery()

Returns the Transaction Recovery object

Returns:

TransactionRecovery

setDefaultTimeout

public void setDefaultTimeout(int timeout)

Sets the default timeout value

Parameters:

timeout - timeout value (in seconds)

getDefaultTimeout

public int getDefaultTimeout()

Gets the default timeout value

Returns:

default timeout value (in seconds)

setDefaultRecovery

public static void setDefaultRecovery(boolean recovery)

Sets the default recovery value

Parameters:

recovery - recovery value (true or false)

getDefaultRecovery

public static boolean getDefaultRecovery()

Gets the default recovery value

Returns:

default recovery value (true or false)

setAppServer

public static void setAppServer(boolean appserver)

Sets indicator if running with Application Server

Parameters:

appserver - application server enabled value (true or false)

getAppServer

public static boolean getAppServer()

Gets the Application Server enabled value

Returns:

application server enabled value (true or false)

setPropagationContext

public void setPropagationContext(TransactionContext pctx,
                                  boolean isReply)

Associate to the current thread a transaction represented by its transaction context. This is used internally by the implicit propagation of the transactional context. Server side: called with isReply=false when receiving a request. Server side: called with pctx=null when sending a reply. Client side: called with isReply=true when receiveing the reply.

Parameters:

pctx - TransactionContext. May be null to clean the thread (server side)

isReply - true when receiving a reply (client side)

getPropagationContext

public TransactionContext getPropagationContext(boolean hold)

Get the transaction context associated with the current thread or null if the thread is not involved in a transaction.

Parameters:

hold - true if hold the object while used. (Not used any longer)

Returns:

the propagation context for the current transaction.

forgetTx

public void forgetTx(Xid xid)

Forget all about this transaction. References to TransactionImpl must be destroyed to allow the garbage collector to free memory allocated to this transaction.

Parameters:

xid - Xid of the transaction

getTxByXid

public TransactionImpl getTxByXid(Xid xid)

Get the transaction referenced by Xid.

Parameters:

xid - Xid of the transaction

Returns:

the TransactionImpl

getPreparedHeuristicXid

public Xid[] getPreparedHeuristicXid()

Get the Xid's of all prepared transactions.

Returns:

array of all Xids in the prepared state

getAllXid

public Xid[] getAllXid()

Get all Xid's associated with this transaction.

Returns:

array of all Xids

getAllTx

public String[] getAllTx()

Get all executing transactions.

Returns:

array of all Transactions in execution

getAllRcTx

public String[] getAllRcTx()

Get all Transactions that may require recovery.

Returns:

array of all Transactions that may require recovery

getAllXaTx

public String[] getAllXaTx(String stx)

Get all XAResources that may require recovery.

Parameters:

stx - identifies the transaction

Returns:

array of all XAResources that may require recovery

actionXAResource

public int actionXAResource(String xaAction,
                            String xatx)

Parameters:

xaAction - String "commit" "rollback" or "forget"

xatx - String representing the transaction

Returns:

0

clearThreadTx

public void clearThreadTx()

Clear transaction from this thread if not known. Useful when another thread completes the current thread's transaction

getTotalCurrentTransactions

public int getTotalCurrentTransactions()

Returns the current number of transactions.

Returns:

current number of transaction

getTotalBegunTransactions

public int getTotalBegunTransactions()

Returns the total number of begun transactions.

Returns:

total number of begun transactions

getTotalRolledbackTransactions

public int getTotalRolledbackTransactions()

Returns the total number of rolled back transactions.

Returns:

total number of rolled back transactions

getTotalCommittedTransactions

public int getTotalCommittedTransactions()

Returns the total number of committed transactions.

Returns:

total number of commited transactions

resetAllTxTotalCounters

public void resetAllTxTotalCounters()

Resets total number of transactions.

getTotalExpiredTransactions

public int getTotalExpiredTransactions()

Returns the total number of rolled back transactions due to timeout.

Returns:

number of rolled back transactions due to timeout

getTransactionCounters

public Integer[] getTransactionCounters()

Returns all counters.

Returns:

an array of all counters (current tx, begun tx, committed tx, rolled back tx, timeouted tx)