com.arjuna.mwlabs.wscf11.model.twophase.arjunacore

Class TwoPhaseHLSImple

java.lang.Object

com.arjuna.mwlabs.wscf11.model.twophase.arjunacore.TwoPhaseHLSImple

All Implemented Interfaces:

HLS, UserCoordinatorService, TwoPhaseHLS

public class TwoPhaseHLSImple
extends Object
implements TwoPhaseHLS, UserCoordinatorService

The ArjunaCore coordination service implementation.

Since:

1.0.

Version:

$Id: TwoPhaseHLSImple.java,v 1.6.4.1 2005/11/22 10:34:18 kconner Exp $

Author:

Mark Little (mark.little@arjuna.com)

Field Summary

Fields

Modifier and Type	Field and Description
static String	coordinationType
static String	serviceType

Constructor Summary

Constructors

Constructor and Description
TwoPhaseHLSImple()

Method Summary

Modifier and Type	Method and Description
void	begun() An activity has begun and is active on the current thread.
static String	className()
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.
Context	context() Return the context augmentation for this HLS, if any on the current activity.
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.
CoordinatorManager	coordinatorManager()
UserCoordinatorService	coordinatorService()
CoordinatorId	identifier()
String	identity() The HLS name.
int	priority() The activity service maintains a priority ordered list of HLS implementations.
Qualifier[]	qualifiers() Not supported by basic ArjunaCore.
void	resumed() The activity has been resumed on the current thread.
Status	status()
void	suspended() The activity has been suspended.
UserCoordinator	userCoordinator()

Methods inherited from class java.lang.Object

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

Field Detail

serviceType

public static final String serviceType

See Also:

Constant Field Values

coordinationType

public static final String coordinationType

See Also:

Constant Field Values

Constructor Detail

TwoPhaseHLSImple

public TwoPhaseHLSImple()

Method Detail

coordinatorService

public UserCoordinatorService coordinatorService()

Specified by:

coordinatorService in interface TwoPhaseHLS

userCoordinator

public UserCoordinator userCoordinator()

Specified by:

userCoordinator in interface TwoPhaseHLS

coordinatorManager

public CoordinatorManager coordinatorManager()

Specified by:

coordinatorManager in interface TwoPhaseHLS

begun

public void begun()
           throws SystemException

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

Specified by:

begun in interface HLS

Throws:

SystemException - Thrown if an error occurs. Any error will cause the activity to be failed.

complete

public Outcome complete(CompletionStatus cs)
                 throws SystemException

The current activity is completing with the specified completion status.

Specified by:

complete in interface HLS

Parameters:

cs - The completion status to use.

Returns:

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

Throws:

SystemException - Thrown if an error occurs. Any error will cause the activity to be failed.

suspended

public void suspended()
               throws SystemException

The activity has been suspended.

Specified by:

suspended in interface HLS

Throws:

SystemException

resumed

public void resumed()
             throws SystemException

The activity has been resumed on the current thread.

Specified by:

resumed in interface HLS

Throws:

SystemException

completed

public void completed()
               throws SystemException

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

Specified by:

completed in interface HLS

Throws:

SystemException

identity

public String identity()
                throws SystemException

The HLS name.

Specified by:

identity in interface HLS

Throws:

SystemException

priority

public int priority()
             throws SystemException

The activity service maintains a priority ordered list of HLS implementations. If an HLS wishes to be ordered based on priority then it can return a non-negative value: the higher the value, the higher the priority and hence the earlier in the list of HLSes it will appear (and be used in).

Specified by:

priority in interface HLS

Returns:

a positive value for the priority for this HLS, or zero/negative if the order is not important.

Throws:

SystemException

context

public Context context()
                throws SystemException

Return the context augmentation for this HLS, if any on the current activity.

Specified by:

context in interface HLS

Returns:

a context object or null if no augmentation is necessary.

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.

Specified by:

coordinate in interface UserCoordinatorService

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

Specified by:

status in interface UserCoordinatorService

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.

Specified by:

qualifiers in interface UserCoordinatorService

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

Specified by:

identifier in interface UserCoordinatorService

Returns:

The unique identity of the current coordinator.

Throws:

SystemException - Thrown if any error occurs.

NoCoordinatorException

className

public static String className()