org.yawlfoundation.yawl.engine.interfce.interfaceX

Class InterfaceX_EngineSideClient

java.lang.Object

org.yawlfoundation.yawl.engine.interfce.Interface_Client

org.yawlfoundation.yawl.engine.interfce.interfaceX.InterfaceX_EngineSideClient

All Implemented Interfaces:

ExceptionGateway

public class InterfaceX_EngineSideClient
extends Interface_Client
implements ExceptionGateway

InterfaceX_EngineSideClient passes exception event calls from the engine to the exception service. This class is a member class of Interface X, which provides an interface between the YAWL Engine and a Custom YAWL Service that manages exception handling at the process level. InterfaceB_EngineBasedClient was used as a template for this class. Schematic of Interface X: | EXCEPTION | INTERFACE X GATEWAY | SERVICE (implements) | | (implements) | | | | +==========+ -----> ENGINE-SIDE ---|--> SERVICE-SIDE -----> +=============+ || YAWL || CLIENT | SERVER || EXCEPTION || || ENGINE || | || SERVICE || +==========+ <----- ENGINE-SIDE <--|--- SERVICE-SIDE <----- +=============+ SERVER | CLIENT |

Version:

0.8, 04/07/2006

Author:

Michael Adams |

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	NOTIFY_CANCELLED_CASE
protected static int	NOTIFY_CHECK_CASE_CONSTRAINTS
protected static int	NOTIFY_CHECK_ITEM_CONSTRAINTS
protected static int	NOTIFY_CONSTRAINT_VIOLATION
protected static int	NOTIFY_RESOURCE_UNAVAILABLE
protected static int	NOTIFY_TIMEOUT
protected static int	NOTIFY_WORKITEM_ABORT

Constructor Summary

Constructors

Constructor and Description
InterfaceX_EngineSideClient(java.lang.String observerURI)

Method Summary

Modifier and Type	Method and Description
void	announceCaseCancellation(java.lang.String caseID) Announced by the engine when a case has been cancelled
void	announceCheckCaseConstraints(YSpecificationID specID, java.lang.String caseID, java.lang.String data, boolean preCheck) Announced by the engine when a case begins or completes to allow for the checking of pre & post constraints.
void	announceCheckWorkItemConstraints(YWorkItem item, Document data, boolean preCheck) Announced by the engine when a new workitem gets enabled to allow for the checking of pre & post constraints.
void	announceConstraintViolation(YWorkItem item) FOR FUTURE IMPLEMENTATION
void	announceTimeOut(YWorkItem item, java.util.List taskList) Announced by the engine when a workitem has reached a deadline.
void	announceWorkitemAbort(YWorkItem item) Announced by the engine when a work item has been checked out and then declined (returned) by a service (before completion)
boolean	equals(java.lang.Object other)
java.lang.String	getScheme() Indicates which protocol this shim services
java.lang.String	getURI()
int	hashCode()
void	setURI(java.lang.String uri)
void	shutdown() Called when the Engine is shutdown (servlet destroyed); the listener should to do its own finalisation processing

Methods inherited from class org.yawlfoundation.yawl.engine.interfce.Interface_Client

executeGet, executePost, getReply, initPostConnection, prepareParamMap, send, setReadTimeout, stripOuterElement, successful

Methods inherited from class java.lang.Object

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

Field Detail

NOTIFY_CHECK_CASE_CONSTRAINTS

protected static final int NOTIFY_CHECK_CASE_CONSTRAINTS

See Also:

Constant Field Values

NOTIFY_CHECK_ITEM_CONSTRAINTS

protected static final int NOTIFY_CHECK_ITEM_CONSTRAINTS

See Also:

Constant Field Values

NOTIFY_WORKITEM_ABORT

protected static final int NOTIFY_WORKITEM_ABORT

See Also:

Constant Field Values

NOTIFY_TIMEOUT

protected static final int NOTIFY_TIMEOUT

See Also:

Constant Field Values

NOTIFY_RESOURCE_UNAVAILABLE

protected static final int NOTIFY_RESOURCE_UNAVAILABLE

See Also:

Constant Field Values

NOTIFY_CONSTRAINT_VIOLATION

protected static final int NOTIFY_CONSTRAINT_VIOLATION

See Also:

Constant Field Values

NOTIFY_CANCELLED_CASE

protected static final int NOTIFY_CANCELLED_CASE

See Also:

Constant Field Values

Constructor Detail

InterfaceX_EngineSideClient

public InterfaceX_EngineSideClient(java.lang.String observerURI)

Method Detail

getScheme

public java.lang.String getScheme()

Indicates which protocol this shim services

Specified by:

getScheme in interface ExceptionGateway

Returns:

the scheme

setURI

public void setURI(java.lang.String uri)

getURI

public java.lang.String getURI()

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

announceCheckWorkItemConstraints

public void announceCheckWorkItemConstraints(YWorkItem item,
                                             Document data,
                                             boolean preCheck)

Description copied from interface: ExceptionGateway

Announced by the engine when a new workitem gets enabled to allow for the checking of pre & post constraints.

Specified by:

announceCheckWorkItemConstraints in interface ExceptionGateway

Parameters:

item - - the enabled workitem

data - - the workitem's data

preCheck - - true if before item execution, false if after

announceCheckCaseConstraints

public void announceCheckCaseConstraints(YSpecificationID specID,
                                         java.lang.String caseID,
                                         java.lang.String data,
                                         boolean preCheck)

Description copied from interface: ExceptionGateway

Announced by the engine when a case begins or completes to allow for the checking of pre & post constraints.

Specified by:

announceCheckCaseConstraints in interface ExceptionGateway

Parameters:

specID - - the id of the specfication of which the case is an instance

caseID - - the id of the case

data - - the case's data

preCheck - - true if before item execution, false if after

announceWorkitemAbort

public void announceWorkitemAbort(YWorkItem item)

Description copied from interface: ExceptionGateway

Announced by the engine when a work item has been checked out and then declined (returned) by a service (before completion)

Specified by:

announceWorkitemAbort in interface ExceptionGateway

Parameters:

item - the aborted item

announceTimeOut

public void announceTimeOut(YWorkItem item,
                            java.util.List taskList)

Description copied from interface: ExceptionGateway

Announced by the engine when a workitem has reached a deadline.

Specified by:

announceTimeOut in interface ExceptionGateway

Parameters:

item - - the timed out workitem (associated with the timeService)

taskList - - a list of tasks running in parallel with the timedout workitem

announceConstraintViolation

public void announceConstraintViolation(YWorkItem item)

Description copied from interface: ExceptionGateway

FOR FUTURE IMPLEMENTATION

Specified by:

announceConstraintViolation in interface ExceptionGateway

announceCaseCancellation

public void announceCaseCancellation(java.lang.String caseID)

Description copied from interface: ExceptionGateway

Announced by the engine when a case has been cancelled

Specified by:

announceCaseCancellation in interface ExceptionGateway

Parameters:

caseID - - the cancelled case

shutdown

public void shutdown()

Called when the Engine is shutdown (servlet destroyed); the listener should to do its own finalisation processing

Specified by:

shutdown in interface ExceptionGateway