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

Class ATCoordinator

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

All Implemented Interfaces:

com.arjuna.ats.arjuna.coordinator.Reapable

Direct Known Subclasses:

RecoveryATCoordinator, SubordinateATCoordinator

public class ATCoordinator
extends com.arjuna.ats.arjuna.coordinator.TwoPhaseCoordinator

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.

Since:

1.0.

Version:

$Id: ACCoordinator.java,v 1.7 2005/06/09 09:41:27 nmcl Exp $

Author:

Mark Little (mark.little@arjuna.com)

Field Summary

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

Constructor and Description
ATCoordinator()
ATCoordinator(com.arjuna.ats.arjuna.common.Uid recovery)

Method Summary

Methods

Modifier and Type	Method and Description
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.
void	delistParticipant(Participant act) Remove the specified participant from the coordinator's list.
void	delistSynchronization(Synchronization act) Remove the specified synchronization from the coordinator's list.
void	enlistParticipant(Participant act) Enrol the specified participant with the coordinator associated with the current thread.
void	enlistSynchronization(Synchronization act) Enrol the specified synchronization with the coordinator associated with the current thread.
CoordinatorId	identifier()
void	participantReadOnly(String participantId)
void	participantRolledBack(String participantId)
Qualifier[]	qualifiers()
String	type()

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

addSynchronization, afterCompletion, afterCompletion, beforeCompletion, cancel, end, getDeferredThrowable, getSynchronizations, 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, equals, finalizeInternal, forgetHeuristics, getDeferredThrowables, 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, toString, typeOfAction, updateHeuristic, updateState

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

cleanup, 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

Constructor Detail

ATCoordinator

public ATCoordinator()

ATCoordinator

public ATCoordinator(com.arjuna.ats.arjuna.common.Uid 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.

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.

enlistParticipant

public void enlistParticipant(Participant act)
                       throws WrongStateException,
                              DuplicateParticipantException,
                              InvalidParticipantException,
                              SystemException

Enrol the specified participant with the coordinator associated with the current thread.

Parameters:

act - The participant.

Throws:

WrongStateException - Thrown if the coordinator is not in a state that allows participants to be enrolled.

DuplicateParticipantException - Thrown if the participant has already been enrolled and the coordination protocol does not support multiple entries.

InvalidParticipantException - Thrown if the participant is invalid.

SystemException - Thrown if any other error occurs.

delistParticipant

public void delistParticipant(Participant act)
                       throws InvalidParticipantException,
                              WrongStateException,
                              SystemException

Remove the specified participant from the coordinator's list.

Throws:

InvalidParticipantException - Thrown if the participant is not known of by the coordinator.

WrongStateException - Thrown if the state of the coordinator does not allow the participant to be removed (e.g., in a two-phase protocol the coordinator is committing.)

SystemException - Thrown if any other error occurs.

enlistSynchronization

public void enlistSynchronization(Synchronization act)
                           throws WrongStateException,
                                  DuplicateSynchronizationException,
                                  InvalidSynchronizationException,
                                  SystemException

Enrol the specified synchronization with the coordinator associated with the current thread.

Parameters:

act - The synchronization to add.

Throws:

WrongStateException - Thrown if the coordinator is not in a state that allows participants to be enrolled.

DuplicateSynchronizationException - Thrown if the participant has already been enrolled and the coordination protocol does not support multiple entries.

InvalidSynchronizationException - Thrown if the participant is invalid.

SystemException - Thrown if any other error occurs.

delistSynchronization

public void delistSynchronization(Synchronization act)
                           throws InvalidSynchronizationException,
                                  WrongStateException,
                                  SystemException

Remove the specified synchronization from the coordinator's list.

Throws:

InvalidSynchronizationException - Thrown if the participant is not known of by the coordinator.

WrongStateException - Thrown if the state of the coordinator does not allow the participant to be removed (e.g., in a two-phase protocol the coordinator is committing.)

SystemException - Thrown if any other error occurs.

qualifiers

public Qualifier[] qualifiers()
                       throws SystemException

Returns:

the complete list of qualifiers that have been registered with the current coordinator.

Throws:

SystemException - Thrown if any error occurs.

identifier

public CoordinatorId identifier()
                         throws SystemException

Returns:

The unique identity of the current coordinator.

Throws:

SystemException - Thrown if any error occurs.

participantRolledBack

public void participantRolledBack(String participantId)
                           throws InvalidParticipantException,
                                  WrongStateException,
                                  SystemException

Throws:

InvalidParticipantException

WrongStateException

SystemException

participantReadOnly

public void participantReadOnly(String participantId)
                         throws InvalidParticipantException,
                                SystemException

Throws:

InvalidParticipantException

SystemException

type

public String type()

Overrides:

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