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

java.lang.Object
  extended by org.yawlfoundation.yawl.engine.interfce.Interface_Client
      extended by 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
protected static org.apache.log4j.Logger logger
           
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
InterfaceX_EngineSideClient(String observerURI)
           
 
Method Summary
 void announceCaseCancellation(String caseID)
          Announced by the engine when a case has been cancelled
 void announceCheckCaseConstraints(YSpecificationID specID, String caseID, 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, org.jdom.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)
           
 void announceTimeOut(YWorkItem item, List taskList)
          Announced by the engine when a workitem has reached a deadline.
 void announceWorkitemAbort(YWorkItem item)
          FOR FUTURE IMPLEMENTATION
 boolean equals(Object other)
           
 String getScheme()
          Indicates which protocol this shim services
 String getURI()
           
 int hashCode()
           
 void setURI(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, prepareParamMap, setReadTimeout, stripOuterElement, successful
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

logger

protected static org.apache.log4j.Logger logger

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(String observerURI)
Method Detail

getScheme

public String getScheme()
Indicates which protocol this shim services

Specified by:
getScheme in interface ExceptionGateway
Returns:
the scheme

setURI

public void setURI(String uri)

getURI

public String getURI()

equals

public boolean equals(Object other)
Overrides:
equals in class Object

hashCode

public int hashCode()
Overrides:
hashCode in class Object

announceCheckWorkItemConstraints

public void announceCheckWorkItemConstraints(YWorkItem item,
                                             org.jdom.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,
                                         String caseID,
                                         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
FOR FUTURE IMPLEMENTATION

Specified by:
announceWorkitemAbort in interface ExceptionGateway

announceTimeOut

public void announceTimeOut(YWorkItem item,
                            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)
Specified by:
announceConstraintViolation in interface ExceptionGateway

announceCaseCancellation

public void announceCaseCancellation(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


Copyright © 2004-2012 The YAWL Foundation.