com.atomikos.icatch.imp

Class CoordinatorImp

java.lang.Object

com.atomikos.icatch.imp.CoordinatorImp

All Implemented Interfaces:

FSMEnterEventSource, FSMEnterListener, FSMTransitionListener, Stateful, CompositeCoordinator, Participant, RecoveryCoordinator, RecoverableCoordinator, AlarmTimerListener, EventListener

public class CoordinatorImp
extends Object
implements CompositeCoordinator, Participant, RecoveryCoordinator, RecoverableCoordinator, AlarmTimerListener, Stateful, FSMEnterListener, FSMTransitionListener

All things related to termination logic.

Field Summary

Fields inherited from interface com.atomikos.icatch.Participant

READ_ONLY

Constructor Summary

Constructors

Modifier	Constructor and Description
	CoordinatorImp() No argument constructor as required by Recoverable interface.
protected	CoordinatorImp(String root) Constructor for testing only.
protected	CoordinatorImp(String recoveryDomainName, String coordinatorId, String root, RecoveryCoordinator coord, long timeout, boolean single_threaded_2pc) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addFSMEnterListener(FSMEnterListener l, TxState state) Add an enter event listener.
void	alarm(AlarmTimer timer)
void	beforeTransition(FSMTransitionEvent e) A method to be called BEFORE the specified transition takes place.
void	commit(boolean onePhase)
protected void	dispose()
void	entered(FSMEnterEvent e) Called when the FSM has entered a new state.
void	forget()
String	getCoordinatorId()
Participant	getParticipant()
Vector<Participant>	getParticipants()
PendingTransactionRecord	getPendingTransactionRecord(TxState state)
RecoveryCoordinator	getRecoveryCoordinator()
String	getRecoveryDomainName()
String	getResourceName()
String	getRootId()
TxState	getState()
TxState	getStateWithTwoPhaseCommitDecision()
protected long	getTimeOut()
String	getURI()
boolean	hasActiveSiblings()
protected void	incLocalSiblingsStarted() Called when a tx import is being done.
protected void	incLocalSiblingsTerminated()
boolean	isCommitted() Tests if the transaction was committed or not.
boolean	isRoot()
void	preEnter(FSMEnterEvent event) Called BEFORE the FSM enters the new state, so that the callee is sure that nobody has seen the new state yet.
int	prepare()
Boolean	replayCompletion(Participant participant)
void	rollback()
void	setCascadeList(Map<String,Integer> allParticipants)
void	setGlobalSiblingCount(int count)
protected void	terminate(boolean commit) Terminate the work, on behalf of Terminator.
void	timedout(boolean rollbackOnly)
void	transitionPerformed(FSMTransitionEvent e) A method to be called AFTER the specified transition is done.

Methods inherited from class java.lang.Object

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

Constructor Detail

CoordinatorImp

protected CoordinatorImp(String root)

Constructor for testing only.

CoordinatorImp

protected CoordinatorImp(String recoveryDomainName,
                         String coordinatorId,
                         String root,
                         RecoveryCoordinator coord,
                         long timeout,
                         boolean single_threaded_2pc)

Constructor.

Parameters:

recoveryDomainName -

coordinatorId -

root - The root tid.

coord - The RecoverCoordinator, null if root.

console - The console to log to, or null if none.

timeout - The timeout in milliseconds for indoubts before a heuristic decision is made.

single_threaded_2pc - If true then commit is done in the same thread as the one that started the tx.

CoordinatorImp

public CoordinatorImp()

No argument constructor as required by Recoverable interface.

Method Detail

getParticipants

public Vector<Participant> getParticipants()

isCommitted

public boolean isCommitted()

Tests if the transaction was committed or not.

Returns:

boolean True iff committed.

getTimeOut

protected long getTimeOut()

getState

public TxState getState()

Specified by:

getState in interface Stateful

Returns:

The object representing the state.

See Also:

Stateful

addFSMEnterListener

public void addFSMEnterListener(FSMEnterListener l,
                                TxState state)

Description copied from interface: FSMEnterEventSource

Add an enter event listener.

Specified by:

addFSMEnterListener in interface FSMEnterEventSource

Parameters:

l - The listener.

state - The state to listen on.

See Also:

FSMEnterEventSource.

getRecoveryCoordinator

public RecoveryCoordinator getRecoveryCoordinator()

Specified by:

getRecoveryCoordinator in interface CompositeCoordinator

See Also:

CompositeCoordinator.

getParticipant

public Participant getParticipant()
                           throws UnsupportedOperationException

Throws:

UnsupportedOperationException

See Also:

CompositeCoordinator.

getCoordinatorId

public String getCoordinatorId()

Specified by:

getCoordinatorId in interface CompositeCoordinator

See Also:

CompositeCoordinator

incLocalSiblingsStarted

protected void incLocalSiblingsStarted()

Called when a tx import is being done.

incLocalSiblingsTerminated

protected void incLocalSiblingsTerminated()
                                   throws HeurRollbackException,
                                          HeurMixedException,
                                          SysException,
                                          SecurityException,
                                          HeurCommitException,
                                          HeurHazardException,
                                          IllegalStateException,
                                          RollbackException

Throws:

HeurRollbackException

HeurMixedException

SysException

SecurityException

HeurCommitException

HeurHazardException

IllegalStateException

RollbackException

hasActiveSiblings

public boolean hasActiveSiblings()

preEnter

public void preEnter(FSMEnterEvent event)
              throws IllegalStateException

Description copied from interface: FSMEnterListener

Called BEFORE the FSM enters the new state, so that the callee is sure that nobody has seen the new state yet.

Specified by:

preEnter in interface FSMEnterListener

Throws:

IllegalStateException - on failure. The callee can use this to prevent the state change from happening.

See Also:

FSMEnterListener.

getURI

public String getURI()

Specified by:

getURI in interface Participant

Specified by:

getURI in interface RecoveryCoordinator

See Also:

Participant

forget

public void forget()

Specified by:

forget in interface Participant

See Also:

Participant.

setCascadeList

public void setCascadeList(Map<String,Integer> allParticipants)
                    throws SysException

Specified by:

setCascadeList in interface Participant

Throws:

SysException

See Also:

Participant.

setGlobalSiblingCount

public void setGlobalSiblingCount(int count)

Specified by:

setGlobalSiblingCount in interface Participant

See Also:

Participant.

prepare

public int prepare()
            throws RollbackException,
                   IllegalStateException,
                   HeurHazardException,
                   HeurMixedException,
                   SysException

Specified by:

prepare in interface Participant

Throws:

RollbackException

IllegalStateException

HeurHazardException

HeurMixedException

SysException

See Also:

Participant.

commit

public void commit(boolean onePhase)
            throws HeurRollbackException,
                   HeurMixedException,
                   HeurHazardException,
                   IllegalStateException,
                   RollbackException,
                   SysException

Specified by:

commit in interface Participant

Throws:

HeurRollbackException

HeurMixedException

HeurHazardException

IllegalStateException

RollbackException

SysException

See Also:

Participant.

rollback

public void rollback()
              throws HeurCommitException,
                     HeurMixedException,
                     SysException,
                     HeurHazardException,
                     IllegalStateException

Specified by:

rollback in interface Participant

Throws:

HeurCommitException

HeurMixedException

SysException

HeurHazardException

IllegalStateException

See Also:

Participant.

replayCompletion

public Boolean replayCompletion(Participant participant)
                         throws IllegalStateException

Throws:

IllegalStateException

See Also:

RecoveryCoordinator.

alarm

public void alarm(AlarmTimer timer)

Specified by:

alarm in interface AlarmTimerListener

dispose

protected void dispose()

terminate

protected void terminate(boolean commit)
                  throws HeurRollbackException,
                         HeurMixedException,
                         SysException,
                         SecurityException,
                         HeurCommitException,
                         HeurHazardException,
                         RollbackException,
                         IllegalStateException

Terminate the work, on behalf of Terminator.

Parameters:

commit - True iff commit termination is asked.

Throws:

HeurRollbackException

HeurMixedException

SysException

SecurityException

HeurCommitException

HeurHazardException

RollbackException

IllegalStateException

getStateWithTwoPhaseCommitDecision

public TxState getStateWithTwoPhaseCommitDecision()

transitionPerformed

public void transitionPerformed(FSMTransitionEvent e)

Description copied from interface: FSMTransitionListener

A method to be called AFTER the specified transition is done.

Specified by:

transitionPerformed in interface FSMTransitionListener

Parameters:

e - The transition that was made.

getPendingTransactionRecord

public PendingTransactionRecord getPendingTransactionRecord(TxState state)

Specified by:

getPendingTransactionRecord in interface RecoverableCoordinator

getResourceName

public String getResourceName()

Specified by:

getResourceName in interface Participant

getRootId

public String getRootId()

Specified by:

getRootId in interface CompositeCoordinator

timedout

public void timedout(boolean rollbackOnly)

isRoot

public boolean isRoot()

getRecoveryDomainName

public String getRecoveryDomainName()

Specified by:

getRecoveryDomainName in interface RecoveryCoordinator

beforeTransition

public void beforeTransition(FSMTransitionEvent e)
                      throws IllegalStateException

Description copied from interface: FSMTransitionListener

A method to be called BEFORE the specified transition takes place. Since the transition still has to happen, no listener can be sure that the event notification eventually leads to the transition. This is because the state machine process can fail after the notice, or the target state can be prevented somehow.

Specified by:

beforeTransition in interface FSMTransitionListener

Parameters:

e - The transition that will be attempted.

Throws:

IllegalStateException - on failure.

entered

public void entered(FSMEnterEvent e)

Description copied from interface: FSMEnterListener

Called when the FSM has entered a new state.

Specified by:

entered in interface FSMEnterListener