org.yawlfoundation.yawl.util

Class AbstractEngineClient

java.lang.Object

org.yawlfoundation.yawl.util.AbstractEngineClient

Direct Known Subclasses:

EngineClient, InterfaceClients

public abstract class AbstractEngineClient
extends java.lang.Object

Base class that abstracts interface connections and calls between custom services and the Engine and other services as needed, besides those that go through InterfaceBWebsideController

Author:

Michael Adams

Created/Last Date:

05/01/2015

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	_defaultURI
protected java.lang.String	_engineLogonName
protected java.lang.String	_engineLogonPassword
protected java.lang.String	_engineURI
protected InterfaceA_EnvironmentBasedClient	_interfaceAClient
protected InterfaceB_EnvironmentBasedClient	_interfaceBClient
protected org.apache.logging.log4j.Logger	_log
protected java.lang.String	_serviceName
protected java.lang.String	_serviceURI
protected java.lang.String	_sessionHandle
protected static java.lang.String	ADMIN_STR
protected static java.lang.String	FAIL_STR
protected static java.lang.String	SUCCESS_STR
protected static java.lang.String	WORKITEM_ERR

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractEngineClient(java.lang.String logonName, java.lang.String password, java.lang.String uri, java.lang.String name) Initialises the class.

Method Summary

Modifier and Type	Method and Description
java.lang.String	addExternalClient(YExternalClient client)
java.lang.String	addRegisteredService(YAWLServiceReference service)
boolean	canAddNewInstance(WorkItemRecord wir)
java.lang.String	cancelCase(java.lang.String caseID)
protected boolean	connected() Checks if there is a connection to the engine, and if there isn't, attempts to connect
WorkItemRecord	createNewWorkItemInstance(java.lang.String id, java.lang.String value)
boolean	engineIsAvailable() Check that the engine is contactable
protected java.lang.String	fail(java.lang.String msg)
java.lang.String	getAdminUserPassword()
java.util.List<WorkItemRecord>	getAllLiveWorkItems()
java.util.Set<java.lang.String>	getAllRunningCaseIDs()
XNode	getAllRunningCases()
java.lang.String	getCaseData(java.lang.String caseID)
java.lang.String	getCases(YSpecificationID specID)
java.lang.String	getEngineBuildProperties()
java.lang.String	getEngineLogonName()
java.lang.String	getEngineLogonPassword()
java.lang.String	getEngineURI() Gets the stored URI of the Engine
java.util.Set<YExternalClient>	getExternalClients()
java.lang.String	getIABackendURI()
java.util.List<WorkItemRecord>	getLiveWorkItemsForCase(java.lang.String caseID)
java.util.List<WorkItemRecord>	getLiveWorkItemsForIdentifier(java.lang.String idType, java.lang.String id)
java.lang.String	getMITaskAttributes(YSpecificationID specID, java.lang.String taskID)
protected Namespace	getNamespace()
java.util.Set<YAWLServiceReference>	getRegisteredServices()
java.lang.String	getRegisteredServicesAsXML()
java.lang.String	getRunningCases(YSpecificationID specID)
java.util.List<java.lang.String>	getRunningCasesAsList(YSpecificationID specID)
java.lang.String	getServiceURI() Gets the Service's URI, initialising it if necessary
protected java.lang.String	getServiceURI(java.lang.String serviceName) Gets the URI for a named service, as stored in the Engine
java.lang.String	getSessionHandle()
java.lang.String	getSpecification(YSpecificationID specID)
java.lang.String	getSpecificationDataSchema(YSpecificationID specID)
java.lang.String	getTaskParamsAsXML(YSpecificationID specID, java.lang.String taskID)
java.util.List<WorkItemRecord>	getWorkItemsForService()
void	initEngineURI(java.lang.String engineURI) Called on servlet startup with the various uris needed to initialise the various clients
boolean	isAdminSession(java.lang.String sessionHandle) returns true if the session specified is an admin session
boolean	isRunningCaseID(java.lang.String caseID)
java.lang.String	launchCase(YSpecificationID specID, java.lang.String caseData, YLogDataItemList logList)
java.lang.String	launchCase(YSpecificationID specID, java.lang.String caseData, YLogDataItemList logList, java.util.Date delay)
java.lang.String	launchCase(YSpecificationID specID, java.lang.String caseData, YLogDataItemList logList, javax.xml.datatype.Duration delay)
java.lang.String	launchCase(YSpecificationID specID, java.lang.String caseData, YLogDataItemList logList, long delay)
void	reestablishClients(InterfaceB_EnvironmentBasedClient client) Reestablishes clients when the service restarts
java.lang.String	removeExternalClient(java.lang.String id)
java.lang.String	removeRegisteredService(java.lang.String id)
void	setInterfaceBClient(InterfaceB_EnvironmentBasedClient client) Assigns the IB client from InterfaceBWebsideController
void	setServiceURI() Sets the Service URI as read from that stored in the Engine
java.lang.String	skipWorkItem(java.lang.String itemID)
boolean	successful(java.lang.String input)
java.lang.String	suspendWorkItem(java.lang.String itemID)
java.lang.String	unloadSpecification(YSpecificationID specID)
java.lang.String	unsuspendWorkItem(java.lang.String itemID)
java.lang.String	updateExternalClient(java.lang.String id, java.lang.String password, java.lang.String doco)
java.lang.String	uploadSpecification(java.lang.String fileContents, java.lang.String fileName)

Methods inherited from class java.lang.Object

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

Field Detail

_sessionHandle

protected java.lang.String _sessionHandle

_engineLogonName

protected java.lang.String _engineLogonName

_engineLogonPassword

protected java.lang.String _engineLogonPassword

_defaultURI

protected java.lang.String _defaultURI

_serviceName

protected java.lang.String _serviceName

_serviceURI

protected java.lang.String _serviceURI

_engineURI

protected java.lang.String _engineURI

_interfaceAClient

protected InterfaceA_EnvironmentBasedClient _interfaceAClient

_interfaceBClient

protected InterfaceB_EnvironmentBasedClient _interfaceBClient

ADMIN_STR

protected static final java.lang.String ADMIN_STR

See Also:

Constant Field Values

WORKITEM_ERR

protected static final java.lang.String WORKITEM_ERR

See Also:

Constant Field Values

SUCCESS_STR

protected static final java.lang.String SUCCESS_STR

See Also:

Constant Field Values

FAIL_STR

protected static final java.lang.String FAIL_STR

See Also:

Constant Field Values

_log

protected org.apache.logging.log4j.Logger _log

Constructor Detail

AbstractEngineClient

protected AbstractEngineClient(java.lang.String logonName,
                               java.lang.String password,
                               java.lang.String uri,
                               java.lang.String name)

Initialises the class. Package access only.

Parameters:

logonName - the service's logon name (from web.xml)

password - the service's logon password (from web.xml)

Method Detail

setInterfaceBClient

public void setInterfaceBClient(InterfaceB_EnvironmentBasedClient client)

Assigns the IB client from InterfaceBWebsideController

Parameters:

client - an IB Client instance

getEngineLogonName

public java.lang.String getEngineLogonName()

getEngineLogonPassword

public java.lang.String getEngineLogonPassword()

getNamespace

protected Namespace getNamespace()

Returns:

the YAWL namespace

getEngineURI

public java.lang.String getEngineURI()

Gets the stored URI of the Engine

Returns:

the engine's URI

initEngineURI

public void initEngineURI(java.lang.String engineURI)

Called on servlet startup with the various uris needed to initialise the various clients

Parameters:

engineURI - the URI of the Engine's Interface B

reestablishClients

public void reestablishClients(InterfaceB_EnvironmentBasedClient client)

Reestablishes clients when the service restarts

Parameters:

client - the Interface B client from InterfaceBWebsideController

setServiceURI

public void setServiceURI()

Sets the Service URI as read from that stored in the Engine

getServiceURI

public java.lang.String getServiceURI()

Gets the Service's URI, initialising it if necessary

Returns:

the Service's URI, or a default if not found

getServiceURI

protected java.lang.String getServiceURI(java.lang.String serviceName)

Gets the URI for a named service, as stored in the Engine

Parameters:

serviceName - the name of the service to get the URI for

Returns:

the URI, or null if not found

engineIsAvailable

public boolean engineIsAvailable()

Check that the engine is contactable

Returns:

true if Engine is contactable

connected

protected boolean connected()

Checks if there is a connection to the engine, and if there isn't, attempts to connect

Returns:

true if connected to the engine

getSessionHandle

public java.lang.String getSessionHandle()

Returns:

the current session handle for the engine

successful

public boolean successful(java.lang.String input)

isAdminSession

public boolean isAdminSession(java.lang.String sessionHandle)

returns true if the session specified is an admin session

getEngineBuildProperties

public java.lang.String getEngineBuildProperties()

getRegisteredServices

public java.util.Set<YAWLServiceReference> getRegisteredServices()

getAdminUserPassword

public java.lang.String getAdminUserPassword()

uploadSpecification

public java.lang.String uploadSpecification(java.lang.String fileContents,
                                            java.lang.String fileName)

unloadSpecification

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

Throws:

java.io.IOException

getRegisteredServicesAsXML

public java.lang.String getRegisteredServicesAsXML()
                                            throws java.io.IOException

Throws:

java.io.IOException

addRegisteredService

public java.lang.String addRegisteredService(YAWLServiceReference service)
                                      throws java.io.IOException

Throws:

java.io.IOException

removeRegisteredService

public java.lang.String removeRegisteredService(java.lang.String id)
                                         throws java.io.IOException

Throws:

java.io.IOException

getExternalClients

public java.util.Set<YExternalClient> getExternalClients()
                                                  throws java.io.IOException

Throws:

java.io.IOException

addExternalClient

public java.lang.String addExternalClient(YExternalClient client)
                                   throws java.io.IOException

Throws:

java.io.IOException

removeExternalClient

public java.lang.String removeExternalClient(java.lang.String id)
                                      throws java.io.IOException

Throws:

java.io.IOException

updateExternalClient

public java.lang.String updateExternalClient(java.lang.String id,
                                             java.lang.String password,
                                             java.lang.String doco)
                                      throws java.io.IOException

Throws:

java.io.IOException

getIABackendURI

public java.lang.String getIABackendURI()

getWorkItemsForService

public java.util.List<WorkItemRecord> getWorkItemsForService()
                                                      throws java.io.IOException

Throws:

java.io.IOException

suspendWorkItem

public java.lang.String suspendWorkItem(java.lang.String itemID)
                                 throws java.io.IOException

Throws:

java.io.IOException

unsuspendWorkItem

public java.lang.String unsuspendWorkItem(java.lang.String itemID)
                                   throws java.io.IOException

Throws:

java.io.IOException

skipWorkItem

public java.lang.String skipWorkItem(java.lang.String itemID)
                              throws java.io.IOException

Throws:

java.io.IOException

getRunningCases

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

Throws:

java.io.IOException

cancelCase

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

Throws:

java.io.IOException

getCases

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

Throws:

java.io.IOException

getCaseData

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

Throws:

java.io.IOException

getSpecificationDataSchema

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

Throws:

java.io.IOException

getSpecification

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

Throws:

java.io.IOException

getMITaskAttributes

public java.lang.String getMITaskAttributes(YSpecificationID specID,
                                            java.lang.String taskID)
                                     throws java.io.IOException

Throws:

java.io.IOException

getLiveWorkItemsForCase

public java.util.List<WorkItemRecord> getLiveWorkItemsForCase(java.lang.String caseID)

getLiveWorkItemsForIdentifier

public java.util.List<WorkItemRecord> getLiveWorkItemsForIdentifier(java.lang.String idType,
                                                                    java.lang.String id)
                                                             throws java.io.IOException,
                                                                    JDOMException

Throws:

java.io.IOException

JDOMException

getAllLiveWorkItems

public java.util.List<WorkItemRecord> getAllLiveWorkItems()
                                                   throws java.io.IOException

Throws:

java.io.IOException

launchCase

public java.lang.String launchCase(YSpecificationID specID,
                                   java.lang.String caseData,
                                   YLogDataItemList logList)
                            throws java.io.IOException

Throws:

java.io.IOException

launchCase

public java.lang.String launchCase(YSpecificationID specID,
                                   java.lang.String caseData,
                                   YLogDataItemList logList,
                                   long delay)
                            throws java.io.IOException

Throws:

java.io.IOException

launchCase

public java.lang.String launchCase(YSpecificationID specID,
                                   java.lang.String caseData,
                                   YLogDataItemList logList,
                                   java.util.Date delay)
                            throws java.io.IOException

Throws:

java.io.IOException

launchCase

public java.lang.String launchCase(YSpecificationID specID,
                                   java.lang.String caseData,
                                   YLogDataItemList logList,
                                   javax.xml.datatype.Duration delay)
                            throws java.io.IOException

Throws:

java.io.IOException

getAllRunningCases

public XNode getAllRunningCases()

getAllRunningCaseIDs

public java.util.Set<java.lang.String> getAllRunningCaseIDs()

isRunningCaseID

public boolean isRunningCaseID(java.lang.String caseID)

getRunningCasesAsList

public java.util.List<java.lang.String> getRunningCasesAsList(YSpecificationID specID)

getTaskParamsAsXML

public java.lang.String getTaskParamsAsXML(YSpecificationID specID,
                                           java.lang.String taskID)
                                    throws java.io.IOException

Throws:

java.io.IOException

canAddNewInstance

public boolean canAddNewInstance(WorkItemRecord wir)

createNewWorkItemInstance

public WorkItemRecord createNewWorkItemInstance(java.lang.String id,
                                                java.lang.String value)

fail

protected java.lang.String fail(java.lang.String msg)