org.yawlfoundation.yawl.engine.interfce.interfaceB

Class InterfaceB_EngineBasedClient

java.lang.Object

org.yawlfoundation.yawl.engine.interfce.Interface_Client

org.yawlfoundation.yawl.engine.interfce.interfaceB.InterfaceB_EngineBasedClient

All Implemented Interfaces:

ObserverGateway

Direct Known Subclasses:

InterfaceB_HttpsEngineBasedClient

public class InterfaceB_EngineBasedClient
extends Interface_Client
implements ObserverGateway

This interface announces specific Engine events to listening custom services

Author:

Lachlan Aldred Date: 22/01/2004 Time: 17:19:12, Michael Adams (refactored for v2.0, 06/2008 - 12/2008)

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.logging.log4j.Logger	_logger

Constructor Summary

Constructors

Constructor and Description
InterfaceB_EngineBasedClient()

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 the cancellation of a case
void	announceCaseCompletion(java.util.Set<YAWLServiceReference> services, YIdentifier caseID, Document caseData) Called by engine to announce when a case is complete.
void	announceCaseCompletion(YAWLServiceReference yawlService, YIdentifier caseID, Document caseData) Called by engine to announce when a case is complete.
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 the deadlock of a case
void	announceEngineInitialised(java.util.Set<YAWLServiceReference> services, int maxWaitSeconds) Called by the engine when it has completed initialisation and is running
void	announceFiredWorkItem(YAnnouncement announcement) PRE: The work item is enabled.
void	announceTimerExpiry(YAnnouncement announcement) Announces a workitem timer expiry
void	announceWorkItemStatusChange(java.util.Set<YAWLServiceReference> services, YWorkItem workItem, YWorkItemStatus oldStatus, YWorkItemStatus newStatus) Notify of a change of status for a work item.
void	cancelWorkItem(YAWLServiceReference yawlService, YWorkItem workItem) Announces work item cancellation to the YAWL Service.
YParameter[]	getRequiredParamsForService(YAWLServiceReference yawlService) Returns an array of YParameter objects that describe the YAWL service being referenced.
java.lang.String	getScheme() Indicates which protocol this shim services.
void	shutdown() Called by the engine to announce shutdown of the engine's servlet container

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

Field Detail

_logger

protected static final org.apache.logging.log4j.Logger _logger

Constructor Detail

InterfaceB_EngineBasedClient

public InterfaceB_EngineBasedClient()

Method Detail

getScheme

public java.lang.String getScheme()

Indicates which protocol this shim services.

Specified by:

getScheme in interface ObserverGateway

Returns:

the scheme

announceFiredWorkItem

public void announceFiredWorkItem(YAnnouncement announcement)

PRE: The work item is enabled. announces a work item to a YAWL Service.

Specified by:

announceFiredWorkItem in interface ObserverGateway

Parameters:

announcement -

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

cancelWorkItem

public void cancelWorkItem(YAWLServiceReference yawlService,
                           YWorkItem workItem)

Announces work item cancellation to the YAWL Service.

Parameters:

yawlService - the YAWL service reference.

workItem - the work item to cancel.

announceTimerExpiry

public void announceTimerExpiry(YAnnouncement announcement)

Announces a workitem timer expiry

Specified by:

announceTimerExpiry in interface ObserverGateway

Parameters:

announcement - the yawl service reference.

announceCaseSuspended

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

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)

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)

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)

Notify of a change of status for a work item.

Specified by:

announceWorkItemStatusChange in interface ObserverGateway

Parameters:

workItem - that has changed

oldStatus - previous status

newStatus - new status

services - the set of services currently registered with the engine

announceCaseStarted

public 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.

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

announceCaseCompletion

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

Called by engine to announce when a case is complete.

Specified by:

announceCaseCompletion in interface ObserverGateway

Parameters:

caseID - the case that completed

caseData - the output data of the case

services - the set of services currently registered with the engine

announceCaseCompletion

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

Called by engine to announce when a case is complete.

Specified by:

announceCaseCompletion in interface ObserverGateway

Parameters:

yawlService - the yawl service

caseID - the case that completed

caseData - the output data of the case

announceEngineInitialised

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

Called by the engine when it has completed initialisation and is running

Specified by:

announceEngineInitialised in interface ObserverGateway

Parameters:

services - a set of custom services to receive the announcement

maxWaitSeconds - the maximum seconds to wait for services to be contactable

announceCaseCancellation

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

Called by the engine to announce the cancellation of a case

Specified by:

announceCaseCancellation in interface ObserverGateway

Parameters:

services - a set of custom services to receive the announcement

id - the case id of the cancelled case

announceDeadlock

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

Called by the engine to announce the deadlock of a case

Specified by:

announceDeadlock in interface ObserverGateway

Parameters:

services - a set of custom services to receive the announcement

id - the case id of the deadlocked case

tasks - the deadlocked tasks

shutdown

public void shutdown()

Called by the engine to announce shutdown of the engine's servlet container

Specified by:

shutdown in interface ObserverGateway

getRequiredParamsForService

public YParameter[] getRequiredParamsForService(YAWLServiceReference yawlService)
                                         throws java.io.IOException,
                                                JDOMException

Returns an array of YParameter objects that describe the YAWL service being referenced.

Parameters:

yawlService - the YAWL service reference.

Returns:

an array of YParameter objects.

Throws:

java.io.IOException - if connection problem

JDOMException - if XML content problem.