org.yawlfoundation.yawl.engine.interfce.interfaceE

Class YLogGatewayClient

java.lang.Object

org.yawlfoundation.yawl.engine.interfce.Interface_Client

org.yawlfoundation.yawl.engine.interfce.interfaceE.YLogGatewayClient

public class YLogGatewayClient
extends Interface_Client

An API to be used by clients that want to retrieve data from the YAWL process logs.

Author:

Michael Adams 29/10/2007 Last Date: 02/12/2009 (for v2.1)

Constructor Summary

Constructors

Constructor and Description
YLogGatewayClient(java.lang.String uri) the only constructor

Method Summary

Modifier and Type	Method and Description
java.lang.String	checkConnection(java.lang.String handle) Checks if a sessionhandle is active
java.lang.String	connect(java.lang.String userID, java.lang.String password) Connects an external entity to the engine
java.lang.String	getAllCasesCancelledByService(java.lang.String serviceName, java.lang.String handle) Gets a list of all of the 'CaseCancel' events triggered by the service
java.lang.String	getAllCasesStartedByService(java.lang.String serviceName, java.lang.String handle) Gets a list of all of the 'CaseStart' events triggered by the service
java.lang.String	getAllSpecifications(java.lang.String handle) Gets an summary xml list of all the specifications logged
java.lang.String	getBackEndURI()
java.lang.String	getCaseEvent(java.lang.String caseID, java.lang.String eventType, java.lang.String handle) Gets the log record of a particular case-level event
java.lang.String	getCaseEvents(long rootNetInstanceKey, java.lang.String handle) Gets all the case level events for the root net key passed
java.lang.String	getCaseEvents(java.lang.String caseID, java.lang.String handle) Gets all the case level events for the case id passed
java.lang.String	getCompleteCaseLog(java.lang.String caseID, java.lang.String handle) Gets a comprehensive listing of all of the data logged for the case passed, including all net & task instances, events and data items
java.lang.String	getCompleteCaseLogsForSpecification(long specKey, java.lang.String handle) Gets a complete listing of all the cases launched from the specification key passed, including all net & task instances, events and data items
java.lang.String	getCompleteCaseLogsForSpecification(java.lang.String identifier, java.lang.String version, java.lang.String uri, java.lang.String handle) Gets a complete listing of all the cases launched from the specification data passed, including all net & task instances, events and data items
java.lang.String	getDataForEvent(long eventKey, java.lang.String handle) Gets all of the data items logged with the event requested
java.lang.String	getDataTypeForDataItem(long dataTypeKey, java.lang.String handle) Gets the data type for the key passed
java.lang.String	getEventsForTaskInstance(java.lang.String itemID, java.lang.String handle) Gets the set of events for a task instance (workitem)
java.lang.String	getInstanceEvents(long instanceKey, java.lang.String handle) Gets all of the net or task instances for the instance key passed
java.lang.String	getNetInstancesOfSpecification(long specKey, java.lang.String handle) Gets all of the net instances (root and sub-net) of all the logged cases based on the specification key passed
java.lang.String	getNetInstancesOfSpecification(java.lang.String identifier, java.lang.String version, java.lang.String uri, java.lang.String handle) Gets all of the net instances (root and sub-net) of all the logged cases based on the specification details passed
java.lang.String	getServiceName(long serviceKey, java.lang.String handle) Gets the name of the service referenced by the key passed
java.lang.String	getSpecificationCaseIDs(long specKey, java.lang.String handle) Gets a set of case ids for executed instances of the specification key passed
java.lang.String	getSpecificationCaseIDs(YSpecificationID specID, java.lang.String handle) Gets the set of case ids for executed instances of the specification data passed
java.lang.String	getSpecificationStatistics(long specKey, java.lang.String handle) Gets a set of summary statistics for executed instances of the specification key passed
java.lang.String	getSpecificationStatistics(java.lang.String identifier, java.lang.String version, java.lang.String uri, long from, long to, java.lang.String handle) Gets a set of summary statistics for executed instances of the specification data passed
java.lang.String	getSpecificationStatistics(java.lang.String identifier, java.lang.String version, java.lang.String uri, java.lang.String handle) Gets a set of summary statistics for executed instances of the specification data passed
java.lang.String	getSpecificationStatistics(YSpecificationID specID, long from, long to, java.lang.String handle) Gets a set of summary statistics for executed instances of the specification data passed
java.lang.String	getSpecificationStatistics(YSpecificationID specID, java.lang.String handle) Gets a set of summary statistics for executed instances of the specification data passed
java.lang.String	getSpecificationXESLog(java.lang.String identifier, java.lang.String version, java.lang.String uri, boolean withData, java.lang.String handle) Gets a complete listing of all the cases launched from the specification data passed, in OpenXES format
java.lang.String	getSpecificationXESLog(java.lang.String identifier, java.lang.String version, java.lang.String uri, java.lang.String handle) Gets a complete listing of all the cases launched from the specification data passed, in OpenXES format
java.lang.String	getSpecificationXESLog(YSpecificationID specID, boolean withData, java.lang.String handle) Gets a complete listing of all the cases launched from the specification data passed, in OpenXES format
java.lang.String	getSpecificationXESLog(YSpecificationID specID, java.lang.String handle) Gets a complete listing of all the cases launched from the specification data passed, in OpenXES format
java.lang.String	getTaskInstancesForCase(java.lang.String caseID, java.lang.String handle) Gets a listing of all the task instances (ie work items) created for the case
java.lang.String	getTaskInstancesForTask(long taskKey, java.lang.String handle) Gets a listing of all the task instances (ie work items) created for the task
java.lang.String	getTaskInstancesForTask(java.lang.String rootCaseID, java.lang.String taskName, java.lang.String handle) Gets a listing of all the task instances (ie work items) created for the task within a specified case

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

YLogGatewayClient

public YLogGatewayClient(java.lang.String uri)

the only constructor

Parameters:

uri - the uri of the YAWL engine's log gateway

Method Detail

getBackEndURI

public java.lang.String getBackEndURI()

getAllSpecifications

public java.lang.String getAllSpecifications(java.lang.String handle)
                                      throws java.io.IOException

Gets an summary xml list of all the specifications logged

Parameters:

handle - an active sessionhandle

Returns:

the resultant String response (log data or error message)

Throws:

java.io.IOException - if there's a problem connecting to the engine

getNetInstancesOfSpecification

public java.lang.String getNetInstancesOfSpecification(java.lang.String identifier,
                                                       java.lang.String version,
                                                       java.lang.String uri,
                                                       java.lang.String handle)
                                                throws java.io.IOException

Gets all of the net instances (root and sub-net) of all the logged cases based on the specification details passed

Parameters:

identifier - the unique identifier of the specification

version - the specification's version number

uri - the specification's uri

handle - an active sessionhandle

Returns:

the resultant String response (log data or error message)

Throws:

java.io.IOException - if there's a problem connecting to the engine

getNetInstancesOfSpecification

public java.lang.String getNetInstancesOfSpecification(long specKey,
                                                       java.lang.String handle)
                                                throws java.io.IOException

Gets all of the net instances (root and sub-net) of all the logged cases based on the specification key passed

Parameters:

specKey - the primary key identifier of the specification in its log table

handle - an active sessionhandle

Returns:

the resultant String response (log data or error message)

Throws:

java.io.IOException - if there's a problem connecting to the engine

getCompleteCaseLogsForSpecification

public java.lang.String getCompleteCaseLogsForSpecification(java.lang.String identifier,
                                                            java.lang.String version,
                                                            java.lang.String uri,
                                                            java.lang.String handle)
                                                     throws java.io.IOException

Gets a complete listing of all the cases launched from the specification data passed, including all net & task instances, events and data items

Parameters:

identifier - the unique identifier of the specification

version - the specification's version number

uri - the specification's uri

handle - an active sessionhandle

Returns:

the resultant String response (log data or error message)

Throws:

java.io.IOException - if there's a problem connecting to the engine

getCompleteCaseLogsForSpecification

public java.lang.String getCompleteCaseLogsForSpecification(long specKey,
                                                            java.lang.String handle)
                                                     throws java.io.IOException

Gets a complete listing of all the cases launched from the specification key passed, including all net & task instances, events and data items

Parameters:

specKey - the primary key identifier of the specification in its log table

handle - an active sessionhandle

Returns:

the resultant String response (log data or error message)

Throws:

java.io.IOException - if there's a problem connecting to the engine

getSpecificationStatistics

public java.lang.String getSpecificationStatistics(java.lang.String identifier,
                                                   java.lang.String version,
                                                   java.lang.String uri,
                                                   long from,
                                                   long to,
                                                   java.lang.String handle)
                                            throws java.io.IOException

Gets a set of summary statistics for executed instances of the specification data passed

Parameters:

identifier - the unique identifier of the specification

version - the specification's version number

uri - the specification's uri

from - the start of the range of timestamps to include

to - the end of the range of timestamps to include

handle - an active sessionhandle

Returns:

the resultant String response (log data or error message)

Throws:

java.io.IOException - if there's a problem connecting to the engine

getSpecificationStatistics

public java.lang.String getSpecificationStatistics(java.lang.String identifier,
                                                   java.lang.String version,
                                                   java.lang.String uri,
                                                   java.lang.String handle)
                                            throws java.io.IOException

Gets a set of summary statistics for executed instances of the specification data passed

Parameters:

identifier - the unique identifier of the specification

version - the specification's version number

uri - the specification's uri

handle - an active sessionhandle

Returns:

the resultant String response (log data or error message)

Throws:

java.io.IOException - if there's a problem connecting to the engine

getSpecificationStatistics

public java.lang.String getSpecificationStatistics(YSpecificationID specID,
                                                   java.lang.String handle)
                                            throws java.io.IOException

Gets a set of summary statistics for executed instances of the specification data passed

Parameters:

specID - the unique identifier of the specification

handle - an active sessionhandle

Returns:

the resultant String response (log data or error message)

Throws:

java.io.IOException - if there's a problem connecting to the engine

getSpecificationStatistics

public java.lang.String getSpecificationStatistics(YSpecificationID specID,
                                                   long from,
                                                   long to,
                                                   java.lang.String handle)
                                            throws java.io.IOException

Gets a set of summary statistics for executed instances of the specification data passed

Parameters:

specID - the unique identifier of the specification

from - the start of the range of timestamps to include

to - the end of the range of timestamps to include

handle - an active sessionhandle

Returns:

the resultant String response (log data or error message)

Throws:

java.io.IOException - if there's a problem connecting to the engine

getSpecificationStatistics

public java.lang.String getSpecificationStatistics(long specKey,
                                                   java.lang.String handle)
                                            throws java.io.IOException

Gets a set of summary statistics for executed instances of the specification key passed

Parameters:

specKey - the primary key identifier of the specification in its log table

handle - an active sessionhandle

Returns:

the resultant String response (log data or error message)

Throws:

java.io.IOException - if there's a problem connecting to the engine

getSpecificationCaseIDs

public java.lang.String getSpecificationCaseIDs(YSpecificationID specID,
                                                java.lang.String handle)
                                         throws java.io.IOException

Gets the set of case ids for executed instances of the specification data passed

Parameters:

specID - the unique identifier of the specification

handle - an active sessionhandle

Returns:

the resultant String response (log data or error message)

Throws:

java.io.IOException - if there's a problem connecting to the engine

getSpecificationCaseIDs

public java.lang.String getSpecificationCaseIDs(long specKey,
                                                java.lang.String handle)
                                         throws java.io.IOException

Gets a set of case ids for executed instances of the specification key passed

Parameters:

specKey - the primary key identifier of the specification in its log table

handle - an active sessionhandle

Returns:

the resultant String response (log data or error message)

Throws:

java.io.IOException - if there's a problem connecting to the engine

getCaseEvents

public java.lang.String getCaseEvents(long rootNetInstanceKey,
                                      java.lang.String handle)
                               throws java.io.IOException

Gets all the case level events for the root net key passed

Parameters:

rootNetInstanceKey - the primary key identifier of the root net instance of the case

handle - an active sessionhandle

Returns:

the resultant String response (log data or error message)

Throws:

java.io.IOException - if there's a problem connecting to the engine

getCaseEvents

public java.lang.String getCaseEvents(java.lang.String caseID,
                                      java.lang.String handle)
                               throws java.io.IOException

Gets all the case level events for the case id passed

Parameters:

caseID - the case id of the case to get the events for

handle - an active sessionhandle

Returns:

the resultant String response (log data or error message)

Throws:

java.io.IOException - if there's a problem connecting to the engine

getDataForEvent

public java.lang.String getDataForEvent(long eventKey,
                                        java.lang.String handle)
                                 throws java.io.IOException

Gets all of the data items logged with the event requested

Parameters:

eventKey - the primary key identifier of the event

handle - an active sessionhandle

Returns:

the resultant String response (log data or error message)

Throws:

java.io.IOException - if there's a problem connecting to the engine

getInstanceEvents

public java.lang.String getInstanceEvents(long instanceKey,
                                          java.lang.String handle)
                                   throws java.io.IOException

Gets all of the net or task instances for the instance key passed

Parameters:

instanceKey - the primary key identifier of the net or task instance

handle - an active sessionhandle

Returns:

the resultant String response (log data or error message)

Throws:

java.io.IOException - if there's a problem connecting to the engine

getDataTypeForDataItem

public java.lang.String getDataTypeForDataItem(long dataTypeKey,
                                               java.lang.String handle)
                                        throws java.io.IOException

Gets the data type for the key passed

Parameters:

dataTypeKey - the primary key identifier of the data type

handle - an active sessionhandle

Returns:

the resultant String response (log data or error message)

Throws:

java.io.IOException - if there's a problem connecting to the engine

getCompleteCaseLog

public java.lang.String getCompleteCaseLog(java.lang.String caseID,
                                           java.lang.String handle)
                                    throws java.io.IOException

Gets a comprehensive listing of all of the data logged for the case passed, including all net & task instances, events and data items

Parameters:

caseID - the case id to get the log data for

handle - an active sessionhandle

Returns:

the resultant String response (log data or error message)

Throws:

java.io.IOException - if there's a problem connecting to the engine

getTaskInstancesForCase

public java.lang.String getTaskInstancesForCase(java.lang.String caseID,
                                                java.lang.String handle)
                                         throws java.io.IOException

Gets a listing of all the task instances (ie work items) created for the case

Parameters:

caseID - the case id to get the log data for

handle - an active sessionhandle

Returns:

the resultant String response (log data or error message)

Throws:

java.io.IOException - if there's a problem connecting to the engine

getTaskInstancesForTask

public java.lang.String getTaskInstancesForTask(long taskKey,
                                                java.lang.String handle)
                                         throws java.io.IOException

Gets a listing of all the task instances (ie work items) created for the task

Parameters:

taskKey - the primary key identifier of the task definition

handle - an active sessionhandle

Returns:

the resultant String response (log data or error message)

Throws:

java.io.IOException - if there's a problem connecting to the engine

getTaskInstancesForTask

public java.lang.String getTaskInstancesForTask(java.lang.String rootCaseID,
                                                java.lang.String taskName,
                                                java.lang.String handle)
                                         throws java.io.IOException

Gets a listing of all the task instances (ie work items) created for the task within a specified case

Parameters:

rootCaseID - the root case id of the case to get the task instances for

taskName - the primary key identifier of the task definition

handle - an active sessionhandle

Returns:

the resultant String response (log data or error message)

Throws:

java.io.IOException - if there's a problem connecting to the engine

getCaseEvent

public java.lang.String getCaseEvent(java.lang.String caseID,
                                     java.lang.String eventType,
                                     java.lang.String handle)
                              throws java.io.IOException

Gets the log record of a particular case-level event

Parameters:

caseID - the case id to get the event for

eventType - the 'name' of the event (eg 'CaseStart')

handle - an active sessionhandle

Returns:

the resultant String response (log data or error message)

Throws:

java.io.IOException - if there's a problem connecting to the engine

getAllCasesStartedByService

public java.lang.String getAllCasesStartedByService(java.lang.String serviceName,
                                                    java.lang.String handle)
                                             throws java.io.IOException

Gets a list of all of the 'CaseStart' events triggered by the service

Parameters:

serviceName - the name of the registered service

handle - an active sessionhandle

Returns:

an XML'd String list of Case Start events triggered by the service

Throws:

java.io.IOException - if there's a problem connecting to the engine

getAllCasesCancelledByService

public java.lang.String getAllCasesCancelledByService(java.lang.String serviceName,
                                                      java.lang.String handle)
                                               throws java.io.IOException

Gets a list of all of the 'CaseCancel' events triggered by the service

Parameters:

serviceName - the name of the registered service

handle - an active sessionhandle

Returns:

an XML'd String list of Case Cancellation events triggered by the service

Throws:

java.io.IOException - if there's a problem connecting to the engine

getServiceName

public java.lang.String getServiceName(long serviceKey,
                                       java.lang.String handle)
                                throws java.io.IOException

Gets the name of the service referenced by the key passed

Parameters:

serviceKey - the primary key identifier of the service

handle - an active sessionhandle

Returns:

the resultant String response (log data or error message)

Throws:

java.io.IOException - if there's a problem connecting to the engine

getEventsForTaskInstance

public java.lang.String getEventsForTaskInstance(java.lang.String itemID,
                                                 java.lang.String handle)
                                          throws java.io.IOException

Gets the set of events for a task instance (workitem)

Parameters:

itemID - the id of the workitem

handle - an active sessionhandle

Returns:

the resultant String response (log data or error message)

Throws:

java.io.IOException - if there's a problem connecting to the engine

getSpecificationXESLog

public java.lang.String getSpecificationXESLog(java.lang.String identifier,
                                               java.lang.String version,
                                               java.lang.String uri,
                                               boolean withData,
                                               java.lang.String handle)
                                        throws java.io.IOException

Gets a complete listing of all the cases launched from the specification data passed, in OpenXES format

Parameters:

identifier - the unique identifier of the specification

version - the specification's version number

uri - the specification's uri

withData - if true, all data change events will be included

handle - an active sessionhandle

Returns:

the resultant String response (log data or error message)

Throws:

java.io.IOException - if there's a problem connecting to the engine

See Also:

getSpecificationXESLog(YSpecificationID, boolean, String)

getSpecificationXESLog

public java.lang.String getSpecificationXESLog(java.lang.String identifier,
                                               java.lang.String version,
                                               java.lang.String uri,
                                               java.lang.String handle)
                                        throws java.io.IOException

Gets a complete listing of all the cases launched from the specification data passed, in OpenXES format

Parameters:

identifier - the unique identifier of the specification

version - the specification's version number

uri - the specification's uri

handle - an active sessionhandle

Returns:

the resultant String response (log data or error message)

Throws:

java.io.IOException - if there's a problem connecting to the engine

See Also:

getSpecificationXESLog(YSpecificationID, String)

getSpecificationXESLog

public java.lang.String getSpecificationXESLog(YSpecificationID specID,
                                               java.lang.String handle)
                                        throws java.io.IOException

Gets a complete listing of all the cases launched from the specification data passed, in OpenXES format

Parameters:

specID - the unique identifier of the specification

handle - an active sessionhandle

Returns:

the resultant String response (log data or error message)

Throws:

java.io.IOException - if there's a problem connecting to the engine

See Also:

getSpecificationXESLog(String, String, String, String)

getSpecificationXESLog

public java.lang.String getSpecificationXESLog(YSpecificationID specID,
                                               boolean withData,
                                               java.lang.String handle)
                                        throws java.io.IOException

Gets a complete listing of all the cases launched from the specification data passed, in OpenXES format

Parameters:

specID - the unique identifier of the specification

withData - if true, all data change events will be included

handle - an active sessionhandle

Returns:

the resultant String response (log data or error message)

Throws:

java.io.IOException - if there's a problem connecting to the engine

See Also:

getSpecificationXESLog(String, String, String, String)

connect

public java.lang.String connect(java.lang.String userID,
                                java.lang.String password)
                         throws java.io.IOException

Connects an external entity to the engine

Parameters:

userID - the userid

password - the password

Returns:

a sessionHandle if successful, or a failure message if not

Throws:

java.io.IOException - if there's a problem connecting to the engine

checkConnection

public java.lang.String checkConnection(java.lang.String handle)
                                 throws java.io.IOException

Checks if a sessionhandle is active

Parameters:

handle - the sessionhandle to check

Returns:

true if the session is alive, false if otherwise

Throws:

java.io.IOException - if there's a problem connecting to the engine