org.yawlfoundation.yawl.worklet

Class WorkletService

java.lang.Object

org.yawlfoundation.yawl.engine.interfce.interfaceB.InterfaceBWebsideController

org.yawlfoundation.yawl.worklet.WorkletService

All Implemented Interfaces:

InterfaceX_Service

public class WorkletService
extends InterfaceBWebsideController
implements InterfaceX_Service

This class and its support classes represent an implementation for YAWL of the Worklet paradigm.

The WorkletService class is the main class for the selection and exception handling processes. For selection, it receives an enabled workitem from the engine and attempts to substitute it with a worklet.

Version:

0.8, 09/10/2006

Author:

Michael Adams

Field Summary

Fields

Modifier and Type	Field and Description
protected EngineClient	_engineClient
protected EnabledEventQueue	_eventQueue
protected WorkletLoader	_loader
protected boolean	_persisting
protected RdrEvaluator	_rdr
protected RunnerMap	_runners

Fields inherited from class org.yawlfoundation.yawl.engine.interfce.interfaceB.InterfaceBWebsideController

_ibCache, _interfaceBClient, _logger, _report, engineLogonName, engineLogonPassword, XSD_ANYURI_TYPE, XSD_NAMESPACE, XSD_NCNAME_TYPE, XSD_STRINGTYPE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WorkletService() the constructor

Method Summary

Modifier and Type	Method and Description
protected boolean	cancelWorkletSet(java.util.Set<WorkletRunner> runnerSet) Cancels each of the worklets listed in the wr as running
void	completeInitialisation() completes the initialisation of the service load-up (mainly persistence) called from servlet WorkletGateway after contexts are loaded
void	doGet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) displays a web page describing the service
java.util.Map<java.lang.String,WorkletRunner>	getAllRunners()
EngineClient	getEngineClient()
EnabledEventQueue	getEventQueue()
ExceptionService	getExceptionService()
java.lang.String	getExternalServiceHandle(CostGatewayClient costClient)
static WorkletService	getInstance()
WorkletLoader	getLoader()
RdrEvaluator	getRdrEvaluator()
Rdr	getRdrInterface()
java.lang.String	getResourceServiceURL()
java.lang.String	getRunnerCaseIdList(java.util.Set<WorkletRunner> runners)
WorkletEventServer	getServer()
void	handleCancelledCaseEvent(java.lang.String caseID) Receives notification from the engine that an active case has been cancelled.
void	handleCancelledWorkItemEvent(WorkItemRecord wir) Handles a message from the engine that a workitem has been cancelled (see InterfaceBWebsideController for more details) In this case, it cancels any worklet(s) running in place of the workitem.
void	handleCaseCancellationEvent(java.lang.String caseID)
void	handleCheckCaseConstraintEvent(YSpecificationID specID, java.lang.String caseID, java.lang.String data, boolean precheck)
void	handleCheckWorkItemConstraintEvent(WorkItemRecord wir, java.lang.String data, boolean precheck)
void	handleCompleteCaseEvent(java.lang.String caseID, java.lang.String casedata) Handles a message from the engine that a (worklet) case has completed (see InterfaceBWebsideController for more details).
java.lang.String	handleConstraintViolationException(WorkItemRecord wir, java.lang.String caseData)
void	handleEnabledWorkItemEvent(WorkItemRecord workItemRecord) Handles a message from the engine that a workitem has been enabled (see InterfaceBWebsideController for more details) In this case, it either starts a worklet substitution process, or, if the workitem denotes the end of a worklet case, it completes the substitution process by checking the original workitem back into the engine.
void	handleEngineInitialisationCompletedEvent() Receives notification from the engine that it has finished startup initialisation and is now in a running state.
void	handleResourceUnavailableException(java.lang.String resourceID, WorkItemRecord wir, java.lang.String caseData, boolean primary)
void	handleTimeoutEvent(WorkItemRecord wir, java.lang.String taskList)
java.lang.String	handleWorkItemAbortException(WorkItemRecord wir, java.lang.String caseData)
boolean	isAdminSession(java.lang.String sessionHandle) returns true if the session specified is an admin session
boolean	isExceptionHandlingEnabled()
boolean	isWorkletCase(java.lang.String caseID)
void	processEnabledWorkItemEvent(WorkItemRecord wir)
protected void	raise(java.lang.String msg)
java.lang.String	replaceWorklet(java.lang.String wirID) Replaces a running worklet case with another worklet case after an amendment to the ruleset for this task.
void	setExceptionServiceEnabled(boolean enable)
void	setupEngineClient()
void	shutdown()
boolean	suspendCase(java.lang.String caseID)
boolean	suspendWorkItem(java.lang.String itemID)
Element	updateDataList(Element in, Element out) updates the input datalist with the changed data in the output datalist

Methods inherited from class org.yawlfoundation.yawl.engine.interfce.interfaceB.InterfaceBWebsideController

checkConnection, checkInWorkItem, checkInWorkItem, checkInWorkItem, checkOut, checkOutAllInstancesOfThisTask, connect, describeRequiredParams, destroy, getAuthenticationConfig, getCachedWorkItem, getChildren, getEngineStoredWorkItem, getIBCache, getModel, getResourcingSpecs, getSpecificationData, getSpecificationData, getSpecificationPrototypesList, getTaskInformation, getTaskInformation, handleCaseResumedEvent, handleCaseSuspendedEvent, handleCaseSuspendingEvent, handleDeadlockedCaseEvent, handleStartCaseEvent, handleTimerExpiryEvent, handleWorkItemStatusChangeEvent, logContactError, prepareReplyRootElement, setEngineLogonName, setEngineLogonPassword, setRemoteAuthenticationDetails, setUpInterfaceBClient, successful

Methods inherited from class java.lang.Object

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

Field Detail

_engineClient

protected EngineClient _engineClient

_runners

protected RunnerMap _runners

_persisting

protected boolean _persisting

_rdr

protected RdrEvaluator _rdr

_loader

protected final WorkletLoader _loader

_eventQueue

protected final EnabledEventQueue _eventQueue

Constructor Detail

WorkletService

protected WorkletService()

the constructor

Method Detail

getInstance

public static WorkletService getInstance()

Returns:

a reference to the current WorkletService instance

setupEngineClient

public void setupEngineClient()

getExternalServiceHandle

public java.lang.String getExternalServiceHandle(CostGatewayClient costClient)
                                          throws java.io.IOException

Throws:

java.io.IOException

setExceptionServiceEnabled

public void setExceptionServiceEnabled(boolean enable)

isExceptionHandlingEnabled

public boolean isExceptionHandlingEnabled()

getServer

public WorkletEventServer getServer()

getRdrInterface

public Rdr getRdrInterface()

getRdrEvaluator

public RdrEvaluator getRdrEvaluator()

getResourceServiceURL

public java.lang.String getResourceServiceURL()

getLoader

public WorkletLoader getLoader()

getEngineClient

public EngineClient getEngineClient()

getEventQueue

public EnabledEventQueue getEventQueue()

getExceptionService

public ExceptionService getExceptionService()

completeInitialisation

public void completeInitialisation()

completes the initialisation of the service load-up (mainly persistence) called from servlet WorkletGateway after contexts are loaded

shutdown

public void shutdown()

handleEnabledWorkItemEvent

public void handleEnabledWorkItemEvent(WorkItemRecord workItemRecord)

Handles a message from the engine that a workitem has been enabled (see InterfaceBWebsideController for more details) In this case, it either starts a worklet substitution process, or, if the workitem denotes the end of a worklet case, it completes the substitution process by checking the original workitem back into the engine.

Specified by:

handleEnabledWorkItemEvent in class InterfaceBWebsideController

Parameters:

workItemRecord - - a record describing the enabled workitem

handleCancelledWorkItemEvent

public void handleCancelledWorkItemEvent(WorkItemRecord wir)

Handles a message from the engine that a workitem has been cancelled (see InterfaceBWebsideController for more details) In this case, it cancels any worklet(s) running in place of the workitem. Only deals with child workitems currently checked out - not interested in workitems that haven't been handled by the service, or parent workitems, since handling all the children takes care of the parent. Includes MI items when threshold has been reached.

Specified by:

handleCancelledWorkItemEvent in class InterfaceBWebsideController

Parameters:

wir - - a record describing the cancelled workitem

handleCompleteCaseEvent

public void handleCompleteCaseEvent(java.lang.String caseID,
                                    java.lang.String casedata)

Handles a message from the engine that a (worklet) case has completed (see InterfaceBWebsideController for more details).

Only those services that register as an 'observer' for the case will receive these events. All worklets launched (through launchCase()) register as an observer.

Overrides:

handleCompleteCaseEvent in class InterfaceBWebsideController

Parameters:

caseID - - the id of the completed case

casedata - - an (XML) string containing the output data for the case

handleCancelledCaseEvent

public void handleCancelledCaseEvent(java.lang.String caseID)

Description copied from class: InterfaceBWebsideController

Receives notification from the engine that an active case has been cancelled. Override this method to take any necessary action.

Overrides:

handleCancelledCaseEvent in class InterfaceBWebsideController

Parameters:

caseID - the id of the case that has been cancelled

doGet

public void doGet(javax.servlet.http.HttpServletRequest request,
                  javax.servlet.http.HttpServletResponse response)
           throws java.io.IOException,
                  javax.servlet.ServletException

displays a web page describing the service

Specified by:

doGet in interface InterfaceX_Service

Overrides:

doGet in class InterfaceBWebsideController

Parameters:

request - the request

response - the response.

Throws:

java.io.IOException - if an error is detected when the servlet handles the GET request

javax.servlet.ServletException - if the request for the GET could not be handled

handleEngineInitialisationCompletedEvent

public void handleEngineInitialisationCompletedEvent()

Description copied from class: InterfaceBWebsideController

Receives notification from the engine that it has finished startup initialisation and is now in a running state. Override this method to handle final service initialisation tasks that require a running engine

Overrides:

handleEngineInitialisationCompletedEvent in class InterfaceBWebsideController

handleCheckCaseConstraintEvent

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

Specified by:

handleCheckCaseConstraintEvent in interface InterfaceX_Service

handleCheckWorkItemConstraintEvent

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

Specified by:

handleCheckWorkItemConstraintEvent in interface InterfaceX_Service

handleWorkItemAbortException

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

Specified by:

handleWorkItemAbortException in interface InterfaceX_Service

handleTimeoutEvent

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

Specified by:

handleTimeoutEvent in interface InterfaceX_Service

handleResourceUnavailableException

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

Specified by:

handleResourceUnavailableException in interface InterfaceX_Service

handleConstraintViolationException

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

Specified by:

handleConstraintViolationException in interface InterfaceX_Service

handleCaseCancellationEvent

public void handleCaseCancellationEvent(java.lang.String caseID)

Specified by:

handleCaseCancellationEvent in interface InterfaceX_Service

suspendCase

public boolean suspendCase(java.lang.String caseID)

suspendWorkItem

public boolean suspendWorkItem(java.lang.String itemID)

processEnabledWorkItemEvent

public void processEnabledWorkItemEvent(WorkItemRecord wir)

cancelWorkletSet

protected boolean cancelWorkletSet(java.util.Set<WorkletRunner> runnerSet)

Cancels each of the worklets listed in the wr as running

Parameters:

runnerSet - - the worklet record containing the list of worklets to cancel

Returns:

true if all of the worklets are successfully cancelled

replaceWorklet

public java.lang.String replaceWorklet(java.lang.String wirID)
                                throws java.io.IOException

Replaces a running worklet case with another worklet case after an amendment to the ruleset for this task. Called by WorkletGateway after a call from the Editor that the ruleset has been updated.

Parameters:

wirID - 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

raise

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

Throws:

java.io.IOException

getRunnerCaseIdList

public java.lang.String getRunnerCaseIdList(java.util.Set<WorkletRunner> runners)

updateDataList

public Element updateDataList(Element in,
                              Element out)

updates the input datalist with the changed data in the output datalist

Parameters:

in - - the JDOM Element containing the input params

out - - the JDOM Element containing the output params

Returns:

a JDOM Element with the data updated

getAllRunners

public java.util.Map<java.lang.String,WorkletRunner> getAllRunners()

isAdminSession

public boolean isAdminSession(java.lang.String sessionHandle)

returns true if the session specified is an admin session

isWorkletCase

public boolean isWorkletCase(java.lang.String caseID)