com.arjuna.mw.wscf.api

Interface UserCoordinatorService

public interface UserCoordinatorService

This interface defines the operations that implementations of coordination protocols must provide. The basic interface does not imply any specific coordination protocol.

Since:

1.0.

Version:

$Id: UserCoordinatorService.java,v 1.2 2005/05/19 12:13:20 nmcl Exp $

Author:

Mark Little (mark.little@arjuna.com)

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.
CoordinatorId	identifier()
Qualifier[]	qualifiers()
Status	status()

Method Detail

status

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

coordinate

Outcome coordinate(CompletionStatus cs)
                   throws WrongStateException,
                          ProtocolViolationException,
                          NoCoordinatorException,
                          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.

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.

NoCoordinatorException

qualifiers

Qualifier[] qualifiers()
                       throws NoCoordinatorException,
                              SystemException

Returns:

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

Throws:

SystemException - Thrown if any error occurs.

NoCoordinatorException

identifier

CoordinatorId identifier()
                         throws NoCoordinatorException,
                                SystemException

Returns:

The unique identity of the current coordinator.

Throws:

SystemException - Thrown if any error occurs.

NoCoordinatorException