org.yawlfoundation.yawl.sandbox

Class YawlClient

java.lang.Object

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

org.yawlfoundation.yawl.sandbox.YawlClient

public class YawlClient
extends InterfaceBWebsideController

A generic YAWL interface client for the Intervention Service

Author:

Michael Adams

Created/Last Date:

7/12/2015

Field Summary

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

Constructor Summary

Constructors

Constructor and Description
YawlClient()

Method Summary

Modifier and Type	Method and Description
void	addCaseCompletionListener(CaseCompletionListener listener) Adds a listener for case completions
boolean	cancelCase(java.lang.String caseID) Cancels a currently executing case
java.lang.String	getSpecificationXMLForCase(java.lang.String caseID) Gets an XML representation of the specification of which the case is an instance
java.util.List<WorkItemRecord>	getWorkItemsForCase(java.lang.String caseID) Returns the current set of active workitems for a case
void	handleCancelledCaseEvent(java.lang.String caseID) Receives notification from the engine that an active case has been cancelled.
void	handleCancelledWorkItemEvent(WorkItemRecord workItemRecord) Receives notification from the engine that an active workitem 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	handleEnabledWorkItemEvent(WorkItemRecord enabledWorkItem) Receives notification from the engine of an enabled workitem.
java.lang.String	launchCase(YSpecificationID specID) Starts a new instance of a specification
java.lang.String	launchCase(YSpecificationID specID, java.lang.String caseParams) Starts a new instance of a specification
java.lang.String	launchCase(YSpecificationID specID, java.lang.String caseParams, YLogDataItemList logData) Starts a new instance of a specification
void	removeCaseCompletionListener(CaseCompletionListener listener) Removes a listener for case completions
boolean	resumeCase(java.lang.String caseID) Resumes a currently suspended case
boolean	suspendCase(java.lang.String caseID) Suspends a currently executing case
boolean	uploadSpecification(java.lang.String xml) Loads a specification into the engine

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

Constructor Detail

YawlClient

public YawlClient()

Method Detail

addCaseCompletionListener

public void addCaseCompletionListener(CaseCompletionListener listener)

Adds a listener for case completions

Parameters:

listener - the CaseCompletionListener to be added

removeCaseCompletionListener

public void removeCaseCompletionListener(CaseCompletionListener listener)

Removes a listener for case completions

Parameters:

listener - the CaseCompletionListener to be removed

getSpecificationXMLForCase

public java.lang.String getSpecificationXMLForCase(java.lang.String caseID)
                                            throws java.io.IOException

Gets an XML representation of the specification of which the case is an instance

Parameters:

caseID - the case identifier to get te specification for

Returns:

the specification as XML

Throws:

java.io.IOException - if there is a problem connecting to the engine, or if the engine is unable to retrieve the specification

uploadSpecification

public boolean uploadSpecification(java.lang.String xml)
                            throws java.io.IOException

Loads a specification into the engine

Parameters:

xml - the specification as XML

Returns:

true if the load was successful

Throws:

java.io.IOException - if there is a problem connecting to the engine, or if the engine is unable to load the specification

launchCase

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

Starts a new instance of a specification

Parameters:

specID - the specification identifier to start an instance of

Returns:

the case identifier for the newly started case

Throws:

java.io.IOException - if there is a problem connecting to the engine, or if the engine is unable to start an instance of the specification

launchCase

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

Starts a new instance of a specification

Parameters:

specID - the specification identifier to start an instance of

caseParams - an XML representation of input net variable data (may be null)

Returns:

the case identifier for the newly started case

Throws:

java.io.IOException - if there is a problem connecting to the engine, or if the engine is unable to start an instance of the specification

launchCase

public java.lang.String launchCase(YSpecificationID specID,
                                   java.lang.String caseParams,
                                   YLogDataItemList logData)
                            throws java.io.IOException

Starts a new instance of a specification

Parameters:

specID - the specification identifier to start an instance of

caseParams - an XML representation of input net variable data (may be null)

logData - a set of additional values to be logged with the case start

Returns:

the case identifier for the newly started case

Throws:

java.io.IOException - if there is a problem connecting to the engine, or if the engine is unable to start an instance of the specification

cancelCase

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

Cancels a currently executing case

Parameters:

caseID - the identifier of the case to cancel

Returns:

true if the cancellation succeeded

Throws:

java.io.IOException - if there is a problem connecting to the engine, or if the engine is unable to cancel the case

suspendCase

public boolean suspendCase(java.lang.String caseID)
                    throws java.io.IOException

Suspends a currently executing case

Parameters:

caseID - the identifier of the case to suspend

Returns:

true if the suspension succeeded

Throws:

java.io.IOException - if there is a problem connecting to the engine, or if the engine is unable to suspend the case

resumeCase

public boolean resumeCase(java.lang.String caseID)
                   throws java.io.IOException

Resumes a currently suspended case

Parameters:

caseID - the identifier of the case to resume

Returns:

true if the resumption succeeded

Throws:

java.io.IOException - if there is a problem connecting to the engine, or if the engine is unable to resume the case

getWorkItemsForCase

public java.util.List<WorkItemRecord> getWorkItemsForCase(java.lang.String caseID)
                                                   throws java.io.IOException

Returns the current set of active workitems for a case

Parameters:

caseID - the case in question

Returns:

a list of live workitems (as WorkItemRecords)

Throws:

java.io.IOException - if engine can't be found.

handleEnabledWorkItemEvent

public void handleEnabledWorkItemEvent(WorkItemRecord enabledWorkItem)

Description copied from class: InterfaceBWebsideController

Receives notification from the engine of an enabled workitem. Typically, a custom service will implement this method to check out the work item, and process it as appropriate for the service.

Specified by:

handleEnabledWorkItemEvent in class InterfaceBWebsideController

Parameters:

enabledWorkItem - the enabled work item

handleCancelledWorkItemEvent

public void handleCancelledWorkItemEvent(WorkItemRecord workItemRecord)

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:

workItemRecord - the cancelled work item

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

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