org.yawlfoundation.yawl.engine.interfce

Class EngineGatewayImpl

java.lang.Object

org.yawlfoundation.yawl.engine.interfce.EngineGatewayImpl

All Implemented Interfaces:

java.rmi.Remote, EngineGateway

public class EngineGatewayImpl
extends java.lang.Object
implements EngineGateway

This class allows access to all of the engines capabilities using Strings and XML interface to pass information.

Author:

Lachlan Aldred Date: 21/01/2004 Time: 11:58:18, Michael Adams (for v2)

Constructor Summary

Constructors

Constructor and Description
EngineGatewayImpl(boolean persist) Constructor
EngineGatewayImpl(boolean persist, boolean gatherHbnStats) Constructor
EngineGatewayImpl(java.lang.Class<? extends YEngine> engine, boolean persist, boolean gatherHbnStats)
EngineGatewayImpl(java.lang.Class<? extends YEngine> engine, boolean persist, boolean gatherHbnStats, boolean redundantMode)

Method Summary

Modifier and Type	Method and Description
java.lang.String	addInterfaceXListener(java.lang.String listenerURI) The following methods are called by an Exception Service via Interface_X
java.lang.String	addYAWLService(java.lang.String serviceStr, java.lang.String sessionHandle) Adds a new YAWL service to the engine
java.lang.String	cancelCase(java.lang.String caseID, java.lang.String sessionHandle) Cancels a running case.
java.lang.String	cancelWorkItem(java.lang.String workItemID, java.lang.String data, java.lang.String fail, java.lang.String sessionHandle)
java.lang.String	changePassword(java.lang.String password, java.lang.String sessionHandle)
java.lang.String	checkConnection(java.lang.String sessionHandle)
java.lang.String	checkConnectionForAdmin(java.lang.String sessionHandle) Deprecated. no longer valid - performs same function as 'checkConnection'
java.lang.String	checkElegibilityToAddInstances(java.lang.String workItemID, java.lang.String sessionHandle)
java.lang.String	completeWorkItem(java.lang.String workItemID, java.lang.String data, java.lang.String logPredicate, boolean force, java.lang.String sessionHandle)
java.lang.String	connect(java.lang.String userID, java.lang.String password, long timeOutSeconds)
java.lang.String	createAccount(java.lang.String userName, java.lang.String password, java.lang.String doco, java.lang.String sessionHandle) Creates a new external client account in the system.
java.lang.String	createNewInstance(java.lang.String workItemID, java.lang.String paramValueForMICreation, java.lang.String sessionHandle) Creates a workitem sibling of of the workitemid param.
java.lang.String	deleteAccount(java.lang.String client, java.lang.String sessionHandle) Deprecated. The YAWL Engine no longer maintains users directly
java.lang.String	demote(java.lang.String sessionHandle)
java.lang.String	describeAllWorkItems(java.lang.String sessionHandle)
void	disableLogging() Disables the recording of events in the process logs
java.lang.String	disconnect(java.lang.String sessionHandle)
boolean	enginePersistenceFailure() Indicates if the engine has encountered some form of persistence failure in its lifetime.
java.lang.String	exportAllCaseStates(java.lang.String sessionHandle)
java.lang.String	exportCaseState(java.lang.String caseID, java.lang.String sessionHandle)
java.lang.String	getAccounts(java.lang.String sessionHandle) Gets the list of external accounts in the system.
java.lang.String	getAllRunningCases(java.lang.String sessionHandle)
java.lang.String	getAvailableWorkItemIDs(java.lang.String sessionHandle) Gets a list of the ids of all currently active workitems
java.lang.String	getBuildProperties(java.lang.String sessionHandle)
java.lang.String	getCaseData(java.lang.String caseID, java.lang.String sessionHandle)
java.lang.String	getCaseInstanceSummary(java.lang.String sessionHandle)
java.lang.String	getCasesForSpecification(YSpecificationID specID, java.lang.String sessionHandle) Given a process specification id return the cases that are its running instances.
java.lang.String	getCaseState(java.lang.String caseID, java.lang.String sessionHandle) This method returns a complex XML message containing the state of a particular case.
java.lang.String	getChildrenOfWorkItem(java.lang.String workItemID, java.lang.String sessionHandle) Gets the child work items of a given work item id string.
java.lang.String	getClientAccount(java.lang.String userID, java.lang.String sessionHandle)
java.lang.String	getClientPassword(java.lang.String userID, java.lang.String sessionHandle)
java.lang.String	getExternalDBGateways(java.lang.String sessionHandle)
java.lang.String	getHibernateStatistics(java.lang.String sessionHandle)
java.lang.String	getLatestSpecVersion(java.lang.String id, java.lang.String sessionHandle)
java.lang.String	getMITaskAttributes(YSpecificationID specificationID, java.lang.String taskID, java.lang.String sessionHandle)
java.lang.String	getParameterInstanceSummary(java.lang.String caseID, java.lang.String itemID, java.lang.String sessionHandle)
java.lang.String	getProcessDefinition(YSpecificationID specID, java.lang.String sessionHandle)
java.lang.String	getResourcingSpecs(YSpecificationID specificationID, java.lang.String taskID, java.lang.String sessionHandle)
java.lang.String	getSpecificationData(YSpecificationID specID, java.lang.String sessionHandle)
java.lang.String	getSpecificationDataSchema(YSpecificationID specID, java.lang.String sessionHandle)
java.lang.String	getSpecificationForCase(java.lang.String caseIDStr, java.lang.String sessionHandle)
java.lang.String	getSpecificationIDForCase(java.lang.String caseIDStr, java.lang.String sessionHandle)
java.lang.String	getSpecificationList(java.lang.String sessionHandle) Gets a listing of
java.lang.String	getStartingDataSnapshot(java.lang.String workItemID, java.lang.String sessionHandle)
java.lang.String	getTaskInformation(YSpecificationID specificationID, java.lang.String taskID, java.lang.String sessionHandle)
java.lang.String	getWorkItem(java.lang.String workItemID, java.lang.String sessionHandle)
java.lang.String	getWorkItemExpiryTime(java.lang.String workItemID, java.lang.String sessionHandle)
java.lang.String	getWorkItemInstanceSummary(java.lang.String caseID, java.lang.String sessionHandle)
java.lang.String	getWorkItemOptions(java.lang.String workItemID, java.lang.String thisURL, java.lang.String sessionHandle) Provides an XML list of options for manipulating a work item.
java.lang.String	getWorkItemsForService(java.lang.String serviceURI, java.lang.String sessionHandle)
java.lang.String	getWorkItemsWithIdentifier(java.lang.String idType, java.lang.String itemID, java.lang.String sessionHandle)
java.lang.String	getYAWLServiceDocumentation(java.lang.String yawlServiceURI, java.lang.String sessionHandle) Gets the documentation associated with the yawl service
java.lang.String	getYAWLServices(java.lang.String sessionHandle) Returns an XML list (unrooted) of yawlService elements.
java.lang.String	importCases(java.lang.String caseXML, java.lang.String sessionHandle)
void	initBuildProperties(java.io.InputStream stream) Loads build properties from the stream (build number, date, version)
java.lang.String	isHibernateStatisticsEnabled(java.lang.String sessionHandle)
boolean	isRedundantMode()
java.lang.String	launchCase(YSpecificationID specID, java.lang.String caseParams, java.net.URI caseCompletionURI, java.lang.String logDataStr, java.util.Date expiry, java.lang.String sessionHandle)
java.lang.String	launchCase(YSpecificationID specID, java.lang.String caseParams, java.net.URI caseCompletionURI, java.lang.String logDataStr, javax.xml.datatype.Duration duration, java.lang.String sessionHandle)
java.lang.String	launchCase(YSpecificationID specID, java.lang.String caseParams, java.net.URI caseCompletionURI, java.lang.String logDataStr, long mSec, java.lang.String sessionHandle)
java.lang.String	launchCase(YSpecificationID specID, java.lang.String caseParams, java.net.URI caseCompletionURI, java.lang.String logDataStr, java.lang.String sessionHandle)
java.lang.String	launchCase(YSpecificationID specID, java.lang.String caseParams, java.net.URI caseCompletionURI, java.lang.String caseID, java.lang.String logDataStr, java.lang.String sessionHandle)
java.lang.String	loadSpecification(java.lang.String specificationStr, java.lang.String sessionHandle) Allows the user to load a specificationStr.
void	notifyServletInitialisationComplete(int maxWaitSeconds) Triggers the announcement that engine startup is complete.
java.lang.String	promote(java.lang.String sessionHandle)
void	registerObserverGateway(ObserverGateway gateway) Registers an external observer gateway with the engine
java.lang.String	rejectAnnouncedEnabledTask(java.lang.String itemID, java.lang.String sessionHandle)
java.lang.String	removeInterfaceXListener(java.lang.String listenerURI)
java.lang.String	removeYAWLService(java.lang.String serviceURI, java.lang.String sessionHandle)
java.lang.String	restartWorkItem(java.lang.String workItemID, java.lang.String sessionHandle)
java.lang.String	rollbackWorkItem(java.lang.String workItemID, java.lang.String sessionHandle)
void	setActualFilePath(java.lang.String path) Sets the actual absolute file location which contains the engine's class file root
void	setAllowAdminID(boolean allow) Enables or disables the use of the generic 'admin' user
void	setDefaultWorklist(java.lang.String url) Sets the URL for the 'default' worklist - i.e.
void	setHibernateStatisticsEnabled(boolean enabled) Enables or disables the gathering of hibernate statistics
java.lang.String	setHibernateStatisticsEnabled(boolean enabled, java.lang.String sessionHandle)
void	shutdown() Notifies the engine that its servlet is shutting down
java.lang.String	skipWorkItem(java.lang.String workItemID, java.lang.String sessionHandle)
java.lang.String	startWorkItem(java.lang.String workItemID, java.lang.String sessionHandle)
java.lang.String	suspendWorkItem(java.lang.String workItemID, java.lang.String sessionHandle)
java.lang.String	unloadSpecification(YSpecificationID specID, java.lang.String sessionHandle) Unloads the specification.
java.lang.String	unsuspendWorkItem(java.lang.String workItemID, java.lang.String sessionHandle)
java.lang.String	updateAccount(java.lang.String userName, java.lang.String password, java.lang.String doco, java.lang.String sessionHandle) Creates a new external client account in the system.
java.lang.String	updateCaseData(java.lang.String caseID, java.lang.String data, java.lang.String sessionHandle)
java.lang.String	updateWorkItemData(java.lang.String workItemID, java.lang.String data, java.lang.String sessionHandle)

Methods inherited from class java.lang.Object

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

Constructor Detail

EngineGatewayImpl

public EngineGatewayImpl(boolean persist)
                  throws YPersistenceException

Constructor

Parameters:

persist - true if a reference to a persisting engine is required

Throws:

YPersistenceException - if persist is true and a persisting engine is unavailable

EngineGatewayImpl

public EngineGatewayImpl(boolean persist,
                         boolean gatherHbnStats)
                  throws YPersistenceException

Constructor

Parameters:

persist - true if a reference to a persisting engine is required

gatherHbnStats - true to turn on hibernate statistics gathering

Throws:

YPersistenceException - if persist is true and a persisting engine is unavailable

EngineGatewayImpl

public EngineGatewayImpl(java.lang.Class<? extends YEngine> engine,
                         boolean persist,
                         boolean gatherHbnStats)
                  throws YPersistenceException

Throws:

YPersistenceException

EngineGatewayImpl

public EngineGatewayImpl(java.lang.Class<? extends YEngine> engine,
                         boolean persist,
                         boolean gatherHbnStats,
                         boolean redundantMode)
                  throws YPersistenceException

Throws:

YPersistenceException

Method Detail

enginePersistenceFailure

public boolean enginePersistenceFailure()

Indicates if the engine has encountered some form of persistence failure in its lifetime.

Specified by:

enginePersistenceFailure in interface EngineGateway

Returns:

whether or not the engine has failed to achieve persistence

registerObserverGateway

public void registerObserverGateway(ObserverGateway gateway)
                             throws YAWLException

Registers an external observer gateway with the engine

Specified by:

registerObserverGateway in interface EngineGateway

Parameters:

gateway - the gateway to register

Throws:

YAWLException - if the observerGateway has a null scheme value.

setDefaultWorklist

public void setDefaultWorklist(java.lang.String url)

Sets the URL for the 'default' worklist - i.e. the service that will receive task enabled notifications for those tasks that are not explicitly associated with a custom service

Specified by:

setDefaultWorklist in interface EngineGateway

Parameters:

url - the URL of the service that will serve as the default worklist

setAllowAdminID

public void setAllowAdminID(boolean allow)

Enables or disables the use of the generic 'admin' user

Specified by:

setAllowAdminID in interface EngineGateway

Parameters:

allow - true to enable, false to disable

disableLogging

public void disableLogging()

Disables the recording of events in the process logs

Specified by:

disableLogging in interface EngineGateway

setHibernateStatisticsEnabled

public void setHibernateStatisticsEnabled(boolean enabled)

Enables or disables the gathering of hibernate statistics

Specified by:

setHibernateStatisticsEnabled in interface EngineGateway

Parameters:

enabled - true to enable, false to disable

initBuildProperties

public void initBuildProperties(java.io.InputStream stream)

Loads build properties from the stream (build number, date, version)

Specified by:

initBuildProperties in interface EngineGateway

Parameters:

stream - a stream of the file containing the build properties

shutdown

public void shutdown()

Notifies the engine that its servlet is shutting down

Specified by:

shutdown in interface EngineGateway

notifyServletInitialisationComplete

public void notifyServletInitialisationComplete(int maxWaitSeconds)

Triggers the announcement that engine startup is complete. Should only be called from InterfaceB_EngineBasedServer.init()

Specified by:

notifyServletInitialisationComplete in interface EngineGateway

Parameters:

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

setActualFilePath

public void setActualFilePath(java.lang.String path)

Sets the actual absolute file location which contains the engine's class file root

Specified by:

setActualFilePath in interface EngineGateway

Parameters:

path - the file path

getAvailableWorkItemIDs

public java.lang.String getAvailableWorkItemIDs(java.lang.String sessionHandle)
                                         throws java.rmi.RemoteException

Gets a list of the ids of all currently active workitems

Specified by:

getAvailableWorkItemIDs in interface EngineGateway

Parameters:

sessionHandle - a valid session handle

Returns:

a list of the ids

Throws:

java.rmi.RemoteException

getWorkItem

public java.lang.String getWorkItem(java.lang.String workItemID,
                                    java.lang.String sessionHandle)
                             throws java.rmi.RemoteException

Specified by:

getWorkItem in interface EngineGateway

Parameters:

workItemID -

sessionHandle -

Returns:

the full work item record of the workitem with the id passed

Throws:

java.rmi.RemoteException

getWorkItemExpiryTime

public java.lang.String getWorkItemExpiryTime(java.lang.String workItemID,
                                              java.lang.String sessionHandle)
                                       throws java.rmi.RemoteException

Specified by:

getWorkItemExpiryTime in interface EngineGateway

Throws:

java.rmi.RemoteException

getProcessDefinition

public java.lang.String getProcessDefinition(YSpecificationID specID,
                                             java.lang.String sessionHandle)
                                      throws java.rmi.RemoteException

Specified by:

getProcessDefinition in interface EngineGateway

Parameters:

specID - the specification (process definition id)

sessionHandle - the sessionhandle

Returns:

a string version of the process definition

Throws:

java.rmi.RemoteException

getSpecificationDataSchema

public java.lang.String getSpecificationDataSchema(YSpecificationID specID,
                                                   java.lang.String sessionHandle)
                                            throws java.rmi.RemoteException

Specified by:

getSpecificationDataSchema in interface EngineGateway

Throws:

java.rmi.RemoteException

suspendWorkItem

public java.lang.String suspendWorkItem(java.lang.String workItemID,
                                        java.lang.String sessionHandle)
                                 throws java.rmi.RemoteException

Specified by:

suspendWorkItem in interface EngineGateway

Parameters:

workItemID -

sessionHandle -

Returns:

the suspended workitem record

Throws:

java.rmi.RemoteException

unsuspendWorkItem

public java.lang.String unsuspendWorkItem(java.lang.String workItemID,
                                          java.lang.String sessionHandle)
                                   throws java.rmi.RemoteException

Specified by:

unsuspendWorkItem in interface EngineGateway

Parameters:

workItemID -

sessionHandle -

Returns:

the resumed workitem record

Throws:

java.rmi.RemoteException

rollbackWorkItem

public java.lang.String rollbackWorkItem(java.lang.String workItemID,
                                         java.lang.String sessionHandle)
                                  throws java.rmi.RemoteException

Specified by:

rollbackWorkItem in interface EngineGateway

Parameters:

workItemID -

sessionHandle -

Returns:

the rooled back work item record

Throws:

java.rmi.RemoteException

completeWorkItem

public java.lang.String completeWorkItem(java.lang.String workItemID,
                                         java.lang.String data,
                                         java.lang.String logPredicate,
                                         boolean force,
                                         java.lang.String sessionHandle)
                                  throws java.rmi.RemoteException

Specified by:

completeWorkItem in interface EngineGateway

Parameters:

workItemID - work item id

data - data

logPredicate - a pre-parsed configurable logging string

force - true if this is a forded completion

sessionHandle - sessionhandle

Returns:

result XML message.

Throws:

java.rmi.RemoteException - if used in RMI mode

startWorkItem

public java.lang.String startWorkItem(java.lang.String workItemID,
                                      java.lang.String sessionHandle)
                               throws java.rmi.RemoteException

Specified by:

startWorkItem in interface EngineGateway

Parameters:

workItemID -

sessionHandle -

Returns:

the started child workitem

Throws:

java.rmi.RemoteException

getStartingDataSnapshot

public java.lang.String getStartingDataSnapshot(java.lang.String workItemID,
                                                java.lang.String sessionHandle)
                                         throws java.rmi.RemoteException

Specified by:

getStartingDataSnapshot in interface EngineGateway

Throws:

java.rmi.RemoteException

skipWorkItem

public java.lang.String skipWorkItem(java.lang.String workItemID,
                                     java.lang.String sessionHandle)
                              throws java.rmi.RemoteException

Specified by:

skipWorkItem in interface EngineGateway

Parameters:

workItemID -

sessionHandle -

Returns:

the skipped work item record

Throws:

java.rmi.RemoteException

createNewInstance

public java.lang.String createNewInstance(java.lang.String workItemID,
                                          java.lang.String paramValueForMICreation,
                                          java.lang.String sessionHandle)
                                   throws java.rmi.RemoteException

Creates a workitem sibling of of the workitemid param. It will only do this if: 1) the task for workItemID is multi-instance, 2) and if the task for workItemID is busy 2) and if the task for workItemID allows dynamic instance creation, 3) and if the number of instances has no yet reached max instances.

Specified by:

createNewInstance in interface EngineGateway

Parameters:

workItemID - the id of an existing instance to which to add a new instance

paramValueForMICreation - the data needed to create the new instance

sessionHandle - session handle

Returns:

an xml message indicating result.

Throws:

java.rmi.RemoteException

describeAllWorkItems

public java.lang.String describeAllWorkItems(java.lang.String sessionHandle)
                                      throws java.rmi.RemoteException

Specified by:

describeAllWorkItems in interface EngineGateway

Parameters:

sessionHandle -

Returns:

a description (record) of all currently active workitems

Throws:

java.rmi.RemoteException

getWorkItemsWithIdentifier

public java.lang.String getWorkItemsWithIdentifier(java.lang.String idType,
                                                   java.lang.String itemID,
                                                   java.lang.String sessionHandle)
                                            throws java.rmi.RemoteException

Specified by:

getWorkItemsWithIdentifier in interface EngineGateway

Throws:

java.rmi.RemoteException

getWorkItemsForService

public java.lang.String getWorkItemsForService(java.lang.String serviceURI,
                                               java.lang.String sessionHandle)
                                        throws java.rmi.RemoteException

Specified by:

getWorkItemsForService in interface EngineGateway

Throws:

java.rmi.RemoteException

connect

public java.lang.String connect(java.lang.String userID,
                                java.lang.String password,
                                long timeOutSeconds)
                         throws java.rmi.RemoteException

Specified by:

connect in interface EngineGateway

Parameters:

userID -

password -

Returns:

a sessionhandle

Throws:

java.rmi.RemoteException

checkConnection

public java.lang.String checkConnection(java.lang.String sessionHandle)
                                 throws java.rmi.RemoteException

Specified by:

checkConnection in interface EngineGateway

Parameters:

sessionHandle -

Returns:

'true' if the connection is valid

Throws:

java.rmi.RemoteException

disconnect

public java.lang.String disconnect(java.lang.String sessionHandle)
                            throws java.rmi.RemoteException

Specified by:

disconnect in interface EngineGateway

Throws:

java.rmi.RemoteException

checkConnectionForAdmin

public java.lang.String checkConnectionForAdmin(java.lang.String sessionHandle)

Deprecated. no longer valid - performs same function as 'checkConnection'

Specified by:

checkConnectionForAdmin in interface EngineGateway

Parameters:

sessionHandle -

Returns:

either "" or "..."

getTaskInformation

public java.lang.String getTaskInformation(YSpecificationID specificationID,
                                           java.lang.String taskID,
                                           java.lang.String sessionHandle)
                                    throws java.rmi.RemoteException

Specified by:

getTaskInformation in interface EngineGateway

Parameters:

specificationID -

taskID -

sessionHandle -

Returns:

a task information record

Throws:

java.rmi.RemoteException

checkElegibilityToAddInstances

public java.lang.String checkElegibilityToAddInstances(java.lang.String workItemID,
                                                       java.lang.String sessionHandle)

Specified by:

checkElegibilityToAddInstances in interface EngineGateway

Parameters:

workItemID -

sessionHandle -

Returns:

either "<success/>" or <failure><reason>...</...>

getSpecificationList

public java.lang.String getSpecificationList(java.lang.String sessionHandle)
                                      throws java.rmi.RemoteException

Gets a listing of

Specified by:

getSpecificationList in interface EngineGateway

Parameters:

sessionHandle -

Returns:

a list of currently loaded specifications

Throws:

java.rmi.RemoteException

getSpecificationData

public java.lang.String getSpecificationData(YSpecificationID specID,
                                             java.lang.String sessionHandle)
                                      throws java.rmi.RemoteException

Specified by:

getSpecificationData in interface EngineGateway

Throws:

java.rmi.RemoteException

launchCase

public java.lang.String launchCase(YSpecificationID specID,
                                   java.lang.String caseParams,
                                   java.net.URI caseCompletionURI,
                                   java.lang.String caseID,
                                   java.lang.String logDataStr,
                                   java.lang.String sessionHandle)

Specified by:

launchCase in interface EngineGateway

Parameters:

specID - specID

caseParams - format <data>[InputParam]*</data> where InputParam == <varName>var value</varName>

caseID - caseID

sessionHandle -

Returns:

the case id of the launched case, or a diagnostic msg.

launchCase

public java.lang.String launchCase(YSpecificationID specID,
                                   java.lang.String caseParams,
                                   java.net.URI caseCompletionURI,
                                   java.lang.String logDataStr,
                                   java.lang.String sessionHandle)

Specified by:

launchCase in interface EngineGateway

Parameters:

specID - specID

caseParams - format <data>[InputParam]*</data> where InputParam == <varName>var value</varName>

sessionHandle -

Returns:

the case id of the launched case, or a diagnostic msg.

launchCase

public java.lang.String launchCase(YSpecificationID specID,
                                   java.lang.String caseParams,
                                   java.net.URI caseCompletionURI,
                                   java.lang.String logDataStr,
                                   long mSec,
                                   java.lang.String sessionHandle)

Specified by:

launchCase in interface EngineGateway

Parameters:

specID - specID

caseParams - format <data>[InputParam]*</data> where InputParam == <varName>var value</varName>

sessionHandle -

Returns:

success

launchCase

public java.lang.String launchCase(YSpecificationID specID,
                                   java.lang.String caseParams,
                                   java.net.URI caseCompletionURI,
                                   java.lang.String logDataStr,
                                   java.util.Date expiry,
                                   java.lang.String sessionHandle)

Specified by:

launchCase in interface EngineGateway

launchCase

public java.lang.String launchCase(YSpecificationID specID,
                                   java.lang.String caseParams,
                                   java.net.URI caseCompletionURI,
                                   java.lang.String logDataStr,
                                   javax.xml.datatype.Duration duration,
                                   java.lang.String sessionHandle)

Specified by:

launchCase in interface EngineGateway

getCasesForSpecification

public java.lang.String getCasesForSpecification(YSpecificationID specID,
                                                 java.lang.String sessionHandle)

Given a process specification id return the cases that are its running instances.

Specified by:

getCasesForSpecification in interface EngineGateway

Parameters:

specID - the process specification id string.

sessionHandle - the sessionhandle

Returns:

a XML message containing a set of caseID elements that are run time instances of the process specification with id = specID

getSpecificationIDForCase

public java.lang.String getSpecificationIDForCase(java.lang.String caseIDStr,
                                                  java.lang.String sessionHandle)

Specified by:

getSpecificationIDForCase in interface EngineGateway

getSpecificationForCase

public java.lang.String getSpecificationForCase(java.lang.String caseIDStr,
                                                java.lang.String sessionHandle)

Specified by:

getSpecificationForCase in interface EngineGateway

getAllRunningCases

public java.lang.String getAllRunningCases(java.lang.String sessionHandle)

Specified by:

getAllRunningCases in interface EngineGateway

getCaseState

public java.lang.String getCaseState(java.lang.String caseID,
                                     java.lang.String sessionHandle)
                              throws java.rmi.RemoteException

This method returns a complex XML message containing the state of a particular case. i.e. every token (identifier) and its position in every condition/ task/ and internal condition.

Specified by:

getCaseState in interface EngineGateway

Parameters:

caseID - case id string

sessionHandle - sessionHandle

Returns:

XML state Message

Throws:

java.rmi.RemoteException

cancelCase

public java.lang.String cancelCase(java.lang.String caseID,
                                   java.lang.String sessionHandle)

Cancels a running case.

Specified by:

cancelCase in interface EngineGateway

Parameters:

caseID - the caseID string

sessionHandle - sessionHandle

Returns:

a diagnostic XML message indicating the result of method call.

getBuildProperties

public java.lang.String getBuildProperties(java.lang.String sessionHandle)
                                    throws java.rmi.RemoteException

Specified by:

getBuildProperties in interface EngineGateway

Throws:

java.rmi.RemoteException

getChildrenOfWorkItem

public java.lang.String getChildrenOfWorkItem(java.lang.String workItemID,
                                              java.lang.String sessionHandle)
                                       throws java.rmi.RemoteException

Gets the child work items of a given work item id string.

Specified by:

getChildrenOfWorkItem in interface EngineGateway

Parameters:

workItemID -

sessionHandle -

Returns:

an XML list of elements that describe each child work item.

Throws:

java.rmi.RemoteException

getWorkItemOptions

public java.lang.String getWorkItemOptions(java.lang.String workItemID,
                                           java.lang.String thisURL,
                                           java.lang.String sessionHandle)

Provides an XML list of options for manipulating a work item. Uses the REST philosophy of showing what you can do with a work item and provides some links to further manipulate the work item.

Specified by:

getWorkItemOptions in interface EngineGateway

Parameters:

workItemID - work item id string

thisURL - the url of the engine interface B server (i think).

sessionHandle - the sesssion handle

Returns:

a REST style list of options to change the work item under question.

loadSpecification

public java.lang.String loadSpecification(java.lang.String specificationStr,
                                          java.lang.String sessionHandle)

Allows the user to load a specificationStr.

Specified by:

loadSpecification in interface EngineGateway

Parameters:

specificationStr - a YAWL schema compliant process specificationStr in its entirety, in string format.

sessionHandle - a session handle

Returns:

a diagnostic XML message indicating the result of loading the specificationStr.

unloadSpecification

public java.lang.String unloadSpecification(YSpecificationID specID,
                                            java.lang.String sessionHandle)

Unloads the specification.

Specified by:

unloadSpecification in interface EngineGateway

Parameters:

specID - the specification id string

sessionHandle - session handle

Returns:

an XML message indicating the result of the operation.

createAccount

public java.lang.String createAccount(java.lang.String userName,
                                      java.lang.String password,
                                      java.lang.String doco,
                                      java.lang.String sessionHandle)

Creates a new external client account in the system.

Specified by:

createAccount in interface EngineGateway

Parameters:

userName - the name of the user

password - the users elected password.

doco - some descriptive text about the account

sessionHandle -

Returns:

diagnostic XML message.

updateAccount

public java.lang.String updateAccount(java.lang.String userName,
                                      java.lang.String password,
                                      java.lang.String doco,
                                      java.lang.String sessionHandle)

Creates a new external client account in the system.

Specified by:

updateAccount in interface EngineGateway

Parameters:

userName - the name of the user

password - the users elected password.

doco - some descriptive text about the account

sessionHandle -

Returns:

diagnostic XML message.

getAccounts

public java.lang.String getAccounts(java.lang.String sessionHandle)

Gets the list of external accounts in the system.

Specified by:

getAccounts in interface EngineGateway

Parameters:

sessionHandle - session handle

Returns:

an XML message showing each user in the system.

getYAWLServices

public java.lang.String getYAWLServices(java.lang.String sessionHandle)

Returns an XML list (unrooted) of yawlService elements.

Specified by:

getYAWLServices in interface EngineGateway

Parameters:

sessionHandle -

Returns:

either "" or "..."

getYAWLServiceDocumentation

public java.lang.String getYAWLServiceDocumentation(java.lang.String yawlServiceURI,
                                                    java.lang.String sessionHandle)

Gets the documentation associated with the yawl service

Specified by:

getYAWLServiceDocumentation in interface EngineGateway

Parameters:

yawlServiceURI -

sessionHandle -

Returns:

doco as xml (if any) else failure message

addYAWLService

public java.lang.String addYAWLService(java.lang.String serviceStr,
                                       java.lang.String sessionHandle)

Adds a new YAWL service to the engine

Specified by:

addYAWLService in interface EngineGateway

Parameters:

serviceStr - an XML message containing the YAWL service details.

sessionHandle - the session handle

Returns:

diagnostic XML message.

removeYAWLService

public java.lang.String removeYAWLService(java.lang.String serviceURI,
                                          java.lang.String sessionHandle)

Specified by:

removeYAWLService in interface EngineGateway

deleteAccount

public java.lang.String deleteAccount(java.lang.String client,
                                      java.lang.String sessionHandle)
                               throws java.rmi.RemoteException

Deprecated. The YAWL Engine no longer maintains users directly

Specified by:

deleteAccount in interface EngineGateway

Parameters:

client -

sessionHandle -

Returns:

a success or failure message

Throws:

java.rmi.RemoteException

changePassword

public java.lang.String changePassword(java.lang.String password,
                                       java.lang.String sessionHandle)
                                throws java.rmi.RemoteException

Specified by:

changePassword in interface EngineGateway

Throws:

java.rmi.RemoteException

getClientPassword

public java.lang.String getClientPassword(java.lang.String userID,
                                          java.lang.String sessionHandle)
                                   throws java.rmi.RemoteException

Specified by:

getClientPassword in interface EngineGateway

Throws:

java.rmi.RemoteException

getClientAccount

public java.lang.String getClientAccount(java.lang.String userID,
                                         java.lang.String sessionHandle)
                                  throws java.rmi.RemoteException

Specified by:

getClientAccount in interface EngineGateway

Throws:

java.rmi.RemoteException

addInterfaceXListener

public java.lang.String addInterfaceXListener(java.lang.String listenerURI)

The following methods are called by an Exception Service via Interface_X

Specified by:

addInterfaceXListener in interface EngineGateway

removeInterfaceXListener

public java.lang.String removeInterfaceXListener(java.lang.String listenerURI)

Specified by:

removeInterfaceXListener in interface EngineGateway

updateWorkItemData

public java.lang.String updateWorkItemData(java.lang.String workItemID,
                                           java.lang.String data,
                                           java.lang.String sessionHandle)

Specified by:

updateWorkItemData in interface EngineGateway

updateCaseData

public java.lang.String updateCaseData(java.lang.String caseID,
                                       java.lang.String data,
                                       java.lang.String sessionHandle)

Specified by:

updateCaseData in interface EngineGateway

restartWorkItem

public java.lang.String restartWorkItem(java.lang.String workItemID,
                                        java.lang.String sessionHandle)
                                 throws java.rmi.RemoteException

Specified by:

restartWorkItem in interface EngineGateway

Throws:

java.rmi.RemoteException

cancelWorkItem

public java.lang.String cancelWorkItem(java.lang.String workItemID,
                                       java.lang.String data,
                                       java.lang.String fail,
                                       java.lang.String sessionHandle)
                                throws java.rmi.RemoteException

Specified by:

cancelWorkItem in interface EngineGateway

Throws:

java.rmi.RemoteException

getLatestSpecVersion

public java.lang.String getLatestSpecVersion(java.lang.String id,
                                             java.lang.String sessionHandle)
                                      throws java.rmi.RemoteException

Specified by:

getLatestSpecVersion in interface EngineGateway

Throws:

java.rmi.RemoteException

getMITaskAttributes

public java.lang.String getMITaskAttributes(YSpecificationID specificationID,
                                            java.lang.String taskID,
                                            java.lang.String sessionHandle)
                                     throws java.rmi.RemoteException

Specified by:

getMITaskAttributes in interface EngineGateway

Parameters:

specificationID -

taskID -

sessionHandle -

Returns:

the multiple instance task attributes for the taskid passed

Throws:

java.rmi.RemoteException

getResourcingSpecs

public java.lang.String getResourcingSpecs(YSpecificationID specificationID,
                                           java.lang.String taskID,
                                           java.lang.String sessionHandle)
                                    throws java.rmi.RemoteException

Specified by:

getResourcingSpecs in interface EngineGateway

Throws:

java.rmi.RemoteException

getCaseData

public java.lang.String getCaseData(java.lang.String caseID,
                                    java.lang.String sessionHandle)
                             throws java.rmi.RemoteException

Specified by:

getCaseData in interface EngineGateway

Throws:

java.rmi.RemoteException

getCaseInstanceSummary

public java.lang.String getCaseInstanceSummary(java.lang.String sessionHandle)
                                        throws java.rmi.RemoteException

Specified by:

getCaseInstanceSummary in interface EngineGateway

Throws:

java.rmi.RemoteException

getWorkItemInstanceSummary

public java.lang.String getWorkItemInstanceSummary(java.lang.String caseID,
                                                   java.lang.String sessionHandle)
                                            throws java.rmi.RemoteException

Specified by:

getWorkItemInstanceSummary in interface EngineGateway

Throws:

java.rmi.RemoteException

getParameterInstanceSummary

public java.lang.String getParameterInstanceSummary(java.lang.String caseID,
                                                    java.lang.String itemID,
                                                    java.lang.String sessionHandle)
                                             throws java.rmi.RemoteException

Specified by:

getParameterInstanceSummary in interface EngineGateway

Throws:

java.rmi.RemoteException

rejectAnnouncedEnabledTask

public java.lang.String rejectAnnouncedEnabledTask(java.lang.String itemID,
                                                   java.lang.String sessionHandle)
                                            throws java.rmi.RemoteException

Specified by:

rejectAnnouncedEnabledTask in interface EngineGateway

Throws:

java.rmi.RemoteException

getExternalDBGateways

public java.lang.String getExternalDBGateways(java.lang.String sessionHandle)
                                       throws java.rmi.RemoteException

Specified by:

getExternalDBGateways in interface EngineGateway

Throws:

java.rmi.RemoteException

setHibernateStatisticsEnabled

public java.lang.String setHibernateStatisticsEnabled(boolean enabled,
                                                      java.lang.String sessionHandle)

Specified by:

setHibernateStatisticsEnabled in interface EngineGateway

isHibernateStatisticsEnabled

public java.lang.String isHibernateStatisticsEnabled(java.lang.String sessionHandle)

Specified by:

isHibernateStatisticsEnabled in interface EngineGateway

getHibernateStatistics

public java.lang.String getHibernateStatistics(java.lang.String sessionHandle)

Specified by:

getHibernateStatistics in interface EngineGateway

promote

public java.lang.String promote(java.lang.String sessionHandle)
                         throws YPersistenceException

Specified by:

promote in interface EngineGateway

Throws:

YPersistenceException

demote

public java.lang.String demote(java.lang.String sessionHandle)

Specified by:

demote in interface EngineGateway

isRedundantMode

public boolean isRedundantMode()

Specified by:

isRedundantMode in interface EngineGateway

exportCaseState

public java.lang.String exportCaseState(java.lang.String caseID,
                                        java.lang.String sessionHandle)

Specified by:

exportCaseState in interface EngineGateway

exportAllCaseStates

public java.lang.String exportAllCaseStates(java.lang.String sessionHandle)

Specified by:

exportAllCaseStates in interface EngineGateway

importCases

public java.lang.String importCases(java.lang.String caseXML,
                                    java.lang.String sessionHandle)

Specified by:

importCases in interface EngineGateway