com.arjuna.ats.internal.jts.orbspecific.coordinator

Class ArjunaTransactionImple

java.lang.Object

com.arjuna.ats.arjuna.StateManager

com.arjuna.ats.arjuna.coordinator.BasicAction

com.arjuna.ats.arjuna.coordinator.TwoPhaseCoordinator

com.arjuna.ats.internal.jts.orbspecific.coordinator.ArjunaTransactionImple

All Implemented Interfaces:

ArjunaTransactionOperations, UidCoordinatorOperations, Reapable, CoordinatorOperations, TerminatorOperations

Direct Known Subclasses:

ArjunaTransactionImpleWrapper, RecoveredTransaction, ServerTransaction

public class ArjunaTransactionImple
extends TwoPhaseCoordinator
implements ArjunaTransactionOperations

OTS implementation class. Implements both the Coordinator & Terminator interfaces of OTS as a single class. Note, because Java does not support multiple inheritance we must make use of the tie facility (uuuggghhhh!!!!)

Since:

JTS 1.0.

Version:

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

Author:

Mark Little (mark@arjuna.com)

Field Summary

Fields

Modifier and Type	Field and Description
protected ControlImple	controlHandle
protected ArjunaTransactionImple	parentTransaction

Fields inherited from class com.arjuna.ats.arjuna.coordinator.BasicAction

failedList, heuristicList, pendingList, preparedList, readonlyList, savedIntentionList

Fields inherited from class com.arjuna.ats.arjuna.StateManager

modifyingActions, objectModel, objectUid, usingActions

Constructor Summary

Constructors

Modifier	Constructor and Description
	ArjunaTransactionImple(Control myParent)
	ArjunaTransactionImple(Control myParent, ArjunaTransactionImple parent)
protected	ArjunaTransactionImple(Uid actUid) For crash recovery purposes only.
	ArjunaTransactionImple(Uid actUid, Control myParent)
	ArjunaTransactionImple(Uid actUid, Control myParent, ArjunaTransactionImple parent)

Method Summary

Modifier and Type	Method and Description
void	commit(boolean report_heuristics) If the transaction has already been committed (by another thread, for example) then we do nothing - could throw TransactionRequired or INVALID_TRANSACTION.
Control	create_subtransaction()
protected AbstractRecord	createOTSRecord(boolean propagate, Resource resource, Coordinator coord)
protected AbstractRecord	createOTSRecord(boolean propagate, Resource resource, Coordinator coord, Uid recCoordUid)
protected void	destroyAction()
protected void	doAfterCompletion(Status myStatus)
protected void	doBeforeCompletion()
boolean	equals(Object o)
void	finalize()
boolean	forgetHeuristics() Forget any heuristics we may have received, and tell the resources which generated them to forget too.
Status	get_parent_status()
Status	get_status()
Status	get_top_level_status()
String	get_transaction_name() To be used for debugging purposes only.
PropagationContext	get_txcontext()
ControlImple	getControlHandle()
Map<Uid,String>	getSynchronizations()
int	hash_top_level_tran()
int	hash_transaction()
static int	interpositionType()
boolean	is_ancestor_transaction(Coordinator tc) Is this transaction an ancestor of tc?
boolean	is_descendant_transaction(Coordinator tc) Is this transaction a descendant of tc?
boolean	is_related_transaction(Coordinator tc)
boolean	is_same_transaction(Coordinator tc)
boolean	is_top_level_transaction()
RecoveryCoordinator	register_resource(Resource r) Resources are only registered with the current transaction, whereas subtransaction aware resources are registered with their parents when the current transaction ends.
void	register_subtran_aware(SubtransactionAwareResource r) Do not propagate the resource to the parent.
void	register_synchronization(Synchronization sync) The spec states that a synchronization is registered with a single top-level action only.
void	rollback_only()
void	rollback()
void	setControlHandle(ControlImple handle)
String	topLevelUid()
String	toString() Overloads Object.toString()
String	type() Overloads BasicAction.type()
static String	typeName()
String	uid() We use these to determine relationships between transactions.

Methods inherited from class com.arjuna.ats.arjuna.coordinator.TwoPhaseCoordinator

addSynchronization, afterCompletion, afterCompletion, asyncAfterCompletion, beforeCompletion, cancel, end, getDeferredThrowable, running, start, start

Methods inherited from class com.arjuna.ats.arjuna.coordinator.BasicAction

Abort, abortStatus, activate, activate, activeThreads, add, addChildAction, addChildThread, addChildThread, addRecord, async_prepare, Begin, checkForCurrent, childTransactions, commitStatus, criticalEnd, criticalStart, Current, deactivate, destroy, doAbort, doAbort, doCommit, doCommit, doPrepare, End, finalizeInternal, getHeuristicDecision, getHierarchy, getSavingUid, getStore, hashCode, hierarchyDepth, insertRecord, isAncestor, maintainHeuristics, onePhaseCommit, parent, phase2Abort, phase2Cleanup, phase2Commit, prepare, preparedStatus, preventCommit, removeChildAction, removeChildThread, removeChildThread, restore_state, save_state, setCheckedAction, setHeuristicDecision, status, topLevelAction, topLevelActionUid, typeOfAction, updateHeuristic, updateState

Methods inherited from class com.arjuna.ats.arjuna.StateManager

cleanup, createLists, deactivate, deactivate, disable, forgetAction, get_uid, getMutex, getObjectModel, getStoreRoot, loadObjectState, lockMutex, modified, objectType, packHeader, persist, print, rememberAction, setStatus, setupStore, setupStore, setupStore, terminate, tryLockMutex, unlockMutex, unpackHeader

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.arjuna.ats.arjuna.coordinator.Reapable

get_uid, preventCommit

Field Detail

parentTransaction

protected ArjunaTransactionImple parentTransaction

controlHandle

protected ControlImple controlHandle

Constructor Detail

ArjunaTransactionImple

public ArjunaTransactionImple(Control myParent)

ArjunaTransactionImple

public ArjunaTransactionImple(Control myParent,
                              ArjunaTransactionImple parent)

ArjunaTransactionImple

public ArjunaTransactionImple(Uid actUid,
                              Control myParent)

ArjunaTransactionImple

public ArjunaTransactionImple(Uid actUid,
                              Control myParent,
                              ArjunaTransactionImple parent)

ArjunaTransactionImple

protected ArjunaTransactionImple(Uid actUid)

For crash recovery purposes only.

Method Detail

finalize

public void finalize()

Overrides:

finalize in class Object

getControlHandle

public final ControlImple getControlHandle()

setControlHandle

public final void setControlHandle(ControlImple handle)

commit

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

If the transaction has already been committed (by another thread, for example) then we do nothing - could throw TransactionRequired or INVALID_TRANSACTION. However, if it was rolledback then we throw TRANSACTION_ROLLEDBACK. Seems like an inconsistency. OTS is vague as to what to do if the transaction has been terminated, so we make a sensible choice. report_heuristics is ignored if we are a subtransaction.

Specified by:

commit in interface TerminatorOperations

Throws:

HeuristicMixed

HeuristicHazard

SystemException

rollback

public void rollback()
              throws SystemException

Specified by:

rollback in interface TerminatorOperations

Throws:

SystemException

get_status

public Status get_status()
                  throws SystemException

Specified by:

get_status in interface CoordinatorOperations

Throws:

SystemException

get_parent_status

public Status get_parent_status()
                         throws SystemException

Specified by:

get_parent_status in interface CoordinatorOperations

Throws:

SystemException

get_top_level_status

public Status get_top_level_status()
                            throws SystemException

Specified by:

get_top_level_status in interface CoordinatorOperations

Throws:

SystemException

is_same_transaction

public boolean is_same_transaction(Coordinator tc)
                            throws SystemException

Specified by:

is_same_transaction in interface CoordinatorOperations

Throws:

SystemException

is_related_transaction

public boolean is_related_transaction(Coordinator tc)
                               throws SystemException

Specified by:

is_related_transaction in interface CoordinatorOperations

Throws:

SystemException

is_ancestor_transaction

public boolean is_ancestor_transaction(Coordinator tc)
                                throws SystemException

Is this transaction an ancestor of tc?

Specified by:

is_ancestor_transaction in interface CoordinatorOperations

Throws:

SystemException

is_descendant_transaction

public boolean is_descendant_transaction(Coordinator tc)
                                  throws SystemException

Is this transaction a descendant of tc?

Specified by:

is_descendant_transaction in interface CoordinatorOperations

Throws:

SystemException

is_top_level_transaction

public boolean is_top_level_transaction()
                                 throws SystemException

Specified by:

is_top_level_transaction in interface CoordinatorOperations

Throws:

SystemException

hash_transaction

public int hash_transaction()
                     throws SystemException

Specified by:

hash_transaction in interface CoordinatorOperations

Throws:

SystemException

hash_top_level_tran

public int hash_top_level_tran()
                        throws SystemException

Specified by:

hash_top_level_tran in interface CoordinatorOperations

Throws:

SystemException

register_resource

public RecoveryCoordinator register_resource(Resource r)
                                      throws SystemException,
                                             Inactive

Resources are only registered with the current transaction, whereas subtransaction aware resources are registered with their parents when the current transaction ends.

Specified by:

register_resource in interface CoordinatorOperations

Throws:

SystemException

Inactive

register_subtran_aware

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

Do not propagate the resource to the parent.

Specified by:

register_subtran_aware in interface CoordinatorOperations

Throws:

Inactive

NotSubtransaction

SystemException

rollback_only

public void rollback_only()
                   throws SystemException,
                          Inactive

Specified by:

rollback_only in interface CoordinatorOperations

Throws:

SystemException

Inactive

get_transaction_name

public String get_transaction_name()
                            throws SystemException

To be used for debugging purposes only.

Specified by:

get_transaction_name in interface CoordinatorOperations

Throws:

SystemException

create_subtransaction

public Control create_subtransaction()
                              throws SystemException,
                                     SubtransactionsUnavailable,
                                     Inactive

Specified by:

create_subtransaction in interface CoordinatorOperations

Throws:

SystemException

SubtransactionsUnavailable

Inactive

register_synchronization

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

The spec states that a synchronization is registered with a single top-level action only. However, if this is a nested transaction there is no appropriate exception to raise. So, we raise SynchronizationUnavailable. We could simply get our parent and register the synchronization with it, but this may not be what the user expects. If it is, then the user can get the parent and do it directly!

Specified by:

register_synchronization in interface CoordinatorOperations

Throws:

Inactive

SynchronizationUnavailable

SystemException

get_txcontext

public PropagationContext get_txcontext()
                                 throws Unavailable,
                                        SystemException

Specified by:

get_txcontext in interface CoordinatorOperations

Throws:

Unavailable

SystemException

uid

public String uid()
           throws SystemException

We use these to determine relationships between transactions. Using the hash function is not sufficient, since a hash value is not guaranteed to be unique.

Specified by:

uid in interface UidCoordinatorOperations

Throws:

SystemException

topLevelUid

public String topLevelUid()
                   throws SystemException

Specified by:

topLevelUid in interface UidCoordinatorOperations

Throws:

SystemException

type

public String type()

Description copied from class: TwoPhaseCoordinator

Overloads BasicAction.type()

Overrides:

type in class TwoPhaseCoordinator

interpositionType

public static final int interpositionType()

typeName

public static String typeName()

toString

public String toString()

Description copied from class: BasicAction

Overloads Object.toString()

Overrides:

toString in class BasicAction

equals

public boolean equals(Object o)

Overrides:

equals in class BasicAction

forgetHeuristics

public boolean forgetHeuristics()

Description copied from class: BasicAction

Forget any heuristics we may have received, and tell the resources which generated them to forget too.

Overrides:

forgetHeuristics in class BasicAction

Returns:

true if heuristic information (if any) was successfully forgotten, false otherwise.

doBeforeCompletion

protected void doBeforeCompletion()
                           throws SystemException

Throws:

SystemException

doAfterCompletion

protected void doAfterCompletion(Status myStatus)
                          throws SystemException

Throws:

SystemException

createOTSRecord

protected final AbstractRecord createOTSRecord(boolean propagate,
                                               Resource resource,
                                               Coordinator coord)

createOTSRecord

protected final AbstractRecord createOTSRecord(boolean propagate,
                                               Resource resource,
                                               Coordinator coord,
                                               Uid recCoordUid)

destroyAction

protected final void destroyAction()

getSynchronizations

public Map<Uid,String> getSynchronizations()

Overrides:

getSynchronizations in class TwoPhaseCoordinator