org.yawlfoundation.yawl.resourcing

Class InterfaceClients

java.lang.Object

org.yawlfoundation.yawl.util.AbstractEngineClient

org.yawlfoundation.yawl.resourcing.InterfaceClients

public class InterfaceClients
extends AbstractEngineClient

Handles all of the interface connections and calls for the Resource Service to the Engine and other services as needed, besides those that go through InterfaceBWebsideController

Author:

Michael Adams

Created/Last Date:

22/02/12

Field Summary

Fields inherited from class org.yawlfoundation.yawl.util.AbstractEngineClient

_defaultURI, _engineLogonName, _engineLogonPassword, _engineURI, _interfaceAClient, _interfaceBClient, _log, _serviceName, _serviceURI, _sessionHandle, ADMIN_STR, FAIL_STR, SUCCESS_STR, WORKITEM_ERR

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	InterfaceClients(java.lang.String logonName, java.lang.String password) Initialises the class.

Method Summary

Modifier and Type	Method and Description
java.lang.String	addEventListener(java.lang.String uri)
void	announceResourceCalendarStatusChange(java.lang.String origAgent, java.lang.String changeXML)
void	announceResourceUnavailable(AbstractResource resource, WorkItemRecord wir, boolean primary)
void	announceResourceUnavailable(WorkItemRecord wir)
CostClient	getCostClient()
DocStoreClient	getDocStoreClient()
java.lang.String	getEngineSpecificationStatistics(YSpecificationID specID, long from, long to)
java.lang.String	getEngineXESLog(YSpecificationID specID, boolean withData)
java.lang.String	getExceptionServiceURI()
boolean	hasCostClient()
boolean	hasDocStoreClient()
boolean	hasExceptionServiceEnabled()
void	initClients(java.lang.String engineURI, java.lang.String exceptionURI, java.lang.String schedulingURI, java.lang.String costServiceURI, java.lang.String docStoreURI) Called on servlet startup with the various uris needed to initialise the various clients
protected java.lang.String	redirectWorkItemToYawlService(WorkItemRecord wir, java.lang.String serviceName) Dispatches a work item to a YAWL Custom Service for handling.
void	reestablishClients(InterfaceB_EnvironmentBasedClient client) Reestablishes clients when the resource service restarts
java.lang.String	registerCalendarStatusChangeListener(java.lang.String uri, java.lang.String userID)
void	removeCalendarStatusChangeListener(java.lang.String uri, java.lang.String userID)
void	removeCalendarStatusChangeListeners(java.lang.String userID)
protected void	removeCaseFromDocStore(java.lang.String caseID)
boolean	removeEventListener(java.lang.String uri)

Methods inherited from class org.yawlfoundation.yawl.util.AbstractEngineClient

addExternalClient, addRegisteredService, canAddNewInstance, cancelCase, connected, createNewWorkItemInstance, engineIsAvailable, fail, getAdminUserPassword, getAllLiveWorkItems, getAllRunningCaseIDs, getAllRunningCases, getCaseData, getCases, getEngineBuildProperties, getEngineLogonName, getEngineLogonPassword, getEngineURI, getExternalClients, getIABackendURI, getLiveWorkItemsForCase, getLiveWorkItemsForIdentifier, getMITaskAttributes, getNamespace, getRegisteredServices, getRegisteredServicesAsXML, getRunningCases, getRunningCasesAsList, getServiceURI, getServiceURI, getSessionHandle, getSpecification, getSpecificationDataSchema, getTaskParamsAsXML, getWorkItemsForService, initEngineURI, isAdminSession, isRunningCaseID, launchCase, launchCase, launchCase, launchCase, removeExternalClient, removeRegisteredService, setInterfaceBClient, setServiceURI, skipWorkItem, successful, suspendWorkItem, unloadSpecification, unsuspendWorkItem, updateExternalClient, uploadSpecification

Methods inherited from class java.lang.Object

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

Constructor Detail

InterfaceClients

protected InterfaceClients(java.lang.String logonName,
                           java.lang.String password)

Initialises the class. Package access only.

Parameters:

logonName - the resource service's logon name (from web.xml)

password - the resource service's logon password (from web.xml)

Method Detail

initClients

public void initClients(java.lang.String engineURI,
                        java.lang.String exceptionURI,
                        java.lang.String schedulingURI,
                        java.lang.String costServiceURI,
                        java.lang.String docStoreURI)

Called on servlet startup with the various uris needed to initialise the various clients

Parameters:

engineURI - the URI of the Engine's Interface B

exceptionURI - the URI of the Worklet Exception Service

schedulingURI - the URI of the Scheduling Service

costServiceURI - the URI of the Cost Service

docStoreURI - the URI of the Document Store

reestablishClients

public void reestablishClients(InterfaceB_EnvironmentBasedClient client)

Reestablishes clients when the resource service restarts

Overrides:

reestablishClients in class AbstractEngineClient

Parameters:

client - the Interface B client from InterfaceBWebsideController

announceResourceUnavailable

public void announceResourceUnavailable(WorkItemRecord wir)

announceResourceUnavailable

public void announceResourceUnavailable(AbstractResource resource,
                                        WorkItemRecord wir,
                                        boolean primary)

announceResourceCalendarStatusChange

public void announceResourceCalendarStatusChange(java.lang.String origAgent,
                                                 java.lang.String changeXML)

registerCalendarStatusChangeListener

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

removeCalendarStatusChangeListener

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

removeCalendarStatusChangeListeners

public void removeCalendarStatusChangeListeners(java.lang.String userID)

addEventListener

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

removeEventListener

public boolean removeEventListener(java.lang.String uri)

redirectWorkItemToYawlService

protected java.lang.String redirectWorkItemToYawlService(WorkItemRecord wir,
                                                         java.lang.String serviceName)

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

Parameters:

wir - the work item 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

getEngineXESLog

public java.lang.String getEngineXESLog(YSpecificationID specID,
                                        boolean withData)

getEngineSpecificationStatistics

public java.lang.String getEngineSpecificationStatistics(YSpecificationID specID,
                                                         long from,
                                                         long to)

hasCostClient

public boolean hasCostClient()

getCostClient

public CostClient getCostClient()

hasDocStoreClient

public boolean hasDocStoreClient()

getDocStoreClient

public DocStoreClient getDocStoreClient()

hasExceptionServiceEnabled

public boolean hasExceptionServiceEnabled()

getExceptionServiceURI

public java.lang.String getExceptionServiceURI()

removeCaseFromDocStore

protected void removeCaseFromDocStore(java.lang.String caseID)