org.yawlfoundation.yawl.worklet.exception

Class ExceptionService

java.lang.Object

org.yawlfoundation.yawl.worklet.exception.ExceptionService

public class ExceptionService
extends java.lang.Object

The ExceptionService class manages the handling of exceptions that may occur during the life of a case instance. It receives events from the engine via InterfaceX at various milestones for constraint checking, and when certain exceptional events occur. It runs exception handlers when required, which may involve the running of compensatory worklets. It derives from the WorkletService class and uses many of the same methods as those used in the worklet selection process.

Version:

0.8, 04-09/2006

Author:

Michael Adams

Constructor Summary

Constructors

Constructor and Description
ExceptionService(WorkletService workletService)

Method Summary

Modifier and Type	Method and Description
void	cleanseWorkletRunners(java.util.Set<WorkletRunner> toRemove)
void	completeInitialisation(boolean persisting)
java.util.List	getExternalTriggersForCase(java.lang.String caseID) retrieves a complete list of external exception triggers from the ruleset for the specified case
java.util.List<java.lang.String>	getExternalTriggersForItem(java.lang.String itemID)
java.util.Set<WorkletRunner>	getRunningWorklets()
YSpecificationID	getSpecIDForCaseID(java.lang.String caseID) returns the spec id for the specified case id
java.lang.String	getStatus(java.lang.String taskID) stub method called from RdrConditionFunctions class
WorkItemRecord	getWorkItemRecord(java.lang.String itemID) returns the specified wir for the id passed
void	handleCaseCancellationEvent(java.lang.String caseID) Handles a notification from the Engine that a case has been cancelled.
void	handleCheckCaseConstraintEvent(YSpecificationID specID, java.lang.String caseID, java.lang.String data, boolean preCheck) Handles a notification from the Engine that a case is either starting or has completed.
void	handleCheckWorkItemConstraintEvent(WorkItemRecord wir, java.lang.String data, boolean preCheck) Handles a notification from the Engine that a workitem is either starting or has completed.
java.lang.String	handleConstraintViolationException(WorkItemRecord wir, java.lang.String data)
void	handleResourceUnavailableException(java.lang.String resourceID, WorkItemRecord wir, java.lang.String caseData, boolean primary)
void	handleTimeoutEvent(WorkItemRecord wir, java.lang.String taskList) Handles a notification from the Engine that a workitem associated with the timeService has timed out.
java.lang.String	handleWorkItemAbortException(WorkItemRecord wir, java.lang.String data)
boolean	isWorkletCase(java.lang.String caseID) returns true if case specified is a worklet instance
protected void	raise(java.lang.String msg)
java.lang.String	raiseException(WorkItemRecord wir, RuleType ruleType, RdrConclusion conclusion) Raises an exception (triggered via the API) using the conclusion passed in
void	raiseExternalException(java.lang.String level, java.lang.String id, java.lang.String trigger) Raise an externally triggered exception
java.lang.String	replaceWorklet(RuleType xType, java.lang.String caseID, java.lang.String itemID) Replaces a running worklet case with another worklet case after an amendment to the ruleset for this exception.
java.util.Set<WorkItemRecord>	suspendCase(java.lang.String caseID)
boolean	suspendWorkItem(java.lang.String itemID)

Methods inherited from class java.lang.Object

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

Constructor Detail

ExceptionService

public ExceptionService(WorkletService workletService)

Method Detail

completeInitialisation

public void completeInitialisation(boolean persisting)

handleCaseCancellationEvent

public void handleCaseCancellationEvent(java.lang.String caseID)

Handles a notification from the Engine that a case has been cancelled. If the case passed has any exception handling worklets running for it, they are also cancelled.

Parameters:

caseID - the case cancelled by the Engine

handleCheckWorkItemConstraintEvent

public void handleCheckWorkItemConstraintEvent(WorkItemRecord wir,
                                               java.lang.String data,
                                               boolean preCheck)

Handles a notification from the Engine that a workitem is either starting or has completed. Checks the rules for the workitem, and evaluates any pre-constraints or post-constraints (if any), and if a constraint has been violated, raises the appropriate exception.

Parameters:

wir - the workitem that triggered the event

data - the current case data (i.e. immediately prior to item start or after item completion)

preCheck - true for pre-constraints, false for post-constraints

handleCheckCaseConstraintEvent

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

Handles a notification from the Engine that a case is either starting or has completed. Checks the rules for the case and evaluates any pre-constraints or post-constraints (if any), and if a constraint has been violated, raises the appropriate exception.

Parameters:

specID - specification id of the case

caseID - the id for the case

data - the case-level data params

preCheck - true for pre-constraints, false for post-constraints

handleTimeoutEvent

public void handleTimeoutEvent(WorkItemRecord wir,
                               java.lang.String taskList)

Handles a notification from the Engine that a workitem associated with the timeService has timed out. Checks the rules for timeout for the other items associated with this timeout item and raises thr appropriate exception.

Parameters:

wir - - the item that caused the timeout event

taskList - - a list of taskids of those tasks that were running in parallel with the timeout task

handleResourceUnavailableException

public void handleResourceUnavailableException(java.lang.String resourceID,
                                               WorkItemRecord wir,
                                               java.lang.String caseData,
                                               boolean primary)

handleWorkItemAbortException

public java.lang.String handleWorkItemAbortException(WorkItemRecord wir,
                                                     java.lang.String data)

handleConstraintViolationException

public java.lang.String handleConstraintViolationException(WorkItemRecord wir,
                                                           java.lang.String data)

suspendWorkItem

public boolean suspendWorkItem(java.lang.String itemID)

suspendCase

public java.util.Set<WorkItemRecord> suspendCase(java.lang.String caseID)

getRunningWorklets

public java.util.Set<WorkletRunner> getRunningWorklets()

getExternalTriggersForItem

public java.util.List<java.lang.String> getExternalTriggersForItem(java.lang.String itemID)

cleanseWorkletRunners

public void cleanseWorkletRunners(java.util.Set<WorkletRunner> toRemove)

getWorkItemRecord

public WorkItemRecord getWorkItemRecord(java.lang.String itemID)

returns the specified wir for the id passed

getSpecIDForCaseID

public YSpecificationID getSpecIDForCaseID(java.lang.String caseID)

returns the spec id for the specified case id

getExternalTriggersForCase

public java.util.List getExternalTriggersForCase(java.lang.String caseID)

retrieves a complete list of external exception triggers from the ruleset for the specified case

Parameters:

caseID - - the id of the case to get the triggers for

Returns:

the (String) list of triggers

raiseExternalException

public void raiseExternalException(java.lang.String level,
                                   java.lang.String id,
                                   java.lang.String trigger)

Raise an externally triggered exception

Parameters:

level - - the level of the exception (case/item)

id - - the id of the case or item on which the exception is being raised

trigger - - the identifier of (or reason for) the external exception

raiseException

public java.lang.String raiseException(WorkItemRecord wir,
                                       RuleType ruleType,
                                       RdrConclusion conclusion)

Raises an exception (triggered via the API) using the conclusion passed in

Parameters:

wir - the wir to raise the exception for

ruleType - the exception rule type

conclusion - a populated conclusion object

replaceWorklet

public java.lang.String replaceWorklet(RuleType xType,
                                       java.lang.String caseID,
                                       java.lang.String itemID)
                                throws java.io.IOException

Replaces a running worklet case with another worklet case after an amendment to the ruleset for this exception. Called by WorkletGateway after a call from the Editor that the ruleset has been updated. Overrides the WorkletService equivalent - This one looks after exceptions, that one looks after selections

Parameters:

xType - - the type of exception that launched the worklet

caseID - - the id of the original checked out case

itemID - - the id of the original checked out workitem

Returns:

a string of messages describing the success or otherwise of the process

Throws:

java.io.IOException

isWorkletCase

public boolean isWorkletCase(java.lang.String caseID)

returns true if case specified is a worklet instance

getStatus

public java.lang.String getStatus(java.lang.String taskID)

stub method called from RdrConditionFunctions class

raise

protected void raise(java.lang.String msg)
              throws java.io.IOException

Throws:

java.io.IOException