org.yawlfoundation.yawl.resourcing

Class ResourceManager

java.lang.Object

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

org.yawlfoundation.yawl.resourcing.ResourceManager

public final class ResourceManager
extends InterfaceBWebsideController

The ResourceManager singleton manages all aspects of the resource perspective, including the loading & maintenance of the org model, and overseeing the distribution of tasks to participants.

Author:

Michael Adams

Created/Last Date:

03/08/2007

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ADMIN_STR
static boolean	serviceInitialised

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

Method Summary

Modifier and Type	Method and Description
WorkItemRecord	acceptOffer(Participant p, WorkItemRecord wir)
java.lang.String	addChain(Participant p, WorkItemRecord wir)
java.lang.String	addEventListener(java.lang.String uri)
java.lang.String	addExternalClient(YExternalClient client)
java.lang.String	addParticipant(Participant p) Adds a new participant to the Resource DataSet, and persists it also
java.lang.String	addRegisteredService(YAWLServiceReference service)
void	addToOfferedSet(WorkItemRecord wir, Participant p)
void	announceModifiedQueue(java.lang.String pid)
boolean	assignUnofferedItem(WorkItemRecord wir, java.lang.String[] pidList, java.lang.String action)
boolean	canAddNewInstance(WorkItemRecord wir)
java.lang.String	cancelCase(java.lang.String caseID, java.lang.String userHandle) Cancels the case & removes its workitems (if any) from the service's queues & caches.
java.lang.String	chainCase(Participant p, WorkItemRecord wir) *************************************************************************
void	checkInAutoTask(WorkItemRecord wir, Element outData)
java.lang.String	checkinItem(Participant p, WorkItemRecord wir) Checks a (checked out) workitem back into the engine
protected java.util.List	checkOutChildren(WorkItemRecord wir, java.util.List children) Checks out all the child workitems of the parent item specified
protected boolean	checkOutWorkItem(WorkItemRecord wir) Check the workitem out of the engine
boolean	checkServiceConnection(java.lang.String handle)
java.lang.String	checkWorkItemDataAgainstSchema(WorkItemRecord wir, Element data)
WorkItemRecord	createNewWorkItemInstance(java.lang.String id, java.lang.String value)
boolean	deallocateWorkItem(Participant p, WorkItemRecord wir)
boolean	delegateWorkItem(Participant pFrom, Participant pTo, WorkItemRecord wir)
void	deletePersistedPiledTasks(YSpecificationID specID)
void	doGet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) displays a web page describing the service
Participant	expireSession(java.lang.String jSessionID)
void	finaliseInitialisation()
java.lang.String	getActiveParticipantsAsXML()
QueueSet	getAdminQueues()
int	getAdminSessionCount()
java.util.Set<ResourceMap>	getAllResourceMaps()
YBuildProperties	getBuildProperties()
ResourceMap	getCachedResourceMap(WorkItemRecord wir)
ResourceMap	getCachedResourceMap(YSpecificationID specID, java.lang.String taskID)
ResourceCalendar	getCalendar()
java.util.Set<java.lang.String>	getChainedCases(Participant p)
java.util.List<WorkItemRecord>	getChildren(java.lang.String parentID)
java.util.Set<WorkItemRecord>	getChildrenFromCache(java.lang.String parentID)
InterfaceClients	getClients()
java.lang.String	getDataSchema(java.lang.String itemID)
java.lang.String	getDataSchema(WorkItemRecord wir, YSpecificationID specID)
java.lang.String	getDataSchema(YSpecificationID specID)
java.lang.String	getDecompID(WorkItemRecord wir) get the workitem's (task) decomposition id
java.lang.String	getDecompID(YSpecificationID specID, java.lang.String taskID) gets a task's decomposition id
java.util.Set<Participant>	getDistributionSet(java.lang.String itemID)
java.lang.String	getEngineBuildProperties()
WorkItemRecord	getExecutingChild(WorkItemRecord parent)
java.lang.String	getFullNameForUserID(java.lang.String userID)
static ResourceManager	getInstance()
java.util.Set<SpecificationData>	getLoadedSpecs()
org.apache.logging.log4j.Logger	getLogger()
java.lang.String	getMIFormalInputParamName(WorkItemRecord wir)
java.lang.String	getNetParamValue(java.lang.String caseID, java.lang.String paramName)
ResourceDataSet	getOrgDataSet()
DataSource	getOrgDataSource() ***********************************************************************
java.lang.String	getOutputOnlyTaskParamsAsXML(java.lang.String itemID)
Participant	getParticipantAssignedWorkItem(WorkItemRecord wir, int qType)
Participant	getParticipantFromUserID(java.lang.String userID)
java.util.Set<Participant>	getParticipantsAssignedWorkItem(java.lang.String workItemID, int queueType)
java.util.Set<Participant>	getParticipantsAssignedWorkItem(WorkItemRecord wir)
ResourceMap	getPersistedPiledTask(YSpecificationID specID, java.lang.String taskID)
java.util.Set<ResourceMap>	getPersistedPiledTasks(Participant p)
java.util.Set<ResourceMap>	getPiledTaskMaps(Participant p)
ResourceMap	getResourceMap(java.lang.String itemID)
ResourceMap	getResourceMap(WorkItemRecord wir)
SecondaryResources	getSecondaryResources(WorkItemRecord wir)
UserPrivileges	getSessionPrivileges(java.lang.String handle)
SpecificationData	getSpecData(YSpecificationID spec)
java.util.Map<java.lang.String,Element>	getSpecificationDataSchema(YSpecificationID specID)
java.util.Set<SpecificationData>	getSpecList()
java.lang.String	getTaskParamsAsXML(java.lang.String itemID)
TaskPrivileges	getTaskPrivileges(java.lang.String itemID)
TaskPrivileges	getTaskPrivileges(WorkItemRecord wir)
java.util.Set<ResourceMap>	getUnpersistedPiledTasks(Participant p)
int	getUserAdminSessionCount()
java.lang.String	getUserIDForSessionHandle(java.lang.String handle)
QueueSet	getUserQueueSet(java.lang.String userID)
int	getUserSessionCount()
java.awt.Dimension	getVisualiserDimension()
java.util.Set<Participant>	getWhoCompletedTask(java.lang.String taskID, WorkItemRecord wir)
java.lang.String	getWorkItem(java.lang.String itemID)
WorkItemCache	getWorkItemCache()
java.lang.String	getWorkItemDurationsForParticipant(YSpecificationID specID, java.lang.String taskName, java.lang.String pid)
java.util.Map<java.lang.String,FormParameter>	getWorkItemParamsInfo(WorkItemRecord wir)
WorkItemRecord	getWorkItemRecord(java.lang.String itemID)
void	handleCancelledCaseEvent(java.lang.String caseID) Receives notification from the engine that an active case has been cancelled.
void	handleCancelledWorkItemEvent(WorkItemRecord wir) Receives notification from the engine that an active workitem has been cancelled.
void	handleCodeletCompletion(WorkItemRecord wir, Element codeletResult)
void	handleCompleteCaseEvent(java.lang.String caseID, java.lang.String casedata) Receives notification from the engine that an active case has been completed.
void	handleDeadlockedCaseEvent(java.lang.String caseID, java.lang.String tasks) Receives notification from the engine that an active case has become deadlocked.
void	handleEnabledWorkItemEvent(WorkItemRecord wir) *****************************************************************************
void	handleEngineInitialisationCompletedEvent() Receives notification from the engine that it has finished startup initialisation and is now in a running state.
void	handleNonOfferedQueueOnRemoval(WorkQueue queue)
void	handleOfferedQueueOnRemoval(Participant p, WorkQueue qOffer)
void	handleStartCaseEvent(YSpecificationID specID, java.lang.String caseID, java.lang.String launchingService, boolean delayed) Receives notification from the engine that a case has been started.
void	handleStartedQueuesOnRemoval(Participant p, WorkQueue qStart)
void	handleTimerExpiryEvent(WorkItemRecord wir) Receives notification from the engine that an active workitem's timer has expired.
void	handleWorkItemStatusChangeEvent(WorkItemRecord wir, java.lang.String oldStatus, java.lang.String newStatus) Receives notification from the engine that the status of a workitem has been modified.
void	handleWorkQueueOnRemoval(WorkQueue wq)
void	handleWorkQueuesOnRemoval(Participant p)
void	handleWorkQueuesOnRemoval(Participant p, QueueSet qs)
boolean	hasOrgDataSource()
boolean	hasUserTaskPrivilege(Participant p, WorkItemRecord wir, int privilege)
void	importParticipant(Participant p)
void	initBuildProperties(java.io.InputStream stream)
void	initOrgDataSource(java.lang.String dataSourceClassName, int refreshRate)
void	initRandomOrgDataGeneration(int count)
void	initServices() *****************************************************************************
boolean	isActiveSession(java.lang.String jSessionID)
boolean	isAdminSession(java.lang.String handle)
boolean	isDefaultOrgDB() **************************************************************************
protected boolean	isDeferredChoiceHandled(WorkItemRecord wir)
boolean	isKnownUserID(java.lang.String userid)
boolean	isOrgDataRefreshing()
boolean	isPersisting()
boolean	isPersistPiling()
boolean	isSpecBetaVersion(WorkItemRecord wir)
boolean	isValidUserSession(java.lang.String handle)
boolean	isVisualiserEnabled()
java.lang.String	launchCase(YSpecificationID specID, java.lang.String caseData, java.lang.String handle)
java.lang.String	launchCase(YSpecificationID specID, java.lang.String caseData, java.lang.String handle, java.util.Date delay)
java.lang.String	launchCase(YSpecificationID specID, java.lang.String caseData, java.lang.String handle, javax.xml.datatype.Duration delay)
java.lang.String	launchCase(YSpecificationID specID, java.lang.String caseData, java.lang.String handle, long delay)
void	loadResources() Loads all the org data from db into the ResourceDataSet mappings
java.lang.String	login(java.lang.String userid, java.lang.String password, java.lang.String jSessionID) ********************** 9.
void	logout(java.lang.String handle)
boolean	mapSetContains(java.util.Set<ResourceMap> mapSet, ResourceMap other)
WorkItemRecord	offerToAll(WorkItemRecord wir) ***********************************************************************
java.lang.String	pileWorkItem(Participant p, WorkItemRecord wir)
boolean	reallocateStatefulWorkItem(Participant pFrom, Participant pTo, WorkItemRecord wir)
boolean	reallocateStatelessWorkItem(Participant pFrom, Participant pTo, WorkItemRecord wir)
void	reassignWorklistedItem(WorkItemRecord wir, java.lang.String[] pidList, java.lang.String action)
java.lang.String	redirectWorkItemToYawlService(java.lang.String itemID, java.lang.String serviceName) Dispatches a work item to a YAWL Custom Service for handling.
void	refreshOrgData()
java.lang.String	registerCalendarStatusChangeListener(java.lang.String uri, java.lang.String handle)
void	registerJSFApplicationReference(ApplicationBean app)
void	removeCalendarStatusChangeListener(java.lang.String uri, java.lang.String handle)
void	removeCalendarStatusChangeListeners(java.lang.String handle)
void	removeCaseFromAllQueues(java.lang.String caseID)
void	removeChain(java.lang.String caseID)
boolean	removeEventListener(java.lang.String uri)
java.lang.String	removeExternalClient(java.lang.String id)
boolean	removeFromAll(WorkItemRecord wir)
void	removeParticipant(Participant p)
boolean	removeParticipant(java.lang.String pid)
java.lang.String	removeRegisteredService(java.lang.String id)
boolean	routeChainedWorkItem(Participant p, WorkItemRecord wir)
boolean	routeIfChained(WorkItemRecord wir, java.util.Set<Participant> distributionSet)
boolean	routePiledWorkItem(Participant p, WorkItemRecord wir)
void	sanitiseCaches() This does final initialisation tasks involved in ensuring the caches match the engine's known work.
java.lang.String	serviceConnect(java.lang.String userid, java.lang.String password, long timeOutSeconds)
void	serviceDisconnect(java.lang.String handle)
void	setAllowExternalOrgDataMods(boolean allow)
void	setBlockOnUnavailableSecondaryResources(boolean block)
protected void	setDeferredChoiceHandled(WorkItemRecord wir)
void	setExternalUserAuthentication(boolean externalAuth)
void	setOrgDataRefreshing(boolean refreshing)
void	setPersisting(boolean flag)
void	setPersistPiling(boolean persist)
static void	setServiceInitialised()
void	setVisualiserDimension(java.awt.Dimension d)
void	setVisualiserDimension(java.lang.String s)
void	setVisualiserEnabled(boolean enable)
void	shutdown() ***************************************************************************
boolean	skipWorkItem(Participant p, WorkItemRecord wir)
boolean	start(Participant p, WorkItemRecord wir) moves the workitem to executing for the participant.
boolean	startImmediate(Participant p, WorkItemRecord wir)
void	startOrgDataRefreshTimer(long interval) Starts a timer task to refresh the org data dataset at regular intervals, or turns an existing timer off if interval < 0
boolean	suspendWorkItem(Participant p, WorkItemRecord wir)
java.lang.String	unloadSpecification(YSpecificationID specID)
void	unpersistAutoTask(WorkItemRecord wir)
java.lang.String	unpileTask(ResourceMap resMap, Participant p)
protected boolean	unsetDeferredChoiceHandled(WorkItemRecord wir)
boolean	unsuspendWorkItem(Participant p, WorkItemRecord wir)
java.lang.String	updateExternalClient(java.lang.String id, java.lang.String password, java.lang.String doco)
void	updateParticipant(Participant p)
java.lang.String	updateWorkItemData(java.lang.String itemID, java.lang.String data)
java.lang.String	validateUserCredentials(java.lang.String userid, java.lang.String password, boolean admin)
void	withdrawOfferFromAll(WorkItemRecord wir)

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

ADMIN_STR

public static final java.lang.String ADMIN_STR

See Also:

Constant Field Values

serviceInitialised

public static boolean serviceInitialised

Method Detail

getInstance

public static ResourceManager getInstance()

Returns:

the instantiated ResourceManager reference

initServices

public void initServices()

*****************************************************************************

initOrgDataSource

public void initOrgDataSource(java.lang.String dataSourceClassName,
                              int refreshRate)

getClients

public InterfaceClients getClients()

initBuildProperties

public void initBuildProperties(java.io.InputStream stream)

getBuildProperties

public YBuildProperties getBuildProperties()

getEngineBuildProperties

public java.lang.String getEngineBuildProperties()

finaliseInitialisation

public void finaliseInitialisation()

setAllowExternalOrgDataMods

public void setAllowExternalOrgDataMods(boolean allow)

setExternalUserAuthentication

public void setExternalUserAuthentication(boolean externalAuth)

setVisualiserDimension

public void setVisualiserDimension(java.lang.String s)

setVisualiserDimension

public void setVisualiserDimension(java.awt.Dimension d)

getVisualiserDimension

public java.awt.Dimension getVisualiserDimension()

initRandomOrgDataGeneration

public void initRandomOrgDataGeneration(int count)

setVisualiserEnabled

public void setVisualiserEnabled(boolean enable)

isVisualiserEnabled

public boolean isVisualiserEnabled()

getWorkItemCache

public WorkItemCache getWorkItemCache()

registerJSFApplicationReference

public void registerJSFApplicationReference(ApplicationBean app)

hasOrgDataSource

public boolean hasOrgDataSource()

setOrgDataRefreshing

public void setOrgDataRefreshing(boolean refreshing)

isOrgDataRefreshing

public boolean isOrgDataRefreshing()

getLogger

public org.apache.logging.log4j.Logger getLogger()

getCalendar

public ResourceCalendar getCalendar()

registerCalendarStatusChangeListener

public java.lang.String registerCalendarStatusChangeListener(java.lang.String uri,
                                                             java.lang.String handle)

removeCalendarStatusChangeListener

public void removeCalendarStatusChangeListener(java.lang.String uri,
                                               java.lang.String handle)

removeCalendarStatusChangeListeners

public void removeCalendarStatusChangeListeners(java.lang.String handle)

addEventListener

public java.lang.String addEventListener(java.lang.String uri)

removeEventListener

public boolean removeEventListener(java.lang.String uri)

handleEnabledWorkItemEvent

public void handleEnabledWorkItemEvent(WorkItemRecord wir)

*****************************************************************************

Specified by:

handleEnabledWorkItemEvent in class InterfaceBWebsideController

Parameters:

wir - the enabled work item

handleCancelledWorkItemEvent

public void handleCancelledWorkItemEvent(WorkItemRecord wir)

Description copied from class: InterfaceBWebsideController

Receives notification from the engine that an active workitem has been cancelled. A custom service will implement this method to take any cleanup action on a previously checked out workitem.

Specified by:

handleCancelledWorkItemEvent in class InterfaceBWebsideController

Parameters:

wir - the cancelled work item

handleTimerExpiryEvent

public void handleTimerExpiryEvent(WorkItemRecord wir)

Description copied from class: InterfaceBWebsideController

Receives notification from the engine that an active workitem's timer has expired. Override this method to handle timer expiries on timed workitems.

Overrides:

handleTimerExpiryEvent in class InterfaceBWebsideController

Parameters:

wir - the workitem that has an expired timer

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

handleDeadlockedCaseEvent

public void handleDeadlockedCaseEvent(java.lang.String caseID,
                                      java.lang.String tasks)

Description copied from class: InterfaceBWebsideController

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

Overrides:

handleDeadlockedCaseEvent in class InterfaceBWebsideController

Parameters:

caseID - the id of the case that has been cancelled

tasks - the list of deadlocked task ids

handleCompleteCaseEvent

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

Description copied from class: InterfaceBWebsideController

Receives notification from the engine that an active case has been completed. By overriding this method a service can process case completion events as required.

Overrides:

handleCompleteCaseEvent in class InterfaceBWebsideController

Parameters:

caseID - the id of the completed case.

casedata - the set of net-level data for the case when it completes

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

handleWorkItemStatusChangeEvent

public void handleWorkItemStatusChangeEvent(WorkItemRecord wir,
                                            java.lang.String oldStatus,
                                            java.lang.String newStatus)

Description copied from class: InterfaceBWebsideController

Receives notification from the engine that the status of a workitem has been modified. Override this method to handle any effects a status change might have on a custom service

Overrides:

handleWorkItemStatusChangeEvent in class InterfaceBWebsideController

Parameters:

wir - the work item that has had its status modified

oldStatus - the work item's previous status

newStatus - the work item's new status

handleStartCaseEvent

public void handleStartCaseEvent(YSpecificationID specID,
                                 java.lang.String caseID,
                                 java.lang.String launchingService,
                                 boolean delayed)

Description copied from class: InterfaceBWebsideController

Receives notification from the engine that a case has been started. By overriding this method a service can process case start events as required.

Overrides:

handleStartCaseEvent in class InterfaceBWebsideController

Parameters:

specID - the specification id of the started case

caseID - the id of the case

launchingService - the uri (String) of the service that started the case

delayed - true if this is a delayed case start, false if immediate

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

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

isDefaultOrgDB

public boolean isDefaultOrgDB()

**************************************************************************

getOrgDataSet

public ResourceDataSet getOrgDataSet()

loadResources

public void loadResources()

Loads all the org data from db into the ResourceDataSet mappings

refreshOrgData

public void refreshOrgData()

sanitiseCaches

public void sanitiseCaches()

This does final initialisation tasks involved in ensuring the caches match the engine's known work. It is called via the EngineInitialisationCompleted event, because it needs the engine to be completely initialised first. It may also be executed via the 'synch' button on the admin queues.

isKnownUserID

public boolean isKnownUserID(java.lang.String userid)

addParticipant

public java.lang.String addParticipant(Participant p)

Adds a new participant to the Resource DataSet, and persists it also

Parameters:

p - the new Participant

importParticipant

public void importParticipant(Participant p)

updateParticipant

public void updateParticipant(Participant p)

removeParticipant

public void removeParticipant(Participant p)

removeParticipant

public boolean removeParticipant(java.lang.String pid)

getActiveParticipantsAsXML

public java.lang.String getActiveParticipantsAsXML()

getParticipantFromUserID

public Participant getParticipantFromUserID(java.lang.String userID)

getUserQueueSet

public QueueSet getUserQueueSet(java.lang.String userID)

getParticipantsAssignedWorkItem

public java.util.Set<Participant> getParticipantsAssignedWorkItem(java.lang.String workItemID,
                                                                  int queueType)

getParticipantsAssignedWorkItem

public java.util.Set<Participant> getParticipantsAssignedWorkItem(WorkItemRecord wir)

getParticipantAssignedWorkItem

public Participant getParticipantAssignedWorkItem(WorkItemRecord wir,
                                                  int qType)

getFullNameForUserID

public java.lang.String getFullNameForUserID(java.lang.String userID)

offerToAll

public WorkItemRecord offerToAll(WorkItemRecord wir)

***********************************************************************

withdrawOfferFromAll

public void withdrawOfferFromAll(WorkItemRecord wir)

removeFromAll

public boolean removeFromAll(WorkItemRecord wir)

removeCaseFromAllQueues

public void removeCaseFromAllQueues(java.lang.String caseID)

getAdminQueues

public QueueSet getAdminQueues()

acceptOffer

public WorkItemRecord acceptOffer(Participant p,
                                  WorkItemRecord wir)

setDeferredChoiceHandled

protected void setDeferredChoiceHandled(WorkItemRecord wir)

unsetDeferredChoiceHandled

protected boolean unsetDeferredChoiceHandled(WorkItemRecord wir)

isDeferredChoiceHandled

protected boolean isDeferredChoiceHandled(WorkItemRecord wir)

handleWorkQueuesOnRemoval

public void handleWorkQueuesOnRemoval(Participant p)

handleWorkQueuesOnRemoval

public void handleWorkQueuesOnRemoval(Participant p,
                                      QueueSet qs)

handleWorkQueueOnRemoval

public void handleWorkQueueOnRemoval(WorkQueue wq)

handleOfferedQueueOnRemoval

public void handleOfferedQueueOnRemoval(Participant p,
                                        WorkQueue qOffer)

handleNonOfferedQueueOnRemoval

public void handleNonOfferedQueueOnRemoval(WorkQueue queue)

handleStartedQueuesOnRemoval

public void handleStartedQueuesOnRemoval(Participant p,
                                         WorkQueue qStart)

start

public boolean start(Participant p,
                     WorkItemRecord wir)

moves the workitem to executing for the participant.

Note that when an item is checked out of the engine, at least one child item is spawned, and that is the item that executes (i.e. not the parent).

Parameters:

p - the participant starting the workitem

wir - the item to start

Returns:

true for a successful workitem start

suspendWorkItem

public boolean suspendWorkItem(Participant p,
                               WorkItemRecord wir)

unsuspendWorkItem

public boolean unsuspendWorkItem(Participant p,
                                 WorkItemRecord wir)

reallocateStatelessWorkItem

public boolean reallocateStatelessWorkItem(Participant pFrom,
                                           Participant pTo,
                                           WorkItemRecord wir)

reallocateStatefulWorkItem

public boolean reallocateStatefulWorkItem(Participant pFrom,
                                          Participant pTo,
                                          WorkItemRecord wir)

deallocateWorkItem

public boolean deallocateWorkItem(Participant p,
                                  WorkItemRecord wir)

delegateWorkItem

public boolean delegateWorkItem(Participant pFrom,
                                Participant pTo,
                                WorkItemRecord wir)

skipWorkItem

public boolean skipWorkItem(Participant p,
                            WorkItemRecord wir)

pileWorkItem

public java.lang.String pileWorkItem(Participant p,
                                     WorkItemRecord wir)

unpileTask

public java.lang.String unpileTask(ResourceMap resMap,
                                   Participant p)

routePiledWorkItem

public boolean routePiledWorkItem(Participant p,
                                  WorkItemRecord wir)

startImmediate

public boolean startImmediate(Participant p,
                              WorkItemRecord wir)

hasUserTaskPrivilege

public boolean hasUserTaskPrivilege(Participant p,
                                    WorkItemRecord wir,
                                    int privilege)

getTaskPrivileges

public TaskPrivileges getTaskPrivileges(java.lang.String itemID)

getTaskPrivileges

public TaskPrivileges getTaskPrivileges(WorkItemRecord wir)

getWorkItem

public java.lang.String getWorkItem(java.lang.String itemID)

getWorkItemRecord

public WorkItemRecord getWorkItemRecord(java.lang.String itemID)

updateWorkItemData

public java.lang.String updateWorkItemData(java.lang.String itemID,
                                           java.lang.String data)

checkWorkItemDataAgainstSchema

public java.lang.String checkWorkItemDataAgainstSchema(WorkItemRecord wir,
                                                       Element data)

chainCase

public java.lang.String chainCase(Participant p,
                                  WorkItemRecord wir)

*************************************************************************

routeChainedWorkItem

public boolean routeChainedWorkItem(Participant p,
                                    WorkItemRecord wir)

addChain

public java.lang.String addChain(Participant p,
                                 WorkItemRecord wir)

removeChain

public void removeChain(java.lang.String caseID)

getChainedCases

public java.util.Set<java.lang.String> getChainedCases(Participant p)

routeIfChained

public boolean routeIfChained(WorkItemRecord wir,
                              java.util.Set<Participant> distributionSet)

getPiledTaskMaps

public java.util.Set<ResourceMap> getPiledTaskMaps(Participant p)

Returns:

the union of persisted and unpersisted maps

getUnpersistedPiledTasks

public java.util.Set<ResourceMap> getUnpersistedPiledTasks(Participant p)

getPersistedPiledTasks

public java.util.Set<ResourceMap> getPersistedPiledTasks(Participant p)

getPersistedPiledTask

public ResourceMap getPersistedPiledTask(YSpecificationID specID,
                                         java.lang.String taskID)

deletePersistedPiledTasks

public void deletePersistedPiledTasks(YSpecificationID specID)

mapSetContains

public boolean mapSetContains(java.util.Set<ResourceMap> mapSet,
                              ResourceMap other)

getAllResourceMaps

public java.util.Set<ResourceMap> getAllResourceMaps()

getOrgDataSource

public DataSource getOrgDataSource()

***********************************************************************

setPersisting

public void setPersisting(boolean flag)

isPersisting

public boolean isPersisting()

startOrgDataRefreshTimer

public void startOrgDataRefreshTimer(long interval)

Starts a timer task to refresh the org data dataset at regular intervals, or turns an existing timer off if interval < 0

Parameters:

interval - the number of minutes between each refresh

setPersistPiling

public void setPersistPiling(boolean persist)

isPersistPiling

public boolean isPersistPiling()

setBlockOnUnavailableSecondaryResources

public void setBlockOnUnavailableSecondaryResources(boolean block)

getDistributionSet

public java.util.Set<Participant> getDistributionSet(java.lang.String itemID)

getResourceMap

public ResourceMap getResourceMap(java.lang.String itemID)

getCachedResourceMap

public ResourceMap getCachedResourceMap(WorkItemRecord wir)

getCachedResourceMap

public ResourceMap getCachedResourceMap(YSpecificationID specID,
                                        java.lang.String taskID)

getResourceMap

public ResourceMap getResourceMap(WorkItemRecord wir)

setServiceInitialised

public static void setServiceInitialised()

getWhoCompletedTask

public java.util.Set<Participant> getWhoCompletedTask(java.lang.String taskID,
                                                      WorkItemRecord wir)

getDecompID

public java.lang.String getDecompID(WorkItemRecord wir)

get the workitem's (task) decomposition id

Parameters:

wir - - the workitem to get the decomp id for

getDecompID

public java.lang.String getDecompID(YSpecificationID specID,
                                    java.lang.String taskID)

gets a task's decomposition id

Parameters:

specID - the specification id

taskID - the task's id

checkOutWorkItem

protected boolean checkOutWorkItem(WorkItemRecord wir)

Check the workitem out of the engine

Parameters:

wir - - the workitem to check out

Returns:

true if checkout was successful

checkinItem

public java.lang.String checkinItem(Participant p,
                                    WorkItemRecord wir)

Checks a (checked out) workitem back into the engine

Parameters:

p - - the participant checking in the item

wir - - workitem to check into the engine

Returns:

true if checkin is successful

getSecondaryResources

public SecondaryResources getSecondaryResources(WorkItemRecord wir)

checkOutChildren

protected java.util.List checkOutChildren(WorkItemRecord wir,
                                          java.util.List children)

Checks out all the child workitems of the parent item specified

Parameters:

wir - - the parent wir object

getExecutingChild

public WorkItemRecord getExecutingChild(WorkItemRecord parent)

login

public java.lang.String login(java.lang.String userid,
                              java.lang.String password,
                              java.lang.String jSessionID)

********************** 9. CONNECTION METHODS * **********************

logout

public void logout(java.lang.String handle)

isValidUserSession

public boolean isValidUserSession(java.lang.String handle)

isAdminSession

public boolean isAdminSession(java.lang.String handle)

getSessionPrivileges

public UserPrivileges getSessionPrivileges(java.lang.String handle)

validateUserCredentials

public java.lang.String validateUserCredentials(java.lang.String userid,
                                                java.lang.String password,
                                                boolean admin)

expireSession

public Participant expireSession(java.lang.String jSessionID)

isActiveSession

public boolean isActiveSession(java.lang.String jSessionID)

getUserSessionCount

public int getUserSessionCount()

getAdminSessionCount

public int getAdminSessionCount()

getUserAdminSessionCount

public int getUserAdminSessionCount()

shutdown

public void shutdown()

***************************************************************************

serviceConnect

public java.lang.String serviceConnect(java.lang.String userid,
                                       java.lang.String password,
                                       long timeOutSeconds)

serviceDisconnect

public void serviceDisconnect(java.lang.String handle)

checkServiceConnection

public boolean checkServiceConnection(java.lang.String handle)

getUserIDForSessionHandle

public java.lang.String getUserIDForSessionHandle(java.lang.String handle)

getLoadedSpecs

public java.util.Set<SpecificationData> getLoadedSpecs()

getSpecList

public java.util.Set<SpecificationData> getSpecList()

getSpecData

public SpecificationData getSpecData(YSpecificationID spec)

isSpecBetaVersion

public boolean isSpecBetaVersion(WorkItemRecord wir)

cancelCase

public java.lang.String cancelCase(java.lang.String caseID,
                                   java.lang.String userHandle)
                            throws java.io.IOException

Cancels the case & removes its workitems (if any) from the service's queues & caches. Note: this method is synchronised to prevent any clash with 'handleCancelledCaseEvent', which is triggered by the call to cancelCase in this method.

Parameters:

caseID - the case to cancel

Returns:

a message from the engine indicating success or otherwise

Throws:

java.io.IOException - if there's trouble talking to the engine

getChildren

public java.util.List<WorkItemRecord> getChildren(java.lang.String parentID)

getChildrenFromCache

public java.util.Set<WorkItemRecord> getChildrenFromCache(java.lang.String parentID)

unloadSpecification

public java.lang.String unloadSpecification(YSpecificationID specID)
                                     throws java.io.IOException

Throws:

java.io.IOException

launchCase

public java.lang.String launchCase(YSpecificationID specID,
                                   java.lang.String caseData,
                                   java.lang.String handle)
                            throws java.io.IOException

Throws:

java.io.IOException

launchCase

public java.lang.String launchCase(YSpecificationID specID,
                                   java.lang.String caseData,
                                   java.lang.String handle,
                                   long delay)
                            throws java.io.IOException

Throws:

java.io.IOException

launchCase

public java.lang.String launchCase(YSpecificationID specID,
                                   java.lang.String caseData,
                                   java.lang.String handle,
                                   java.util.Date delay)
                            throws java.io.IOException

Throws:

java.io.IOException

launchCase

public java.lang.String launchCase(YSpecificationID specID,
                                   java.lang.String caseData,
                                   java.lang.String handle,
                                   javax.xml.datatype.Duration delay)
                            throws java.io.IOException

Throws:

java.io.IOException

getTaskParamsAsXML

public java.lang.String getTaskParamsAsXML(java.lang.String itemID)
                                    throws java.io.IOException

Throws:

java.io.IOException

getOutputOnlyTaskParamsAsXML

public java.lang.String getOutputOnlyTaskParamsAsXML(java.lang.String itemID)

getWorkItemParamsInfo

public java.util.Map<java.lang.String,FormParameter> getWorkItemParamsInfo(WorkItemRecord wir)
                                                                    throws java.io.IOException,
                                                                           JDOMException

Throws:

java.io.IOException

JDOMException

announceModifiedQueue

public void announceModifiedQueue(java.lang.String pid)

addRegisteredService

public java.lang.String addRegisteredService(YAWLServiceReference service)
                                      throws java.io.IOException

Throws:

java.io.IOException

removeRegisteredService

public java.lang.String removeRegisteredService(java.lang.String id)
                                         throws java.io.IOException

Throws:

java.io.IOException

addExternalClient

public java.lang.String addExternalClient(YExternalClient client)
                                   throws java.io.IOException

Throws:

java.io.IOException

removeExternalClient

public java.lang.String removeExternalClient(java.lang.String id)
                                      throws java.io.IOException

Throws:

java.io.IOException

updateExternalClient

public java.lang.String updateExternalClient(java.lang.String id,
                                             java.lang.String password,
                                             java.lang.String doco)
                                      throws java.io.IOException

Throws:

java.io.IOException

getNetParamValue

public java.lang.String getNetParamValue(java.lang.String caseID,
                                         java.lang.String paramName)
                                  throws java.io.IOException

Throws:

java.io.IOException

getDataSchema

public java.lang.String getDataSchema(YSpecificationID specID)

getDataSchema

public java.lang.String getDataSchema(java.lang.String itemID)

getDataSchema

public java.lang.String getDataSchema(WorkItemRecord wir,
                                      YSpecificationID specID)

getSpecificationDataSchema

public java.util.Map<java.lang.String,Element> getSpecificationDataSchema(YSpecificationID specID)
                                                                   throws java.io.IOException

Throws:

java.io.IOException

assignUnofferedItem

public boolean assignUnofferedItem(WorkItemRecord wir,
                                   java.lang.String[] pidList,
                                   java.lang.String action)

addToOfferedSet

public void addToOfferedSet(WorkItemRecord wir,
                            Participant p)

reassignWorklistedItem

public void reassignWorklistedItem(WorkItemRecord wir,
                                   java.lang.String[] pidList,
                                   java.lang.String action)

unpersistAutoTask

public void unpersistAutoTask(WorkItemRecord wir)

handleCodeletCompletion

public void handleCodeletCompletion(WorkItemRecord wir,
                                    Element codeletResult)

checkInAutoTask

public void checkInAutoTask(WorkItemRecord wir,
                            Element outData)

getMIFormalInputParamName

public java.lang.String getMIFormalInputParamName(WorkItemRecord wir)

canAddNewInstance

public boolean canAddNewInstance(WorkItemRecord wir)

createNewWorkItemInstance

public WorkItemRecord createNewWorkItemInstance(java.lang.String id,
                                                java.lang.String value)

getWorkItemDurationsForParticipant

public java.lang.String getWorkItemDurationsForParticipant(YSpecificationID specID,
                                                           java.lang.String taskName,
                                                           java.lang.String pid)

redirectWorkItemToYawlService

public java.lang.String redirectWorkItemToYawlService(java.lang.String itemID,
                                                      java.lang.String serviceName)

Dispatches a work item to a YAWL Custom Service for handling.

Parameters:

itemID - the id of the work to be redirected.

serviceName - the name of the service to redirect it to

Returns:

a success or diagnostic error message

Precondition:

The item id refers to a work item that is currently in the list of items known to the Resource Service, and the work item has enabled or fired status, The service name refers to a service registered in the engine, The service is up and running