com.arjuna.mwlabs.wsas.activity

Class ActivityImple

java.lang.Object

com.arjuna.mwlabs.wsas.activity.ActivityImple

public class ActivityImple
extends Object

The Activity.

Since:

1.0.

Version:

$Id: ActivityImple.java,v 1.6 2005/05/19 12:13:18 nmcl Exp $

Author:

Mark Little (mark.little@arjuna.com)

Constructor Summary

Constructors

Constructor and Description
ActivityImple(ActivityImple parent, String serviceType)
ActivityImple(String coordinationType)

Method Summary

Modifier and Type	Method and Description
String	activityName() What is the name of the current activity? Use only for debugging purposes!
void	completionValid(CompletionStatus cs) Check whether the specified completion status is compatible with the one currently assigned to the activity.
Outcome	end() Complete the activity with the current completion status.
Outcome	end(CompletionStatus cs) Complete the activity with the completion status provided.
boolean	equals(Object obj)
CompletionStatus	getCompletionStatus() Get the completion status currently associated with the activity.
GlobalId	getGlobalId()
int	getTimeout() Get the timeout value currently associated with activities.
int	hashCode()
ActivityImple[]	hierarchy() Return the activity hierarchy that this activity is within.
ActivityImple	parent()
String	serviceType()
void	setCompletionStatus(CompletionStatus endStatus) Set the termination status for the current activity, if any.
void	start() Start a new activity.
void	start(int timeout) Start a new activity.
Status	status()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ActivityImple

public ActivityImple(String coordinationType)

ActivityImple

public ActivityImple(ActivityImple parent,
                     String serviceType)

Method Detail

start

public void start()
           throws WrongStateException,
                  SystemException

Start a new activity.

Throws:

WrongStateException - Thrown if the currently associated activity is in a state that does not allow a new activity to be enlisted as a child.

InvalidTimeoutException - Thrown if the specified timeout is invalid within the current working environment.

SystemException - Thrown in any other situation.

start

public void start(int timeout)
           throws WrongStateException,
                  InvalidTimeoutException,
                  SystemException

Start a new activity. If there is already an activity associated with the thread then it will be nested.

Parameters:

timeout - timeout The timeout associated with the activity. If the activity has not been terminated by the time this period elapses, then it will automatically be terminated.

Throws:

WrongStateException - Thrown if the currently associated activity is in a state that does not allow a new activity to be enlisted as a child.

InvalidTimeoutException - Thrown if the specified timeout is invalid within the current working environment.

SystemException - Thrown in any other situation.

end

public Outcome end()
            throws InvalidActivityException,
                   WrongStateException,
                   ProtocolViolationException,
                   NoPermissionException,
                   SystemException

Complete the activity with the current completion status.

Returns:

the result of completing the activity. Null is valid and must be interpreted within the context of any HLS that may exist.

Throws:

InvalidActivityException - Thrown if the current activity is not known about by the activity system.

WrongStateException - Thrown if the current activity is not in a state that allows it to be completed.

ProtocolViolationException - Thrown if the a violation of the activity service or HLS protocol occurs.

NoPermissionException - Thrown if the invoking thread does not have permission to terminate the transaction.

SystemException - Thrown if some other error occurred.

See Also:

com.arjuna.mw.wsas.Outcome

end

public Outcome end(CompletionStatus cs)
            throws InvalidActivityException,
                   WrongStateException,
                   ProtocolViolationException,
                   NoPermissionException,
                   SystemException

Complete the activity with the completion status provided.

Parameters:

cs - The CompletionStatus to use.

Returns:

the result of completing the activity. Null is valid and must be interpreted within the context of any HLS that may exist.

Throws:

InvalidActivityException - Thrown if the current activity is not known about by the activity system.

WrongStateException - Thrown if the current activity is not in a state that allows it to be completed, or is incompatible with the completion status provided.

ProtocolViolationException - Thrown if the a violation of the activity service or HLS protocol occurs.

NoPermissionException - Thrown if the invoking thread does not have permission to terminate the transaction.

SystemException - Thrown if some other error occurred.

See Also:

com.arjuna.mw.wsas.Outcome

setCompletionStatus

public void setCompletionStatus(CompletionStatus endStatus)
                         throws WrongStateException,
                                SystemException

Set the termination status for the current activity, if any.

Parameters:

CompletionStatus - endStatus The state in which the activity should attempt to terminate. This may be one of the default values provided by WSAS or may be extended in an implementation specific manner by an HLS.

Throws:

NoActivityException - Thrown if there is no activity associated with the invoking thread.

WrongStateException - Thrown if the completion status is incompatible with the current state of the activity.

SystemException - Thrown if any other error occurs.

getCompletionStatus

public CompletionStatus getCompletionStatus()
                                     throws SystemException

Get the completion status currently associated with the activity.

Returns:

the termination status for the current activity, if any.

Throws:

NoActivityException - Thrown if there is no activity associated with the current thread.

SystemException - Thrown if any other error occurs.

getTimeout

public int getTimeout()
               throws SystemException

Get the timeout value currently associated with activities.

Returns:

the timeout value in seconds, or 0 if no application specified timeout has been provided.

Throws:

SystemException - Thrown if any error occurs.

status

public Status status()
              throws SystemException

Returns:

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

Throws:

SystemException - Thrown if any error occurs.

See Also:

Status

activityName

public String activityName()
                    throws NoActivityException,
                           SystemException

What is the name of the current activity? Use only for debugging purposes!

Returns:

the name of the activity.

Throws:

NoActivityException - Thrown if there is no activity associated with the invoking thread.

SystemException - Thrown if any other error occurs.

toString

public String toString()

Overrides:

toString in class Object

getGlobalId

public GlobalId getGlobalId()

Returns:

the unique identifier for this activity.

parent

public ActivityImple parent()

Returns:

The parent of the activity, or null if it is top-level.

serviceType

public String serviceType()

Returns:

the type of the coordinator employed for this activity

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hierarchy

public ActivityImple[] hierarchy()

Return the activity hierarchy that this activity is within. The zeroth element is the parent.

completionValid

public final void completionValid(CompletionStatus cs)
                           throws WrongStateException

Check whether the specified completion status is compatible with the one currently assigned to the activity.

Parameters:

CompletionStatus - cs The completion status to check.

Throws:

WrongStateException - Thrown if the specified status is incompatible with that currently possessed by this activity.

hashCode

public int hashCode()

Overrides:

hashCode in class Object