org.yawlfoundation.yawl.balancer.servlet

Class CaseCompletedObserver

java.lang.Object

org.yawlfoundation.yawl.engine.interfce.Interface_Client

org.yawlfoundation.yawl.balancer.servlet.CaseCompletedObserver

All Implemented Interfaces:

ObserverGateway

public class CaseCompletedObserver
extends Interface_Client
implements ObserverGateway

Author:

Michael Adams

Created/Last Date:

13/6/18

Constructor Summary

Constructors

Constructor and Description
CaseCompletedObserver()

Method Summary

Modifier and Type	Method and Description
void	announceCancelledWorkItem(YAnnouncement announcement) Called by the engine when a previously posted workitem has been cancelled.
void	announceCaseCancellation(java.util.Set<YAWLServiceReference> services, YIdentifier id) Called by the engine to announce a case has been cancelled.
void	announceCaseCompletion(java.util.Set<YAWLServiceReference> services, YIdentifier caseID, Document caseData) Called by engine to announce when a case is complete and a completion observer was not specified at case launch.
void	announceCaseCompletion(YAWLServiceReference yawlService, YIdentifier caseID, Document caseData) Called by engine when a case is complete and a completion observer was specified at case launch.
void	announceCaseResumption(java.util.Set<YAWLServiceReference> services, YIdentifier caseID) Called by the engine to announce when a case resumes from a previous 'suspending' or 'suspended' state.
void	announceCaseStarted(java.util.Set<YAWLServiceReference> services, YSpecificationID specID, YIdentifier caseID, java.lang.String launchingService, boolean delayed) Called by engine to announce when a case has commenced.
void	announceCaseSuspended(java.util.Set<YAWLServiceReference> services, YIdentifier caseID) Called by the engine to announce when a case suspends (i.e.
void	announceCaseSuspending(java.util.Set<YAWLServiceReference> services, YIdentifier caseID) Called by the engine to announce when a case starts to suspends (i.e.
void	announceDeadlock(java.util.Set<YAWLServiceReference> services, YIdentifier id, java.util.Set<YTask> tasks) Called by the engine to announce that a case has deadlocked
void	announceEngineInitialised(java.util.Set<YAWLServiceReference> services, int maxWaitSeconds) Called by the engine to notify that it has completed initialisation and is running.
void	announceFiredWorkItem(YAnnouncement announcement) Called by the engine when a new workitem gets enabled.
void	announceTimerExpiry(YAnnouncement announcement) Called by the engine when a timer for a workitem expires.
void	announceWorkItemStatusChange(java.util.Set<YAWLServiceReference> services, YWorkItem workItem, YWorkItemStatus oldStatus, YWorkItemStatus newStatus) Called by the engine to notify of a change of status for a work item.
java.lang.String	getScheme() Gets the scheme part of the url of an implementing gateway.
void	shutdown() Called when the Engine is shutdown (servlet destroyed); the observer gateway should to do its own finalisation processing.

Methods inherited from class org.yawlfoundation.yawl.engine.interfce.Interface_Client

executeGet, executePost, getReply, initPostConnection, prepareParamMap, send, setReadTimeout, stripOuterElement, successful

Methods inherited from class java.lang.Object

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

Constructor Detail

CaseCompletedObserver

public CaseCompletedObserver()

Method Detail

getScheme

public java.lang.String getScheme()

Description copied from interface: ObserverGateway

Gets the scheme part of the url of an implementing gateway.

Specified by:

getScheme in interface ObserverGateway

Returns:

the scheme of the gateway

announceCaseCompletion

public void announceCaseCompletion(YAWLServiceReference yawlService,
                                   YIdentifier caseID,
                                   Document caseData)

Description copied from interface: ObserverGateway

Called by engine when a case is complete and a completion observer was specified at case launch.

Specified by:

announceCaseCompletion in interface ObserverGateway

Parameters:

yawlService - the yawl service nominated as the completion observer

caseID - the case that completed

caseData - the output data of the case

announceCaseCompletion

public void announceCaseCompletion(java.util.Set<YAWLServiceReference> services,
                                   YIdentifier caseID,
                                   Document caseData)

Description copied from interface: ObserverGateway

Called by engine to announce when a case is complete and a completion observer was not specified at case launch. This announcement is sent to all services on all registered gateways.

Specified by:

announceCaseCompletion in interface ObserverGateway

Parameters:

services - the set of services currently registered with the engine

caseID - the case that completed

caseData - the output data of the case

announceCaseCancellation

public void announceCaseCancellation(java.util.Set<YAWLServiceReference> services,
                                     YIdentifier id)

Description copied from interface: ObserverGateway

Called by the engine to announce a case has been cancelled.

Specified by:

announceCaseCancellation in interface ObserverGateway

Parameters:

services - the set of services currently registered with the engine

id - the identifier of the cancelled case

announceFiredWorkItem

public void announceFiredWorkItem(YAnnouncement announcement)

Description copied from interface: ObserverGateway

Called by the engine when a new workitem gets enabled.

Specified by:

announceFiredWorkItem in interface ObserverGateway

Parameters:

announcement - the work item descriptors

announceCancelledWorkItem

public void announceCancelledWorkItem(YAnnouncement announcement)

Description copied from interface: ObserverGateway

Called by the engine when a previously posted workitem has been cancelled.

Specified by:

announceCancelledWorkItem in interface ObserverGateway

Parameters:

announcement - the work item descriptors

announceTimerExpiry

public void announceTimerExpiry(YAnnouncement announcement)

Description copied from interface: ObserverGateway

Called by the engine when a timer for a workitem expires.

Specified by:

announceTimerExpiry in interface ObserverGateway

Parameters:

announcement - the work item descriptors

announceCaseStarted

public void announceCaseStarted(java.util.Set<YAWLServiceReference> services,
                                YSpecificationID specID,
                                YIdentifier caseID,
                                java.lang.String launchingService,
                                boolean delayed)

Description copied from interface: ObserverGateway

Called by engine to announce when a case has commenced.

Specified by:

announceCaseStarted in interface ObserverGateway

Parameters:

services - the set of registered custom services

specID - the specification id of the started case

caseID - the case that has started

launchingService - the service that started the case

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

announceCaseSuspended

public void announceCaseSuspended(java.util.Set<YAWLServiceReference> services,
                                  YIdentifier caseID)

Description copied from interface: ObserverGateway

Called by the engine to announce when a case suspends (i.e. becomes fully suspended as opposed to entering the 'suspending' state).

Specified by:

announceCaseSuspended in interface ObserverGateway

Parameters:

services - the set of services currently registered with the engine

caseID - the identifier of the suspended case

announceCaseSuspending

public void announceCaseSuspending(java.util.Set<YAWLServiceReference> services,
                                   YIdentifier caseID)

Description copied from interface: ObserverGateway

Called by the engine to announce when a case starts to suspends (i.e. enters the suspending state as opposed to entering the fully 'suspended' state).

Specified by:

announceCaseSuspending in interface ObserverGateway

Parameters:

services - the set of services currently registered with the engine

caseID - the identifier of the suspending case

announceCaseResumption

public void announceCaseResumption(java.util.Set<YAWLServiceReference> services,
                                   YIdentifier caseID)

Description copied from interface: ObserverGateway

Called by the engine to announce when a case resumes from a previous 'suspending' or 'suspended' state.

Specified by:

announceCaseResumption in interface ObserverGateway

Parameters:

services - the set of services currently registered with the engine

caseID - the identifier of the suspended case

announceWorkItemStatusChange

public void announceWorkItemStatusChange(java.util.Set<YAWLServiceReference> services,
                                         YWorkItem workItem,
                                         YWorkItemStatus oldStatus,
                                         YWorkItemStatus newStatus)

Description copied from interface: ObserverGateway

Called by the engine to notify of a change of status for a work item.

Specified by:

announceWorkItemStatusChange in interface ObserverGateway

Parameters:

services - the set of services currently registered with the engine

workItem - that has changed

oldStatus - previous status

newStatus - new status

announceEngineInitialised

public void announceEngineInitialised(java.util.Set<YAWLServiceReference> services,
                                      int maxWaitSeconds)

Description copied from interface: ObserverGateway

Called by the engine to notify that it has completed initialisation and is running.

Specified by:

announceEngineInitialised in interface ObserverGateway

Parameters:

services - the set of services currently registered with the engine

maxWaitSeconds - the maximum amount of time to wait attempting to contact the services managed by the gateway before giving up

announceDeadlock

public void announceDeadlock(java.util.Set<YAWLServiceReference> services,
                             YIdentifier id,
                             java.util.Set<YTask> tasks)

Description copied from interface: ObserverGateway

Called by the engine to announce that a case has deadlocked

Specified by:

announceDeadlock in interface ObserverGateway

Parameters:

services - the set of services currently registered with the engine

id - the identifier of the deadlocked case

tasks - the set of deadlocked tasks

shutdown

public void shutdown()

Description copied from interface: ObserverGateway

Called when the Engine is shutdown (servlet destroyed); the observer gateway should to do its own finalisation processing.

Specified by:

shutdown in interface ObserverGateway