com.arjuna.mwlabs.wscf.model.twophase.arjunacore.subordinate

Class SubordinateATCoordinator

java.lang.Object

com.arjuna.ats.arjuna.StateManager

com.arjuna.ats.arjuna.coordinator.BasicAction

com.arjuna.ats.arjuna.coordinator.TwoPhaseCoordinator

com.arjuna.mwlabs.wscf.model.twophase.arjunacore.ATCoordinator

com.arjuna.mwlabs.wscf.model.twophase.arjunacore.subordinate.SubordinateATCoordinator

All Implemented Interfaces:

com.arjuna.ats.arjuna.coordinator.Reapable

Direct Known Subclasses:

RecoverySubordinateATCoordinator

public class SubordinateATCoordinator
extends ATCoordinator

This class represents a specific coordination instance. It is essentially an ArjunaCore TwoPhaseCoordinator, which gives us access to two-phase with synchronization support but without thread management. This is the subordinate coordinator implementation which we use when doing interposition.

Since:

2.0.

Version:

$Id: SubordinateATCoordinator.java,v 1.1 2005/05/19 12:13:39 nmcl Exp $

Author:

Mark Little (mark.little@arjuna.com)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SubordinateATCoordinator.SubordinateCallback class implemented by any code which wishes to register a callabck

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARTICIPANT_PREFIX unique string used as prefix for participant ids to ensure they can be identified at recovery
static String	SUBORDINATE_TX_TYPE_AT_AT standard AT subordinate tx type for an AT subordinate created below another AT transaction
static String	TRANSACTION_TYPE type string used to locate TX log records in the tx object store hierarchy

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

failedList, heuristicList, pendingList, preparedList, readonlyList, savedIntentionList, subordinate

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

modifyingActions, objectModel, objectUid, usingActions

Constructor Summary

Constructors

Constructor and Description
SubordinateATCoordinator() normal constructor
SubordinateATCoordinator(String subordinateType) bridge wrapper constructor
SubordinateATCoordinator(com.arjuna.ats.arjuna.common.Uid recovery) constructor for recovered coordinator

Method Summary

Modifier and Type	Method and Description
static void	addActiveProxy(String id)
static void	addCallback(String key, SubordinateATCoordinator.SubordinateCallback callback) register a callback to be called when a subordinate transaction with a specific key executes a commit or rollback.
protected static void	addRecoveredCoordinator(SubordinateATCoordinator coordinator)
int	cancel()
void	commit() this is driven by a durable participant registered on behalf of the coordinator and does a normal commit minus the after completion processing which will be driven by a volatile participant also registerd for this coordinator..
void	commitVolatile() this is driven by a volatile participant registered on behalf of the coordinator
Outcome	coordinate(CompletionStatus cs) If the application requires and if the coordination protocol supports it, then this method can be used to execute a coordination protocol on the currently enlisted participants at any time prior to the termination of the coordination scope.
int	end(boolean reportHeuristics)
void	error() called by the durable participant during recovery processing TODO clarify when and why this gets called and what to do about it
String	getDurable2PhaseId() return a uid for the durable participant registered on behalf of this corodinator
static SubordinateATCoordinator	getRecoveredCoordinator(String coordinatorId)
String	getSubordinateType()
String	getVolatile2PhaseId() return a uid for the volatile participant registered on behalf of this corodinator
boolean	isActivated()
boolean	isOrphaned() test whether a transaction has been restored without its proxy participant.
static SubordinateATCoordinator[]	listRecoveredCoordinators()
int	prepare() this is driven by a durable participant registered on behalf of the coordinator and does a normal prepare mninus the before completion processing which has already been performed
boolean	prepareVolatile() this is driven by a volatile participant registered on behalf of the coordinator
static void	removeActiveProxy(String id)
protected static void	removeRecoveredCoordinator(SubordinateATCoordinator coordinator)
boolean	restore_state(com.arjuna.ats.arjuna.state.InputObjectState os, int ot)
void	rollback() this is driven by a durable participant registered on behalf of the coordinator and does a normal commit minus the after completion processing which will be driven by a volatile participant also registerd for this coordinator..
void	rollbackVolatile() this is driven by a volatile participant registered on behalf of the coordinator
boolean	save_state(com.arjuna.ats.arjuna.state.OutputObjectState os, int ot)
protected void	setActivated()
String	type()
void	unknown() called by the durable participant during recovery processing TODO clarify when and why this gets called and what to do about it

Methods inherited from class com.arjuna.mwlabs.wscf.model.twophase.arjunacore.ATCoordinator

delistParticipant, delistSynchronization, enlistParticipant, enlistSynchronization, identifier, participantReadOnly, participantRolledBack, qualifiers

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

addSynchronization, afterCompletion, afterCompletion, asyncAfterCompletion, beforeCompletion, getDeferredThrowable, getSynchronizations, running, start, start

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

Abort, 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, equals, finalizeInternal, forgetHeuristics, getDeferredThrowables, getHeuristicDecision, getHierarchy, getSavingUid, getStore, hashCode, hierarchyDepth, insertRecord, isAncestor, maintainHeuristics, onePhaseCommit, parent, phase2Abort, phase2Cleanup, phase2Commit, prepare, preparedStatus, preventCommit, removeChildAction, removeChildThread, removeChildThread, setCheckedAction, setHeuristicDecision, status, topLevelAction, topLevelActionUid, toString, 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, finalize, getClass, notify, notifyAll, wait, wait, wait

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

get_uid, preventCommit

Field Detail

TRANSACTION_TYPE

public static final String TRANSACTION_TYPE

type string used to locate TX log records in the tx object store hierarchy

See Also:

Constant Field Values

PARTICIPANT_PREFIX

public static String PARTICIPANT_PREFIX

unique string used as prefix for participant ids to ensure they can be identified at recovery

SUBORDINATE_TX_TYPE_AT_AT

public static final String SUBORDINATE_TX_TYPE_AT_AT

standard AT subordinate tx type for an AT subordinate created below another AT transaction

See Also:

Constant Field Values

Constructor Detail

SubordinateATCoordinator

public SubordinateATCoordinator()

normal constructor

SubordinateATCoordinator

public SubordinateATCoordinator(String subordinateType)

bridge wrapper constructor

SubordinateATCoordinator

public SubordinateATCoordinator(com.arjuna.ats.arjuna.common.Uid recovery)

constructor for recovered coordinator

Parameters:

recovery -

Method Detail

coordinate

public Outcome coordinate(CompletionStatus cs)
                   throws WrongStateException,
                          ProtocolViolationException,
                          SystemException

If the application requires and if the coordination protocol supports it, then this method can be used to execute a coordination protocol on the currently enlisted participants at any time prior to the termination of the coordination scope. This implementation only supports coordination at the end of the activity.

Overrides:

coordinate in class ATCoordinator

Parameters:

cs - The completion status to use when determining how to execute the protocol.

Returns:

The result of executing the protocol, or null.

Throws:

WrongStateException - Thrown if the coordinator is in a state the does not allow coordination to occur.

ProtocolViolationException - Thrown if the protocol is violated in some manner during execution.

SystemException - Thrown if any other error occurs.

end

public int end(boolean reportHeuristics)

Overrides:

end in class com.arjuna.ats.arjuna.coordinator.TwoPhaseCoordinator

cancel

public int cancel()

Specified by:

cancel in interface com.arjuna.ats.arjuna.coordinator.Reapable

Overrides:

cancel in class com.arjuna.ats.arjuna.coordinator.TwoPhaseCoordinator

prepareVolatile

public boolean prepareVolatile()

this is driven by a volatile participant registered on behalf of the coordinator

Returns:

true if the beforeCompletion succeeds otherwise false.

prepare

public int prepare()

this is driven by a durable participant registered on behalf of the coordinator and does a normal prepare mninus the before completion processing which has already been performed

Returns:

the result of preparing the transaction

commitVolatile

public void commitVolatile()

this is driven by a volatile participant registered on behalf of the coordinator

commit

public void commit()

this is driven by a durable participant registered on behalf of the coordinator and does a normal commit minus the after completion processing which will be driven by a volatile participant also registerd for this coordinator..

rollbackVolatile

public void rollbackVolatile()

this is driven by a volatile participant registered on behalf of the coordinator

rollback

public void rollback()

this is driven by a durable participant registered on behalf of the coordinator and does a normal commit minus the after completion processing which will be driven by a volatile participant also registerd for this coordinator..

unknown

public void unknown()

called by the durable participant during recovery processing TODO clarify when and why this gets called and what to do about it

error

public void error()

called by the durable participant during recovery processing TODO clarify when and why this gets called and what to do about it

type

public String type()

Overrides:

type in class ATCoordinator

getVolatile2PhaseId

public String getVolatile2PhaseId()

return a uid for the volatile participant registered on behalf of this corodinator

getDurable2PhaseId

public String getDurable2PhaseId()

return a uid for the durable participant registered on behalf of this corodinator

addRecoveredCoordinator

protected static void addRecoveredCoordinator(SubordinateATCoordinator coordinator)

removeRecoveredCoordinator

protected static void removeRecoveredCoordinator(SubordinateATCoordinator coordinator)

addActiveProxy

public static void addActiveProxy(String id)

removeActiveProxy

public static void removeActiveProxy(String id)

setActivated

protected void setActivated()

isActivated

public boolean isActivated()

isOrphaned

public boolean isOrphaned()

test whether a transaction has been restored without its proxy participant. this indicates that we crashed between preparing the suborindate TX and logging the proxy participant.

Returns:

whether the at is orphaned

getRecoveredCoordinator

public static SubordinateATCoordinator getRecoveredCoordinator(String coordinatorId)

listRecoveredCoordinators

public static SubordinateATCoordinator[] listRecoveredCoordinators()

getSubordinateType

public String getSubordinateType()

save_state

public boolean save_state(com.arjuna.ats.arjuna.state.OutputObjectState os,
                          int ot)

Overrides:

save_state in class com.arjuna.ats.arjuna.coordinator.BasicAction

restore_state

public boolean restore_state(com.arjuna.ats.arjuna.state.InputObjectState os,
                             int ot)

Overrides:

restore_state in class com.arjuna.ats.arjuna.coordinator.BasicAction

addCallback

public static void addCallback(String key,
                               SubordinateATCoordinator.SubordinateCallback callback)

register a callback to be called when a subordinate transaction with a specific key executes a commit or rollback. the callback will not be called in the case of a crash

Parameters:

key -

callback -