org.yawlfoundation.yawl.worklet.support

Class WorkletGatewayClient

java.lang.Object

org.yawlfoundation.yawl.engine.interfce.Interface_Client

org.yawlfoundation.yawl.worklet.support.WorkletGatewayClient

public class WorkletGatewayClient
extends Interface_Client

An API to be used by clients that want to interact with the worklet service.

Author:

Michael Adams 11/07/2011

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	_wsURI

Constructor Summary

Constructors

Constructor and Description
WorkletGatewayClient() Constructor - uses default uri on localhost
WorkletGatewayClient(java.lang.String uri) Constructor

Method Summary

Modifier and Type	Method and Description
java.lang.String	addListener(java.lang.String listenerURI, java.lang.String handle) Adds a listener for worklet events (selection, exception raising)
java.lang.String	addNode(java.lang.String processName, java.lang.String taskID, RuleType rType, RdrNode node, java.lang.String handle) Adds a node to a ruleSet.
java.lang.String	addNode(WorkItemRecord wir, RuleType rType, RdrNode node, java.lang.String handle) Adds a node to a ruleSet.
java.lang.String	addNode(YSpecificationID specID, java.lang.String taskID, RuleType rType, RdrNode node, java.lang.String handle) Adds a node to a ruleSet.
java.lang.String	addRdrSet(java.lang.String processName, java.lang.String ruleSetXML, java.lang.String handle) Adds a complete (legacy) rule set, expressed as xml
java.lang.String	addRdrSet(YSpecificationID specID, java.lang.String ruleSetXML, java.lang.String handle) Adds a complete (legacy) rule set, expressed as xml
java.lang.String	addWorklet(YSpecificationID specID, java.lang.String workletXML, java.lang.String handle) Adds a worklet to the service repertoire
java.lang.String	checkConnection(java.lang.String handle) Check that a session handle is active
java.lang.String	connect(java.lang.String userID, java.lang.String password) Connects an external entity to the worklet service
void	disconnect(java.lang.String handle) Disconnects an external entity from the worklet service
java.lang.String	evaluate(java.lang.String processName, java.lang.String taskID, Element data, RuleType rType, java.lang.String handle) Evaluates a data set against the rule tree for a process and task, and returns the conclusion, if any.
java.lang.String	evaluate(WorkItemRecord wir, Element data, RuleType rType, java.lang.String handle) Evaluates a data set against the rule tree for a specification and task, and returns the conclusion, if any.
java.lang.String	evaluate(YSpecificationID specID, java.lang.String taskID, Element data, RuleType rType, java.lang.String handle) Evaluates a data set against the rule tree for a specification and task, and returns the conclusion, if any.
java.lang.String	execute(WorkItemRecord wir, RuleType rType, RdrConclusion conclusion, java.util.Set<java.lang.String> workletSet, java.lang.String handle) Raises an exception and executes the exception handler defined in an RdrConclusion.
java.lang.String	execute(WorkItemRecord wir, RuleType rType, RdrConclusion conclusion, java.lang.String handle) Raises an exception and executes the exception handler defined in an RdrConclusion.
java.lang.String	execute(WorkItemRecord wir, RuleType rType, RdrConclusion conclusion, java.lang.String workletXML, java.lang.String handle) Raises an exception and executes the exception handler defined in an RdrConclusion.
java.lang.String	getNode(long nodeID, java.lang.String handle) Gets a copy of a particular node from a rule set
java.lang.String	getOrphanedWorklets(java.lang.String handle) Gets an info set of all stored worklets that are not referenced by any rule
java.lang.String	getRdrSet(java.lang.String processName, java.lang.String handle) Gets a copy of a particular rule set
java.lang.String	getRdrSet(YSpecificationID specID, java.lang.String handle) Gets a copy of a particular rule set
java.lang.String	getRdrSetIDs(java.lang.String handle) Gets the identifiers for all rule sets
java.lang.String	getRdrTree(java.lang.String processName, java.lang.String taskID, RuleType rType, java.lang.String handle) Gets a copy of a particular rule tree
java.lang.String	getRdrTree(WorkItemRecord wir, RuleType rType, java.lang.String handle) Gets a copy of a particular rule tree
java.lang.String	getRdrTree(YSpecificationID specID, java.lang.String taskID, RuleType rType, java.lang.String handle) Gets a copy of a particular rule tree
java.lang.String	getRunningWorklets(java.lang.String handle) Gets an info set of all currently running worklets
java.lang.String	getWorklet(YSpecificationID specID, java.lang.String handle) Gets the specified worklet, if loaded in the service
java.lang.String	getWorkletInfoList(java.lang.String handle) Gets a list of specification descriptors of all the worklets in the repository
java.lang.String	getWorkletNames(java.lang.String handle) Gets a list of the names of all the worklets in the repository
java.lang.String	loadFile(java.lang.String path, java.lang.String extn, java.lang.String handle) Loads a file or files into the worklet repository.
java.lang.String	process(WorkItemRecord wir, Element data, RuleType rType, java.lang.String handle) Evaluates a data set against the rule tree for a specification and task, and if a rule node is satisfied raises an exception and executes the exception handler for the node, if one is defined.
java.lang.String	refresh(YSpecificationID specID, java.lang.String handle) Refreshes the internal rules cache from storage for a specification
java.lang.String	removeListener(java.lang.String listenerURI, java.lang.String handle) Removes a listener for worklet events
java.lang.String	removeNode(YSpecificationID specID, java.lang.String taskID, RuleType rType, long nodeID, java.lang.String handle) Removes a rule node from a rule tree, triggers a tree restructure
java.lang.String	removeRdrSet(java.lang.String identifier, java.lang.String handle) Removes a rule set
java.lang.String	removeRdrSet(YSpecificationID specID, java.lang.String handle) Removes a rule set
java.lang.String	removeWorklet(java.lang.String specKey, java.lang.String handle) Gets the specified worklet, if loaded in the service
java.lang.String	removeWorklet(YSpecificationID specID, java.lang.String handle) Gets the specified worklet, if loaded in the service
java.lang.String	replaceWorklet(java.lang.String itemID, java.lang.String handle) Replaces a worklet instance (or instances) started for a work item with a new instance (or instances), based on a 'pre' updated rule set
java.lang.String	replaceWorklet(java.lang.String caseID, java.lang.String itemID, RuleType ruleType, java.lang.String handle) Replaces a worklet instance (or instances) started for an exlet with a new instance (or instances), based on a 'pre' updated rule set
void	setURI(java.lang.String uri) Sets the uri of the Worklet Service Gateway
java.lang.String	updateRdrSetTaskIDs(YSpecificationID specID, java.util.Map<java.lang.String,java.lang.String> updateMap, java.lang.String handle) Updates the task ids in a rule set for those they have been changed to via a specification edit

Methods inherited from class org.yawlfoundation.yawl.engine.interfce.Interface_Client

executeGet, executePost, getReply, initPostConnection, prepareParamMap, send, setReadTimeout, stripOuterElement, successful

Methods inherited from class java.lang.Object

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

Field Detail

_wsURI

protected java.lang.String _wsURI

Constructor Detail

WorkletGatewayClient

public WorkletGatewayClient(java.lang.String uri)

Constructor

Parameters:

uri - the uri of the Worklet Service Gateway

WorkletGatewayClient

public WorkletGatewayClient()

Constructor - uses default uri on localhost

Method Detail

setURI

public void setURI(java.lang.String uri)

Sets the uri of the Worklet Service Gateway

Parameters:

uri - the uri to set

connect

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

Connects an external entity to the worklet service

Parameters:

userID - the userid

password - the corresponding password

Returns:

a session handle if successful, or a failure message if not

Throws:

java.io.IOException - if the service can't be reached

checkConnection

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

Check that a session handle is active

Parameters:

handle - the session handle to check

Returns:

"true" if the id is valid, "false" if otherwise

Throws:

java.io.IOException - if the service can't be reached

disconnect

public void disconnect(java.lang.String handle)
                throws java.io.IOException

Disconnects an external entity from the worklet service

Parameters:

handle - the session handle to disconnect

Throws:

java.io.IOException - if the service can't be reached

addListener

public java.lang.String addListener(java.lang.String listenerURI,
                                    java.lang.String handle)
                             throws java.io.IOException

Adds a listener for worklet events (selection, exception raising)

Parameters:

listenerURI - the URI of the listener to add

handle - a current session handle to the worklet service

Returns:

a message denoting success or describing an error

Throws:

java.io.IOException - if the service can't be reached

removeListener

public java.lang.String removeListener(java.lang.String listenerURI,
                                       java.lang.String handle)
                                throws java.io.IOException

Removes a listener for worklet events

Parameters:

listenerURI - the URI of the listener to remove

handle - a current session handle to the worklet service

Returns:

a message denoting success or describing an error

Throws:

java.io.IOException - if the service can't be reached

refresh

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

Refreshes the internal rules cache from storage for a specification

Parameters:

specID - the specification id to refresh the rule set for

handle - a current session handle to the worklet service

Returns:

a message denoting success or describing an error

Throws:

java.io.IOException - if the service can't be reached

process

public java.lang.String process(WorkItemRecord wir,
                                Element data,
                                RuleType rType,
                                java.lang.String handle)
                         throws java.io.IOException

Evaluates a data set against the rule tree for a specification and task, and if a rule node is satisfied raises an exception and executes the exception handler for the node, if one is defined. A raised exception will be announced to listeners as a byproduct of this method call.

Parameters:

wir - the workitem containing specification and task identifiers. PRE: the workitem must currently exist in the engine

data - the data set to use in the evaluation

rType - the type of rule tree to evaluate. NOTE: Only ItemAbort and ItemConstraintViolation rules can be used with this method

handle - a current session handle to the worklet service

Returns:

a success or error message

Throws:

java.io.IOException - if the service can't be reached

evaluate

public java.lang.String evaluate(WorkItemRecord wir,
                                 Element data,
                                 RuleType rType,
                                 java.lang.String handle)
                          throws java.io.IOException

Evaluates a data set against the rule tree for a specification and task, and returns the conclusion, if any. Note that for a conclusion to be returned, a rule tree must exist for the specification/task/ruletype, and a rule in that tree must be satisfied.

Parameters:

wir - the workitem containing specification and task identifiers

data - the data set to use in the evaluation

rType - the type of rule tree to evaluate

handle - a current session handle to the worklet service

Returns:

a conclusion XML string, or an error message

Throws:

java.io.IOException - if the service can't be reached

evaluate

public java.lang.String evaluate(YSpecificationID specID,
                                 java.lang.String taskID,
                                 Element data,
                                 RuleType rType,
                                 java.lang.String handle)
                          throws java.io.IOException

Evaluates a data set against the rule tree for a specification and task, and returns the conclusion, if any. Note that for a conclusion to be returned, a rule tree must exist for the specification/task/ruletype, and a rule in that tree must be satisfied.

Parameters:

specID - the specification identifier

taskID - the task identifier (may be null for case-level rule types)

data - the data set to use in the evaluation

rType - the type of rule tree to evaluate

handle - a current session handle to the worklet service

Returns:

a conclusion XML string, or an error message

Throws:

java.io.IOException - if the service can't be reached

evaluate

public java.lang.String evaluate(java.lang.String processName,
                                 java.lang.String taskID,
                                 Element data,
                                 RuleType rType,
                                 java.lang.String handle)
                          throws java.io.IOException

Evaluates a data set against the rule tree for a process and task, and returns the conclusion, if any. Note that for a conclusion to be returned, a rule tree must exist for the process/task/ruletype, and a rule in that tree must be satisfied.

Parameters:

processName - the process identifier, or unique ruleset name

taskID - the task identifier (may be null for case-level rule types)

data - the data set to use in the evaluation

rType - the type of rule tree to evaluate

handle - a current session handle to the worklet service

Returns:

a conclusion XML string, or an error message

Throws:

java.io.IOException - if the service can't be reached

execute

public java.lang.String execute(WorkItemRecord wir,
                                RuleType rType,
                                RdrConclusion conclusion,
                                java.lang.String handle)
                         throws java.io.IOException

Raises an exception and executes the exception handler defined in an RdrConclusion. A raised exception will be announced to listeners as a byproduct of this method call.

Parameters:

wir - the workitem containing specification and task identifiers. PRE: the workitem must currently exist in the engine

rType - the type of rule tree to evaluate. NOTE: Case-level exception types cannot be used with this method

conclusion - the RdrConclusion object that defines the exlet to execute

handle - a current session handle to the worklet service

Returns:

a success or error message

Throws:

java.io.IOException - if the service can't be reached

execute

public java.lang.String execute(WorkItemRecord wir,
                                RuleType rType,
                                RdrConclusion conclusion,
                                java.util.Set<java.lang.String> workletSet,
                                java.lang.String handle)
                         throws java.io.IOException

Raises an exception and executes the exception handler defined in an RdrConclusion. A raised exception will be announced to listeners as a byproduct of this method call.

Parameters:

wir - the workitem containing specification and task identifiers. PRE: the workitem must currently exist in the engine

rType - the type of rule tree to evaluate. NOTE: Case-level exception types cannot be used with this method

conclusion - the RdrConclusion object that defines the exlet to execute

workletSet - a set of worklet specifications to be loaded into the engine for use as compensation handlers during the exception handling

handle - a current session handle to the worklet service

Returns:

a success or error message

Throws:

java.io.IOException - if the service can't be reached

execute

public java.lang.String execute(WorkItemRecord wir,
                                RuleType rType,
                                RdrConclusion conclusion,
                                java.lang.String workletXML,
                                java.lang.String handle)
                         throws java.io.IOException

Raises an exception and executes the exception handler defined in an RdrConclusion. A raised exception will be announced to listeners as a byproduct of this method call.

Parameters:

wir - the workitem containing specification and task identifiers. PRE: the workitem must currently exist in the engine

rType - the type of rule tree to evaluate. NOTE: Case-level exception types cannot be used with this method

conclusion - the RdrConclusion object that defines the exlet to execute

workletXML - a worklet specification to be loaded into the engine for use as a compensation handler during the exception handling

handle - a current session handle to the worklet service

Returns:

a success or error message

Throws:

java.io.IOException - if the service can't be reached

addNode

public java.lang.String addNode(WorkItemRecord wir,
                                RuleType rType,
                                RdrNode node,
                                java.lang.String handle)
                         throws java.io.IOException

Adds a node to a ruleSet. If the appropriate rule tree exists, the node is added to the correct place in the tree; if the rule tree does not yet exist, it is created and the node added as its first rule node (after the root); the there is no ruleSet for the parameters, one is created, and a new tree inserted as above.

Parameters:

wir - the workitem containing specification and task identifiers

rType - the type of rule tree to add the node to

node - the node to add. It is not required that values are given for id, parent, true child or false child - these will be calculated and incorporated when the node is added. It is necessary that values are given for condition, conclusion and particularly cornerstone data, which is used to determine the correct place to insert the node within the tree. Not supplying these values will produce unpredictable results

handle - a current session handle to the worklet service

Returns:

the added node, updated with parent and child ids as appropriate

Throws:

java.io.IOException - if the service can't be reached

addNode

public java.lang.String addNode(YSpecificationID specID,
                                java.lang.String taskID,
                                RuleType rType,
                                RdrNode node,
                                java.lang.String handle)
                         throws java.io.IOException

Adds a node to a ruleSet. If the appropriate rule tree exists, the node is added to the correct place in the tree; if the rule tree does not yet exist, it is created and the node added as its first rule node (after the root); the there is no ruleSet for the parameters, one is created, and a new tree inserted as above.

Parameters:

specID - the specification identifier

taskID - the task identifier (may be null for case-level rule types)

rType - the type of rule tree to add the node to

node - the node to add. It is not required that values are given for id, parent, true child or false child - these will be calculated and incorporated when the node is added. It is necessary that values are given for condition, conclusion and particularly cornerstone data, which is used to determine the correct place to insert the node within the tree. Not supplying these values will produce unpredictable results

handle - a current session handle to the worklet service

Returns:

the added node, updated with parent and child ids as appropriate

Throws:

java.io.IOException - if the service can't be reached

addNode

public java.lang.String addNode(java.lang.String processName,
                                java.lang.String taskID,
                                RuleType rType,
                                RdrNode node,
                                java.lang.String handle)
                         throws java.io.IOException

Adds a node to a ruleSet. If the appropriate rule tree exists, the node is added to the correct place in the tree; if the rule tree does not yet exist, it is created and the node added as its first rule node (after the root); the there is no ruleSet for the parameters, one is created, and a new tree inserted as above.

Parameters:

processName - the process identifier, or unique ruleset name

taskID - the task identifier (may be null for case-level rule types)

rType - the type of rule tree to add the node to

node - the node to add. It is not required that values are given for id, parent, true child or false child - these will be calculated and incorporated when the node is added. It is necessary that values are given for condition, conclusion and particularly cornerstone data, which is used to determine the correct place to insert the node within the tree. Not supplying these values will produce unpredictable results

handle - a current session handle to the worklet service

Returns:

the added node, updated with parent and child ids as appropriate

Throws:

java.io.IOException - if the service can't be reached

getNode

public java.lang.String getNode(long nodeID,
                                java.lang.String handle)
                         throws java.io.IOException

Gets a copy of a particular node from a rule set

Parameters:

nodeID - the (integer) node id

handle - a current session handle to the worklet service

Returns:

the node, if found

Throws:

java.io.IOException - if the service can't be reached

removeNode

public java.lang.String removeNode(YSpecificationID specID,
                                   java.lang.String taskID,
                                   RuleType rType,
                                   long nodeID,
                                   java.lang.String handle)
                            throws java.io.IOException

Removes a rule node from a rule tree, triggers a tree restructure

Parameters:

specID - the specification identifier

taskID - the task identifier (may be null for case-level rule types)

rType - the type of rule tree to get the node from

handle - a current session handle to the worklet service

Returns:

a success or failure message

Throws:

java.io.IOException - if the service can't be reached

getRdrTree

public java.lang.String getRdrTree(WorkItemRecord wir,
                                   RuleType rType,
                                   java.lang.String handle)
                            throws java.io.IOException

Gets a copy of a particular rule tree

Parameters:

wir - the workitem containing specification and task identifiers

rType - the type of rule tree to get the node from

handle - a current session handle to the worklet service

Returns:

the tree, if found for the specification/task/rule-type combination

Throws:

java.io.IOException - if the service can't be reached

getRdrTree

public java.lang.String getRdrTree(YSpecificationID specID,
                                   java.lang.String taskID,
                                   RuleType rType,
                                   java.lang.String handle)
                            throws java.io.IOException

Gets a copy of a particular rule tree

Parameters:

specID - the specification identifier

taskID - the task identifier (may be null for case-level rule types)

rType - the type of rule tree to get the node from

handle - a current session handle to the worklet service

Returns:

the tree, if found for the specification/task/rule-type combination

Throws:

java.io.IOException - if the service can't be reached

getRdrTree

public java.lang.String getRdrTree(java.lang.String processName,
                                   java.lang.String taskID,
                                   RuleType rType,
                                   java.lang.String handle)
                            throws java.io.IOException

Gets a copy of a particular rule tree

Parameters:

processName - the process identifier, or unique ruleset name

taskID - the task identifier (may be null for case-level rule types)

rType - the type of rule tree to get the node from

handle - a current session handle to the worklet service

Returns:

the tree, if found for the process/task/rule-type combination

Throws:

java.io.IOException - if the service can't be reached

getRdrSet

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

Gets a copy of a particular rule set

Parameters:

specID - the specification identifier

handle - a current session handle to the worklet service

Returns:

the rule set, if found for the specification

Throws:

java.io.IOException - if the service can't be reached

getRdrSet

public java.lang.String getRdrSet(java.lang.String processName,
                                  java.lang.String handle)
                           throws java.io.IOException

Gets a copy of a particular rule set

Parameters:

processName - the process identifier, or unique ruleset name

handle - a current session handle to the worklet service

Returns:

the rule set, if found for the process

Throws:

java.io.IOException - if the service can't be reached

getRdrSetIDs

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

Gets the identifiers for all rule sets

Parameters:

handle - a current session handle to the worklet service

Returns:

the set of all rule set ids stored by the service (as XML). Specification ids will be of the form "identifier:version:uri" (i.e. its 'full string')

Throws:

java.io.IOException - if the service can't be reached

addRdrSet

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

Adds a complete (legacy) rule set, expressed as xml

Parameters:

specID - the id of the specification the rule set is defined for

ruleSetXML - the rule set to add

handle - a current session handle to the worklet service

Returns:

a success or error message

Throws:

java.io.IOException - if the service can't be reached

addRdrSet

public java.lang.String addRdrSet(java.lang.String processName,
                                  java.lang.String ruleSetXML,
                                  java.lang.String handle)
                           throws java.io.IOException

Adds a complete (legacy) rule set, expressed as xml

Parameters:

processName - the name of the process the rule set is defined for

ruleSetXML - the rule set to add

handle - a current session handle to the worklet service

Returns:

a success or error message

Throws:

java.io.IOException - if the service can't be reached

removeRdrSet

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

Removes a rule set

Parameters:

specID - the specification id of the rule set to remove

handle - a current session handle to the worklet service

Returns:

a success or error message

Throws:

java.io.IOException - if the service can't be reached

removeRdrSet

public java.lang.String removeRdrSet(java.lang.String identifier,
                                     java.lang.String handle)
                              throws java.io.IOException

Removes a rule set

Parameters:

identifier - the id of the rule set to remove

handle - a current session handle to the worklet service

Returns:

a success or error message

Throws:

java.io.IOException - if the service can't be reached

getWorklet

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

Gets the specified worklet, if loaded in the service

Parameters:

specID - the Worklet specification id

handle - a current session handle to the worklet service

Returns:

the worklet xml, if found, or an error message if not

Throws:

java.io.IOException - if the service can't be reached

addWorklet

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

Adds a worklet to the service repertoire

Parameters:

specID - the Worklet specification id

workletXML - the worklet specification (as XML) to add

handle - a current session handle to the worklet service

Returns:

a success or error message

Throws:

java.io.IOException - if the service can't be reached

replaceWorklet

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

Replaces a worklet instance (or instances) started for a work item with a new instance (or instances), based on a 'pre' updated rule set

Parameters:

itemID - the item id of the parent that launched the worklet(s)

handle - a current session handle to the worklet service

Returns:

a list of case ids of the new instances, or an error message

Throws:

java.io.IOException - if the service can't be reached

replaceWorklet

public java.lang.String replaceWorklet(java.lang.String caseID,
                                       java.lang.String itemID,
                                       RuleType ruleType,
                                       java.lang.String handle)
                                throws java.io.IOException

Replaces a worklet instance (or instances) started for an exlet with a new instance (or instances), based on a 'pre' updated rule set

Parameters:

caseID - the parent case id

itemID - the item id of the parent that launched the worklet(s). May be null (if case level exception)

handle - a current session handle to the worklet service

Returns:

a list of case ids of the new instances, or an error message

Throws:

java.io.IOException - if the service can't be reached

removeWorklet

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

Gets the specified worklet, if loaded in the service

Parameters:

specKey - the Worklet specification id key

handle - a current session handle to the worklet service

Returns:

the worklet xml, if found, or an error message if not

Throws:

java.io.IOException - if the service can't be reached

removeWorklet

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

Gets the specified worklet, if loaded in the service

Parameters:

specID - the Worklet specification id

handle - a current session handle to the worklet service

Returns:

the worklet xml, if found, or an error message if not

Throws:

java.io.IOException - if the service can't be reached

getWorkletNames

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

Gets a list of the names of all the worklets in the repository

Parameters:

handle - a current session handle to the worklet service

Returns:

an XML representation of the list of worklet names

Throws:

java.io.IOException - if the service can't be reached

getWorkletInfoList

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

Gets a list of specification descriptors of all the worklets in the repository

Parameters:

handle - a current session handle to the worklet service

Returns:

an XML representation of the list of worklet specifications

Throws:

java.io.IOException - if the service can't be reached

getRunningWorklets

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

Gets an info set of all currently running worklets

Parameters:

handle - a current session handle to the worklet service

Returns:

an XML representation of the list of running worklets

Throws:

java.io.IOException - if the service can't be reached

getOrphanedWorklets

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

Gets an info set of all stored worklets that are not referenced by any rule

Parameters:

handle - a current session handle to the worklet service

Returns:

an XML representation of the list of orphaned worklets

Throws:

java.io.IOException - if the service can't be reached

loadFile

public java.lang.String loadFile(java.lang.String path,
                                 java.lang.String extn,
                                 java.lang.String handle)
                          throws java.io.IOException

Loads a file or files into the worklet repository. If the path is a directory, will load all files in that directory and its sub-directories of the specified type.

Parameters:

path - the file path to load

extn - one of '.xrs' (for a rules file) or '.yawl' (for a worklet file)

handle - a current session handle to the worklet service

Returns:

a success message or a list of error messages

Throws:

java.io.IOException - if the service can't be reached

updateRdrSetTaskIDs

public java.lang.String updateRdrSetTaskIDs(YSpecificationID specID,
                                            java.util.Map<java.lang.String,java.lang.String> updateMap,
                                            java.lang.String handle)
                                     throws java.io.IOException

Updates the task ids in a rule set for those they have been changed to via a specification edit

Parameters:

specID - the specification id for the rule set to update

updateMap - the map of changes [oldID -> newID]

handle - a current session handle to the worklet service

Returns:

a success or error message

Throws:

java.io.IOException - if the service can't be reached