com.arjuna.mwlabs.wscf.model.sagas.arjunacore

Class CoordinatorControl

java.lang.Object

com.arjuna.mwlabs.wscf.model.sagas.arjunacore.CoordinatorControl

public class CoordinatorControl
extends Object

The ArjunaCore coordination service implementation.

Since:

1.0.

Version:

$Id: CoordinatorControl.java,v 1.5 2005/05/19 12:13:37 nmcl Exp $

Author:

Mark Little (mark.little@arjuna.com)

Constructor Summary

Constructors

Constructor and Description
CoordinatorControl()

Method Summary

Modifier and Type	Method and Description
void	begin() An activity has begun and is active on the current thread.
void	complete() The current activity is completing and informs the participants that all work they need to know about has been received.
Outcome	complete(CompletionStatus cs) The current activity is completing with the specified completion status.
void	completed() The activity has completed and is no longer active on the current thread.
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.
BACoordinator	createSubordinate() Create a subordinate transaction, i.e., one which can be driven through complete, close and cancel.
BACoordinator	currentCoordinator()
void	delistParticipant(String participantId) Remove the specified participant from the coordinator's list.
void	enlistParticipant(Participant act) Enrol the specified participant with the coordinator associated with the current thread.
CoordinatorId	identifier()
void	participantCannotComplete(String participantId)
void	participantCompleted(String participantId)
void	participantFaulted(String participantId)
Qualifier[]	qualifiers() Not supported by basic ArjunaCore.
void	resume() The activity has been resumed on the current thread.
Status	status()
void	suspend() The activity has been suspended.

Methods inherited from class java.lang.Object

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

Constructor Detail

CoordinatorControl

public CoordinatorControl()

Method Detail

begin

public void begin()
           throws SystemException

An activity has begun and is active on the current thread.

Throws:

SystemException

complete

public Outcome complete(CompletionStatus cs)
                 throws SystemException

The current activity is completing with the specified completion status.

Parameters:

cs - The completion status to use.

Returns:

The result of terminating the relationship of this HLS and the current activity.

Throws:

SystemException

complete

public void complete()
              throws WrongStateException,
                     SystemException

The current activity is completing and informs the participants that all work they need to know about has been received.

Throws:

WrongStateException

SystemException

suspend

public void suspend()
             throws SystemException

The activity has been suspended.

Throws:

SystemException

resume

public void resume()
            throws SystemException

The activity has been resumed on the current thread.

Throws:

SystemException

completed

public void completed()
               throws SystemException

The activity has completed and is no longer active on the current thread.

Throws:

SystemException

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.

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.

status

public Status status()
              throws SystemException

Returns:

the status of the current coordinator. If there is no activity associated with the thread then NoActivity will be returned.

Throws:

SystemException - Thrown if any error occurs.

See Also:

Status

qualifiers

public Qualifier[] qualifiers()
                       throws NoCoordinatorException,
                              SystemException

Not supported by basic ArjunaCore.

Returns:

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

Throws:

SystemException - Thrown if any error occurs.

NoCoordinatorException

identifier

public CoordinatorId identifier()
                         throws NoCoordinatorException,
                                SystemException

Returns:

The unique identity of the current coordinator.

Throws:

SystemException - Thrown if any error occurs.

NoCoordinatorException

enlistParticipant

public void enlistParticipant(Participant act)
                       throws WrongStateException,
                              DuplicateParticipantException,
                              InvalidParticipantException,
                              NoCoordinatorException,
                              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.

NoCoordinatorException

delistParticipant

public void delistParticipant(String participantId)
                       throws InvalidParticipantException,
                              NoCoordinatorException,
                              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.

NoCoordinatorException

participantCompleted

public void participantCompleted(String participantId)
                          throws NoActivityException,
                                 InvalidParticipantException,
                                 WrongStateException,
                                 SystemException

Throws:

NoActivityException

InvalidParticipantException

WrongStateException

SystemException

participantFaulted

public void participantFaulted(String participantId)
                        throws NoActivityException,
                               InvalidParticipantException,
                               SystemException

Throws:

NoActivityException

InvalidParticipantException

SystemException

participantCannotComplete

public void participantCannotComplete(String participantId)
                               throws NoActivityException,
                                      InvalidParticipantException,
                                      WrongStateException,
                                      SystemException

Throws:

NoActivityException

InvalidParticipantException

WrongStateException

SystemException

createSubordinate

public final BACoordinator createSubordinate()
                                      throws SystemException

Create a subordinate transaction, i.e., one which can be driven through complete, close and cancel. Such a transaction is not interposed with any parent transaction because the parent may be physically remote from the child. Such interposition is the responsibility of the invoker.

Returns:

the subordinate transaction. The transaction is not associated with the thread and is not interposed. It is running.

Throws:

SystemException - throw if any error occurs.

currentCoordinator

public final BACoordinator currentCoordinator()
                                       throws NoCoordinatorException,
                                              SystemException

Throws:

NoCoordinatorException

SystemException