org.yawlfoundation.yawl.resourcing.rsInterface

Class WorkQueueGatewayClient

java.lang.Object

org.yawlfoundation.yawl.engine.interfce.Interface_Client

org.yawlfoundation.yawl.resourcing.rsInterface.WorkQueueGatewayClient

public class WorkQueueGatewayClient
extends Interface_Client

The WorkQueue Gateway externalises the full worklist functionality of the Resource Service by providign a gateway (or a set of API) between the Service and the participant workqueue jsps.

Author:

Michael Adams v0.1, 13/08/2007

Last Date: 17/12/2008

Constructor Summary

Constructors

Constructor and Description
WorkQueueGatewayClient() empty constructor
WorkQueueGatewayClient(java.lang.String uri) constructor

Method Summary

Modifier and Type	Method and Description
java.lang.String	acceptOffer(java.lang.String pid, java.lang.String itemID, java.lang.String handle)
java.lang.String	addRegisteredService(java.lang.String uri, java.lang.String name, java.lang.String password, java.lang.String doco, boolean assignable, java.lang.String handle)
java.lang.String	addResourceEventListener(java.lang.String uri, java.lang.String handle)
java.lang.String	allocateItem(java.lang.String pid, java.lang.String itemID, java.lang.String handle)
java.lang.String	cancelCase(java.lang.String caseID, java.lang.String handle)
java.lang.String	checkConnection(java.lang.String handle)
java.lang.String	completeItem(java.lang.String pid, java.lang.String itemID, java.lang.String handle)
java.lang.String	connect(java.lang.String userID, java.lang.String password) Connects an external entity to the resource service
java.lang.String	deallocateItem(java.lang.String pid, java.lang.String itemID, java.lang.String handle)
java.lang.String	delegateItem(java.lang.String pFrom, java.lang.String pTo, java.lang.String itemID, java.lang.String handle)
void	disconnect(java.lang.String handle) Disconnects an external entity from the resource service
java.lang.String	getAdminQueues(java.lang.String handle) ****************************************************************************
java.lang.String	getAllParticipants(java.lang.String handle)
java.lang.String	getCaseData(java.lang.String caseID, java.lang.String handle)
java.lang.String	getCaseDataSchema(YSpecificationID specID, java.lang.String handle)
java.lang.String	getDecompID(WorkItemRecord wir, java.lang.String handle)
java.lang.String	getDistributionSet(java.lang.String itemid, java.lang.String handle)
java.lang.String	getFullNameForUserID(java.lang.String userid, java.lang.String handle)
java.lang.String	getLoadedSpecs(java.lang.String handle) ****************************************************************************
java.lang.String	getOrgGroupMembers(java.lang.String oid, java.lang.String handle)
java.lang.String	getParticipant(java.lang.String pid, java.lang.String handle)
java.lang.String	getParticipantFromUserID(java.lang.String userid, java.lang.String handle) **************************************************************************
java.lang.String	getParticipantsAssignedWorkItem(java.lang.String workItemID, int queueType, java.lang.String handle)
java.lang.String	getQueuedWorkItems(java.lang.String pid, int queue, java.lang.String handle)
java.lang.String	getRegisteredServices(java.lang.String handle) ****************************************************************************
java.lang.String	getReportingToParticipant(java.lang.String pid, java.lang.String handle)
java.lang.String	getRoleMembers(java.lang.String rid, java.lang.String handle)
java.lang.String	getRunningCases(YSpecificationID specID, java.lang.String handle)
java.lang.String	getSpecData(YSpecificationID specID, java.lang.String handle)
java.lang.String	getSpecList(java.lang.String handle)
java.lang.String	getTaskPrivileges(java.lang.String itemid, java.lang.String handle)
java.lang.String	getUserPrivileges(java.lang.String pid, java.lang.String handle)
java.lang.String	getWorkItem(java.lang.String itemID, java.lang.String handle)
java.lang.String	getWorkItemChildren(java.lang.String itemID, java.lang.String handle)
java.lang.String	getWorkItemDataSchema(java.lang.String itemID, java.lang.String handle)
java.lang.String	getWorkItemDurationsForParticipant(YSpecificationID specID, java.lang.String taskName, java.lang.String pid, java.lang.String handle)
java.lang.String	getWorkItemOutputOnlyParameters(java.lang.String itemID, java.lang.String handle)
java.lang.String	getWorkItemParameters(java.lang.String itemID, java.lang.String handle)
java.lang.String	isValidUserSession(java.lang.String handle)
java.lang.String	launchCase(YSpecificationID specID, java.lang.String caseData, java.lang.String handle)
java.lang.String	offerItem(java.util.Set<java.lang.String> pids, java.lang.String itemID, java.lang.String handle)
java.lang.String	pileItem(java.lang.String pid, java.lang.String itemID, java.lang.String handle)
java.lang.String	reallocateItem(java.lang.String pid, java.lang.String itemID, java.lang.String handle)
java.lang.String	reallocateItem(java.lang.String pFrom, java.lang.String pTo, java.lang.String itemID, boolean stateful, java.lang.String handle)
java.lang.String	redirectWorkItemToYawlService(java.lang.String itemID, java.lang.String serviceName, java.lang.String handle)
java.lang.String	removeRegisteredService(java.lang.String id, java.lang.String handle)
java.lang.String	removeResourceEventListener(java.lang.String uri, java.lang.String handle)
java.lang.String	reofferItem(java.util.Set<java.lang.String> pids, java.lang.String itemID, java.lang.String handle)
java.lang.String	restartItem(java.lang.String pid, java.lang.String itemID, java.lang.String handle)
java.lang.String	skipItem(java.lang.String pid, java.lang.String itemID, java.lang.String handle)
java.lang.String	startItem(java.lang.String pid, java.lang.String itemID, java.lang.String handle)
java.lang.String	suspendItem(java.lang.String pid, java.lang.String itemID, java.lang.String handle)
java.lang.String	synchroniseCaches(java.lang.String handle)
java.lang.String	unloadSpecification(YSpecificationID specID, java.lang.String handle)
java.lang.String	unsuspendItem(java.lang.String pid, java.lang.String itemID, java.lang.String handle)
java.lang.String	updateWIRCache(WorkItemRecord wir, java.lang.String handle)
java.lang.String	updateWorkItemData(java.lang.String itemID, java.lang.String data, java.lang.String handle)
java.lang.String	uploadSpecification(java.lang.String fileContents, java.lang.String fileName, java.lang.String handle)
java.lang.String	userlogin(java.lang.String userID, java.lang.String password)
java.lang.String	userlogin(java.lang.String userID, java.lang.String password, boolean encrypt)
java.lang.String	userlogout(java.lang.String handle)

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

WorkQueueGatewayClient

public WorkQueueGatewayClient()

empty constructor

WorkQueueGatewayClient

public WorkQueueGatewayClient(java.lang.String uri)

constructor

Parameters:

uri - the uri of the resourceService's workqueue gateway

Method Detail

connect

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

Connects an external entity to the resource service

Parameters:

userID -

password -

Returns:

a sessionHandle if successful, or a failure message if not

Throws:

java.io.IOException

disconnect

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

Disconnects an external entity from the resource service

Parameters:

handle - the sessionHandle to disconnect

Throws:

java.io.IOException

userlogin

public java.lang.String userlogin(java.lang.String userID,
                                  java.lang.String password,
                                  boolean encrypt)
                           throws java.io.IOException

Throws:

java.io.IOException

userlogin

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

Throws:

java.io.IOException

userlogout

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

Throws:

java.io.IOException

isValidUserSession

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

Throws:

java.io.IOException

checkConnection

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

Throws:

java.io.IOException

getParticipantFromUserID

public java.lang.String getParticipantFromUserID(java.lang.String userid,
                                                 java.lang.String handle)
                                          throws java.io.IOException

**************************************************************************

Throws:

java.io.IOException

getFullNameForUserID

public java.lang.String getFullNameForUserID(java.lang.String userid,
                                             java.lang.String handle)
                                      throws java.io.IOException

Throws:

java.io.IOException

getUserPrivileges

public java.lang.String getUserPrivileges(java.lang.String pid,
                                          java.lang.String handle)
                                   throws java.io.IOException

Throws:

java.io.IOException

getTaskPrivileges

public java.lang.String getTaskPrivileges(java.lang.String itemid,
                                          java.lang.String handle)
                                   throws java.io.IOException

Throws:

java.io.IOException

getReportingToParticipant

public java.lang.String getReportingToParticipant(java.lang.String pid,
                                                  java.lang.String handle)
                                           throws java.io.IOException

Throws:

java.io.IOException

getOrgGroupMembers

public java.lang.String getOrgGroupMembers(java.lang.String oid,
                                           java.lang.String handle)
                                    throws java.io.IOException

Throws:

java.io.IOException

getRoleMembers

public java.lang.String getRoleMembers(java.lang.String rid,
                                       java.lang.String handle)
                                throws java.io.IOException

Throws:

java.io.IOException

getParticipant

public java.lang.String getParticipant(java.lang.String pid,
                                       java.lang.String handle)
                                throws java.io.IOException

Throws:

java.io.IOException

getAllParticipants

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

Throws:

java.io.IOException

getDistributionSet

public java.lang.String getDistributionSet(java.lang.String itemid,
                                           java.lang.String handle)
                                    throws java.io.IOException

Throws:

java.io.IOException

getAdminQueues

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

****************************************************************************

Throws:

java.io.IOException

getQueuedWorkItems

public java.lang.String getQueuedWorkItems(java.lang.String pid,
                                           int queue,
                                           java.lang.String handle)
                                    throws java.io.IOException

Throws:

java.io.IOException

getWorkItem

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

Throws:

java.io.IOException

getWorkItemChildren

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

Throws:

java.io.IOException

updateWorkItemData

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

Throws:

java.io.IOException

getWorkItemParameters

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

Throws:

java.io.IOException

getWorkItemDataSchema

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

Throws:

java.io.IOException

getCaseDataSchema

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

Throws:

java.io.IOException

getWorkItemOutputOnlyParameters

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

Throws:

java.io.IOException

synchroniseCaches

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

Throws:

java.io.IOException

getParticipantsAssignedWorkItem

public java.lang.String getParticipantsAssignedWorkItem(java.lang.String workItemID,
                                                        int queueType,
                                                        java.lang.String handle)
                                                 throws java.io.IOException

Throws:

java.io.IOException

acceptOffer

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

Throws:

java.io.IOException

startItem

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

Throws:

java.io.IOException

deallocateItem

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

Throws:

java.io.IOException

delegateItem

public java.lang.String delegateItem(java.lang.String pFrom,
                                     java.lang.String pTo,
                                     java.lang.String itemID,
                                     java.lang.String handle)
                              throws java.io.IOException

Throws:

java.io.IOException

skipItem

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

Throws:

java.io.IOException

pileItem

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

Throws:

java.io.IOException

suspendItem

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

Throws:

java.io.IOException

reallocateItem

public java.lang.String reallocateItem(java.lang.String pFrom,
                                       java.lang.String pTo,
                                       java.lang.String itemID,
                                       boolean stateful,
                                       java.lang.String handle)
                                throws java.io.IOException

Throws:

java.io.IOException

completeItem

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

Throws:

java.io.IOException

unsuspendItem

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

Throws:

java.io.IOException

offerItem

public java.lang.String offerItem(java.util.Set<java.lang.String> pids,
                                  java.lang.String itemID,
                                  java.lang.String handle)
                           throws java.io.IOException

Throws:

java.io.IOException

reofferItem

public java.lang.String reofferItem(java.util.Set<java.lang.String> pids,
                                    java.lang.String itemID,
                                    java.lang.String handle)
                             throws java.io.IOException

Throws:

java.io.IOException

allocateItem

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

Throws:

java.io.IOException

reallocateItem

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

Throws:

java.io.IOException

restartItem

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

Throws:

java.io.IOException

redirectWorkItemToYawlService

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

Throws:

java.io.IOException

getLoadedSpecs

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

****************************************************************************

Throws:

java.io.IOException

getSpecList

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

Throws:

java.io.IOException

getSpecData

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

Throws:

java.io.IOException

uploadSpecification

public java.lang.String uploadSpecification(java.lang.String fileContents,
                                            java.lang.String fileName,
                                            java.lang.String handle)
                                     throws java.io.IOException

Throws:

java.io.IOException

unloadSpecification

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

Throws:

java.io.IOException

launchCase

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

Throws:

java.io.IOException

getRunningCases

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

Throws:

java.io.IOException

cancelCase

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

Throws:

java.io.IOException

updateWIRCache

public java.lang.String updateWIRCache(WorkItemRecord wir,
                                       java.lang.String handle)
                                throws java.io.IOException

Throws:

java.io.IOException

getDecompID

public java.lang.String getDecompID(WorkItemRecord wir,
                                    java.lang.String handle)
                             throws java.io.IOException

Throws:

java.io.IOException

getCaseData

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

Throws:

java.io.IOException

getWorkItemDurationsForParticipant

public java.lang.String getWorkItemDurationsForParticipant(YSpecificationID specID,
                                                           java.lang.String taskName,
                                                           java.lang.String pid,
                                                           java.lang.String handle)
                                                    throws java.io.IOException

Throws:

java.io.IOException

getRegisteredServices

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

****************************************************************************

Throws:

java.io.IOException

removeRegisteredService

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

Throws:

java.io.IOException

addRegisteredService

public java.lang.String addRegisteredService(java.lang.String uri,
                                             java.lang.String name,
                                             java.lang.String password,
                                             java.lang.String doco,
                                             boolean assignable,
                                             java.lang.String handle)
                                      throws java.io.IOException

Throws:

java.io.IOException

addResourceEventListener

public java.lang.String addResourceEventListener(java.lang.String uri,
                                                 java.lang.String handle)
                                          throws java.io.IOException

Throws:

java.io.IOException

removeResourceEventListener

public java.lang.String removeResourceEventListener(java.lang.String uri,
                                                    java.lang.String handle)
                                             throws java.io.IOException

Throws:

java.io.IOException