com.arjuna.ats.jts.extensions

Class AtomicTransaction

java.lang.Object

com.arjuna.ats.jts.extensions.AtomicTransaction

Direct Known Subclasses:

TopLevelTransaction

public class AtomicTransaction
extends Object

Similar to CosTransactions::Current. However, this class does transaction scoping, so if an instance is garbage collected and the transaction is still running, it will be rolled back automatically. It also adds some convenience routines which Current does not do.

Since:

JTS 1.0.

Version:

$Id: AtomicTransaction.java 2342 2006-03-30 13:06:17Z $

Author:

Mark Little (mark_little@hp.com)

Field Summary

Fields

Modifier and Type	Field and Description
protected com.arjuna.ats.internal.jts.ControlWrapper	_theAction
protected Status	_theStatus
protected int	_timeout
static int	NESTED
static int	TOP_LEVEL The types of transactions which can be created.

Constructor Summary

Constructors

Modifier	Constructor and Description
	AtomicTransaction() Create a new transaction.
protected	AtomicTransaction(com.arjuna.ats.internal.jts.ControlWrapper tx)

Method Summary

Modifier and Type	Method and Description
void	begin() Start the transaction.
void	commit(boolean report_heuristics)
Control	control()
boolean	equals(Object obj)
void	finalize()
Status	get_status()
int	get_timeout()
String	get_transaction_name()
PropagationContext	get_txcontext()
Uid	get_uid()
protected Status	getStatus()
int	getTimeout()
int	hashCode()
RecoveryCoordinator	registerResource(Resource r) Register the specified resource with this transaction.
void	registerSubtranAware(SubtransactionAwareResource r) Register the specified subtransaction aware resource with this transaction.
void	registerSynchronization(Synchronization sync) Register the specified synchronization with this transaction.
void	resume() Resume this transaction.
void	rollback()
void	rollbackOnly() Allow action commit to be supressed.
void	set_timeout(int seconds) Set the transaction timeout.
void	suspend() Suspend this transaction from the current thread.
protected boolean	validTransaction() If this transaction current? Assume we have checked that we are actually a transaction! If not valid then abort this transaction here.

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

TOP_LEVEL

public static final int TOP_LEVEL

The types of transactions which can be created.

See Also:

Constant Field Values

NESTED

public static final int NESTED

See Also:

Constant Field Values

_theAction

protected com.arjuna.ats.internal.jts.ControlWrapper _theAction

_theStatus

protected Status _theStatus

_timeout

protected int _timeout

Constructor Detail

AtomicTransaction

public AtomicTransaction()

Create a new transaction. It is not running at this stage.

AtomicTransaction

protected AtomicTransaction(com.arjuna.ats.internal.jts.ControlWrapper tx)

Method Detail

finalize

public void finalize()

Overrides:

finalize in class Object

get_transaction_name

public String get_transaction_name()
                            throws SystemException

Returns:

the transaction name. Should only be used for debugging purposes.

Throws:

SystemException

begin

public void begin()
           throws SubtransactionsUnavailable,
                  SystemException

Start the transaction.

Throws:

SubtransactionsUnavailable - if subtransactions have been disabled, and the invoking thread already has a transaction associated with it.

INVALID_TRANSACTION - if the transaction has already begun or has completed.

SystemException

commit

public void commit(boolean report_heuristics)
            throws NoTransaction,
                   HeuristicMixed,
                   HeuristicHazard,
                   WrongTransaction,
                   SystemException

Throws:

NoTransaction

HeuristicMixed

HeuristicHazard

WrongTransaction

SystemException

rollback

public void rollback()
              throws NoTransaction,
                     WrongTransaction,
                     SystemException

Throws:

NoTransaction

WrongTransaction

SystemException

set_timeout

public void set_timeout(int seconds)
                 throws SystemException

Set the transaction timeout. This is the same as calling org.omg.CosTransactions.Current.set_timeout().

Throws:

SystemException

get_timeout

public int get_timeout()
                throws SystemException

Returns:

the timeout associated with transactions created by the current thread.

Throws:

SystemException

getTimeout

public int getTimeout()
               throws SystemException

Returns:

the timeout associated with this transaction.

Throws:

SystemException

get_txcontext

public PropagationContext get_txcontext()
                                 throws Inactive,
                                        SystemException

Returns:

the propagation context for this transaction.

Throws:

Inactive - if the current transaction is no longer in the active phase.

SystemException

Since:

JTS 2.1.

registerResource

public RecoveryCoordinator registerResource(Resource r)
                                     throws Inactive,
                                            SystemException

Register the specified resource with this transaction.

Returns:

the org.omg.CosTransactions.RecoveryCoordinator reference that can be used to later query the outcome of the transaction.

Throws:

Inactive - if the current transaction is no longer in the active phase.

SystemException

registerSubtranAware

public void registerSubtranAware(SubtransactionAwareResource r)
                          throws Inactive,
                                 NotSubtransaction,
                                 SystemException

Register the specified subtransaction aware resource with this transaction. This transaction must be a subtransaction.

Throws:

Inactive - if this transaction is no longer in the active phase.

NotSubtransaction - if this transaction is not a subtransaction.

SystemException

registerSynchronization

public void registerSynchronization(Synchronization sync)
                             throws Inactive,
                                    SynchronizationUnavailable,
                                    SystemException

Register the specified synchronization with this transaction. This transaction must be a top-level transaction.

Throws:

Inactive - if this transaction is no longer in the active phase.

SynchronizationUnavailable - if this transaction it not a top-level transaction.

SystemException

control

public Control control()
                throws NoTransaction,
                       SystemException

Returns:

the org.omg.CosTransactions.Control reference to this transaction.

Throws:

NoTransaction

SystemException

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

suspend

public void suspend()
             throws NoTransaction,
                    WrongTransaction,
                    SystemException

Suspend this transaction from the current thread. This transaction must be active on the calling thread for this method to succeed.

Throws:

NoTransaction - if there is no current transaction.

WrongTransaction - if the transaction associated with the current thread is different from this thread.

SystemException

resume

public void resume()
            throws InvalidControl,
                   SystemException

Resume this transaction.

Throws:

InvalidControl - if this transaction is invalid.

SystemException

get_status

public Status get_status()
                  throws SystemException

Returns:

the status of this transaction.

Throws:

SystemException

rollbackOnly

public void rollbackOnly()
                  throws SystemException,
                         NoTransaction

Allow action commit to be supressed. Although the OTS would require an InactiveException if the transaction is not active, we ignore that via this route.

Throws:

SystemException

NoTransaction

hashCode

public int hashCode()

Overrides:

hashCode in class Object

get_uid

public Uid get_uid()

validTransaction

protected final boolean validTransaction()

If this transaction current? Assume we have checked that we are actually a transaction! If not valid then abort this transaction here. Leave current alone.

getStatus

protected final Status getStatus()