org.yawlfoundation.yawl.scheduling

Class SchedulingService

java.lang.Object

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

org.yawlfoundation.yawl.scheduling.Service

org.yawlfoundation.yawl.scheduling.SchedulingService

All Implemented Interfaces:

Constants

public class SchedulingService
extends Service

Bridge between Scheduling Service and the YAWL engine; has to be registered as YAWL service; checks out resource utilisation tasks, i.e. SOU and EOU

Version:

$Id: SchedulingService.java 23027 2010-10-22 14:02:53Z tbe $

Author:

tbe

Field Summary

Fields inherited from class org.yawlfoundation.yawl.scheduling.Service

_cancelledWorkitemOrCaseIds, _config, _dataMapper, _handle, _props

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

Fields inherited from interface org.yawlfoundation.yawl.scheduling.Constants

ADDRESS_TYPE_EMAIL, ADDRESS_TYPE_IP, ADDRESS_TYPE_SMS, CSS_BOOLEANINPUT, CSS_DATEINPUT, CSS_DURATIONINPUT, CSS_ERRORINPUT, CSS_ERRORTEXT, CSS_INTINPUT, CSS_REQUIRED, CSS_TEXTINPUT, CSS_WARNINGINPUT, CSS_WARNINGTEXT, CSV_DELIMITER, DELIMITER, LANGUAGE_ATTRIBUTE_NAME, LANGUAGE_DEFAULT, LANGUAGES, MSGREL_AFTER, MSGREL_BEFORE, RESOURCE_STATUS_AVAILABLE, RESOURCE_STATUS_NOTAVAILABLE, RESOURCE_STATUS_REQUESTED, RESOURCE_STATUS_RESERVED, RESOURCE_STATUS_UNCHECKED, RESOURCE_STATUS_UNKNOWN, UTILISATION_TYPE_BEGIN, UTILISATION_TYPE_END, UTILISATION_TYPE_PLAN, WORD_SEPARATORS, XML_ACTIVITY, XML_ACTIVITYNAME, XML_ACTIVITYTYPE, XML_ADDRESS, XML_ADDRESSTYPE, XML_CAPABILITY, XML_CASEID, XML_CATEGORY, XML_CHANNEL, XML_DUMMY, XML_DURATION, XML_ENDTASKID, XML_ERROR, XML_EVENT_RECEIVE, XML_FILTERMODEL, XML_FROM, XML_ID, XML_MAX, XML_MESSAGE_SEND, XML_MESSAGEPUSH_SEND, XML_MESSAGES, XML_MIN, XML_MSGBODY, XML_MSGDURATION, XML_MSGREL, XML_MSGTO, XML_MSGTRANSFER, XML_MSGUTILISATIONTYPE, XML_OTHERACTIVITYNAME, XML_OTHERUTILISATIONTYPE, XML_PAYLOAD, XML_REQUESTTYPE, XML_RESCHEDULING, XML_RESERVATION, XML_RESERVATIONID, XML_RESOURCE, XML_RESOURCE_TYPE, XML_ROLE, XML_RUP, XML_RUP_LIGHT, XML_STARTTASKID, XML_STATUS, XML_STATUSTOBE, XML_SUBCATEGORY, XML_TEXT, XML_THISUTILISATIONTYPE, XML_TIMESTAMP, XML_TO, XML_UNIT, XML_UTILISATION, XML_UTILISATION_TYPE, XML_UTILISATIONREL, XML_UTILISATIONTYPE, XML_WARNING, XML_WORKLOAD, XSDDatatypes_Boolean, XSDDatatypes_DateTime, XSDDatatypes_Double, XSDDatatypes_Duration, XSDDatatypes_Int, XSDDatatypes_Long, XSDDatatypes_String

Method Summary

Modifier and Type	Method and Description
void	activityStatusChange(java.lang.String caseId, java.lang.String activityName, java.lang.String from, java.lang.String to) call from rescheduling task in yawl engine if rescheduling of an activity was made
void	checkRelations(Document rup) check utilisation relations of rup
void	completeRupFromHistory(Document rup, java.util.Set<java.lang.String> addedActivitiyNames) completes a rup with historical data of rups with same ActivityType, but only for new added activities and if data fields are empty yet
void	extendRUPFromYAWLModel(Document doc, java.util.Set<java.lang.String> addedActivityNames) adds new activities from YAWL model specification to document in right order, e.g.
java.util.List<java.lang.String>	getActivityTypes(java.lang.String activityName, java.lang.String newValue) retrieve a list of all activity types for showing in configuration dropdown boxes of custom form
java.util.Set<java.lang.String>	getDiffActivityNames(Element e1, Element e2) get activity names of e2 which are not in e1
static SchedulingService	getInstance()
java.lang.String	getLastSaveMsg()
long	getLastSaveTime()
java.util.List<Document>	getRupList(java.util.List<Case> cases)
void	handleCancelledCaseEvent(java.lang.String caseID) Receives notification from the engine that an active case has been cancelled.
void	handleCompleteCaseEvent(java.lang.String caseID, java.lang.String casedata) Receives notification from the engine that an active case has been completed.
void	handleEngineInitialisationCompletedEvent() the SS and the RS will get the event at the same time, so the SS will need to delay the call to the RS by 10 seconds while the RS gets the credentials from the engine
Case	loadCase(java.lang.String caseId)
java.util.List<Element>	loadReservations(java.lang.String caseId, java.lang.String activityName) resource service retrieves reservations for given case and task to utilise them
java.util.Set<java.lang.String>	optimizeAndSaveRup(Document rup, java.lang.String savedBy, java.lang.String errorMsg, boolean resourceChange) TODO@tbe: was wenn RUP gerade angezeigt/konfiguriert wird?
void	processCachedMappingsTask() ************************************************************************************** task methods and inner classes ***************************************************************************************
protected void	processMappingChild(Mapping mapping) process work item depending on task type check back into the engine remove the mapping for successful processed work items updates the mapping continuously
void	registerMessageReceiveServlet() Register the MessageReceiveServlet with the Resource Service TODO@tbe: better to use our own IP and figure out the port number
void	reservationStatusChange(java.lang.String caseId, java.lang.String activityName, java.lang.Long reservationId, java.lang.String statusNew) call from resource service about unavailabilities of resources (if Admin change availability of resource and PLANNING_STATUS was changed to PLANNING_STATUS_NOTAVAILABLE)
void	resourceUtilisationChange(java.lang.String taskID, java.lang.String caseId, java.lang.String activityName, java.lang.String utilisationType, java.lang.String timeStampXML) call from utilisation task in yawl engine if (de)utilisation for all resources of an activity have to made
void	saveRupToDatabase(java.lang.String caseId, java.lang.String savedBy, Document rup, java.lang.String msg)
void	sendPushMessage(java.lang.String address, java.lang.String addressType, java.lang.String msg, java.lang.String caseId)
void	startMessageTransfers(java.lang.String caseId, Document rup) extract message transfers from rup and find/create job group for this rup and update/create job for each message transfer item
void	updateRunningRups(java.lang.String savedBy) call from JobRUPCheck, sets TO time of running activities to actual time and calculate new DURATION value

Methods inherited from class org.yawlfoundation.yawl.scheduling.Service

checkInWorkItem, checkOutWorkItem, getChildren, getDataListFromWorkItem, getHandle, getOutputData, getSpecificationForCase, getWorkItemFromCache, handleCancelledWorkItemEvent, handleEnabledWorkItemEvent, isCancelledWorkitem, processMapping, sort

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

checkConnection, checkInWorkItem, checkInWorkItem, checkInWorkItem, checkOut, checkOutAllInstancesOfThisTask, connect, describeRequiredParams, destroy, doGet, 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

Method Detail

getInstance

public static SchedulingService getInstance()

getLastSaveTime

public long getLastSaveTime()

getLastSaveMsg

public java.lang.String getLastSaveMsg()

processMappingChild

protected void processMappingChild(Mapping mapping)
                            throws java.lang.Exception

process work item depending on task type check back into the engine remove the mapping for successful processed work items updates the mapping continuously

Specified by:

processMappingChild in class Service

Parameters:

mapping - : contained work item is child

Throws:

java.lang.Exception

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 Service

Parameters:

caseID - the id of the case that has been cancelled

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 Service

Parameters:

caseID - the id of the completed case.

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

checkRelations

public void checkRelations(Document rup)
                    throws JDOMException

check utilisation relations of rup

Parameters:

rup -

Throws:

JDOMException

saveRupToDatabase

public void saveRupToDatabase(java.lang.String caseId,
                              java.lang.String savedBy,
                              Document rup,
                              java.lang.String msg)
                       throws JDOMException,
                              java.sql.SQLException,
                              java.io.IOException

Parameters:

caseId -

savedBy -

rup -

Throws:

JDOMException

java.sql.SQLException

java.io.IOException

loadCase

public Case loadCase(java.lang.String caseId)
              throws java.sql.SQLException

Throws:

java.sql.SQLException

extendRUPFromYAWLModel

public void extendRUPFromYAWLModel(Document doc,
                                   java.util.Set<java.lang.String> addedActivityNames)
                            throws java.lang.Exception

adds new activities from YAWL model specification to document in right order, e.g. if another worklet with new activities was started update times of all activities beginning at last activity which has a time TODO@tbe: returns false also, if order of activities was changed

Parameters:

doc -

Throws:

java.lang.Exception

getDiffActivityNames

public java.util.Set<java.lang.String> getDiffActivityNames(Element e1,
                                                            Element e2)

get activity names of e2 which are not in e1

Parameters:

e1 -

e2 -

Returns:

completeRupFromHistory

public void completeRupFromHistory(Document rup,
                                   java.util.Set<java.lang.String> addedActivitiyNames)

completes a rup with historical data of rups with same ActivityType, but only for new added activities and if data fields are empty yet

Parameters:

rup -

addedActivitiyNames -

getRupList

public java.util.List<Document> getRupList(java.util.List<Case> cases)

loadReservations

public java.util.List<Element> loadReservations(java.lang.String caseId,
                                                java.lang.String activityName)
                                         throws SchedulingException

resource service retrieves reservations for given case and task to utilise them

Parameters:

caseId -

activityName -

Returns:

List

Throws:

SchedulingException

activityStatusChange

public void activityStatusChange(java.lang.String caseId,
                                 java.lang.String activityName,
                                 java.lang.String from,
                                 java.lang.String to)
                          throws SchedulingException

call from rescheduling task in yawl engine if rescheduling of an activity was made

Throws:

SchedulingException

resourceUtilisationChange

public void resourceUtilisationChange(java.lang.String taskID,
                                      java.lang.String caseId,
                                      java.lang.String activityName,
                                      java.lang.String utilisationType,
                                      java.lang.String timeStampXML)
                               throws SchedulingException

call from utilisation task in yawl engine if (de)utilisation for all resources of an activity have to made

Parameters:

timeStampXML - yyyy-MM-ddTHH:mm:ss.SSS

Throws:

SchedulingException

reservationStatusChange

public void reservationStatusChange(java.lang.String caseId,
                                    java.lang.String activityName,
                                    java.lang.Long reservationId,
                                    java.lang.String statusNew)

call from resource service about unavailabilities of resources (if Admin change availability of resource and PLANNING_STATUS was changed to PLANNING_STATUS_NOTAVAILABLE)

updateRunningRups

public void updateRunningRups(java.lang.String savedBy)
                       throws java.lang.Exception

call from JobRUPCheck, sets TO time of running activities to actual time and calculate new DURATION value

Throws:

java.lang.Exception

optimizeAndSaveRup

public java.util.Set<java.lang.String> optimizeAndSaveRup(Document rup,
                                                          java.lang.String savedBy,
                                                          java.lang.String errorMsg,
                                                          boolean resourceChange)
                                                   throws java.lang.Exception

TODO@tbe: was wenn RUP gerade angezeigt/konfiguriert wird?

Parameters:

rup -

errorMsg -

Throws:

java.lang.Exception

sendPushMessage

public void sendPushMessage(java.lang.String address,
                            java.lang.String addressType,
                            java.lang.String msg,
                            java.lang.String caseId)

handleEngineInitialisationCompletedEvent

public void handleEngineInitialisationCompletedEvent()

Description copied from class: Service

the SS and the RS will get the event at the same time, so the SS will need to delay the call to the RS by 10 seconds while the RS gets the credentials from the engine

Overrides:

handleEngineInitialisationCompletedEvent in class Service

registerMessageReceiveServlet

public void registerMessageReceiveServlet()

Register the MessageReceiveServlet with the Resource Service TODO@tbe: better to use our own IP and figure out the port number

getActivityTypes

public java.util.List<java.lang.String> getActivityTypes(java.lang.String activityName,
                                                         java.lang.String newValue)
                                                  throws ResourceGatewayException,
                                                         java.io.IOException

retrieve a list of all activity types for showing in configuration dropdown boxes of custom form

Throws:

YAWLException

ResourceGatewayException

java.io.IOException

startMessageTransfers

public void startMessageTransfers(java.lang.String caseId,
                                  Document rup)

extract message transfers from rup and find/create job group for this rup and update/create job for each message transfer item

Parameters:

rup -

processCachedMappingsTask

public void processCachedMappingsTask()

************************************************************************************** task methods and inner classes ***************************************************************************************