org.yawlfoundation.yawl.resourcing.rsInterface
Class WorkQueueGatewayClient

java.lang.Object
  extended by org.yawlfoundation.yawl.engine.interfce.Interface_Client
      extended by 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
WorkQueueGatewayClient()
          empty constructor
WorkQueueGatewayClient(String uri)
          constructor
 
Method Summary
 String acceptOffer(String pid, String itemID, String handle)
           
 String addRegisteredService(String uri, String name, String doco, boolean assignable, String handle)
           
 String allocateItem(String pid, String itemID, String handle)
           
 String cancelCase(String caseID, String handle)
           
 String checkConnection(String handle)
           
 String completeItem(String pid, String itemID, String handle)
           
 String connect(String userID, String password)
          Connects an external entity to the resource service
 String deallocateItem(String pid, String itemID, String handle)
           
 String delegateItem(String pFrom, String pTo, String itemID, String handle)
           
 void disconnect(String handle)
          Disconnects an external entity from the resource service
 String getAdminQueues(String handle)
           
 String getAllParticipants(String handle)
           
 String getCaseData(String caseID, String handle)
           
 String getCaseDataSchema(YSpecificationID specID, String handle)
           
 String getDecompID(WorkItemRecord wir, String handle)
           
 String getDistributionSet(String itemid, String handle)
           
 String getFullNameForUserID(String userid, String handle)
           
 String getLoadedSpecs(String handle)
           
 String getOrgGroupMembers(String oid, String handle)
           
 String getParticipant(String pid, String handle)
           
 String getParticipantFromUserID(String userid, String handle)
           
 String getParticipantsAssignedWorkItem(String workItemID, int queueType, String handle)
           
 String getQueuedWorkItems(String pid, int queue, String handle)
           
 String getRegisteredServices(String handle)
           
 String getReportingToParticipant(String pid, String handle)
           
 String getRoleMembers(String rid, String handle)
           
 String getRunningCases(YSpecificationID specID, String handle)
           
 String getSpecData(YSpecificationID specID, String handle)
           
 String getSpecList(String handle)
           
 String getTaskPrivileges(String itemid, String handle)
           
 String getUserPrivileges(String pid, String handle)
           
 String getWorkItem(String itemID, String handle)
           
 String getWorkItemChildren(String itemID, String handle)
           
 String getWorkItemDataSchema(String itemID, String handle)
           
 String getWorkItemDurationsForParticipant(YSpecificationID specID, String taskName, String pid, String handle)
           
 String getWorkItemOutputOnlyParameters(String itemID, String handle)
           
 String getWorkItemParameters(String itemID, String handle)
           
 String isValidUserSession(String handle)
           
 String launchCase(YSpecificationID specID, String caseData, String handle)
           
 String offerItem(Set<String> pids, String itemID, String handle)
           
 String pileItem(String pid, String itemID, String handle)
           
 String reallocateItem(String pid, String itemID, String handle)
           
 String reallocateItem(String pFrom, String pTo, String itemID, boolean stateful, String handle)
           
 String redirectWorkItemToYawlService(String itemID, String serviceName, String handle)
           
 String removeRegisteredService(String id, String handle)
           
 String reofferItem(Set<String> pids, String itemID, String handle)
           
 String restartItem(String pid, String itemID, String handle)
           
 String skipItem(String pid, String itemID, String handle)
           
 String startItem(String pid, String itemID, String handle)
           
 String suspendItem(String pid, String itemID, String handle)
           
 String synchroniseCaches(String handle)
           
 String unloadSpecification(YSpecificationID specID, String handle)
           
 String unsuspendItem(String pid, String itemID, String handle)
           
 String updateWIRCache(WorkItemRecord wir, String handle)
           
 String updateWorkItemData(String itemID, String data, String handle)
           
 String uploadSpecification(String fileContents, String fileName, String handle)
           
 String userlogin(String userID, String password)
           
 String userlogin(String userID, String password, boolean encrypt)
           
 String userlogout(String handle)
           
 
Methods inherited from class org.yawlfoundation.yawl.engine.interfce.Interface_Client
executeGet, executePost, prepareParamMap, 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(String uri)
constructor

Parameters:
uri - the uri of the resourceService's workqueue gateway
Method Detail

connect

public String connect(String userID,
                      String password)
               throws IOException
Connects an external entity to the resource service

Parameters:
userID -
password -
Returns:
a sessionHandle if successful, or a failure message if not
Throws:
IOException

disconnect

public void disconnect(String handle)
                throws IOException
Disconnects an external entity from the resource service

Parameters:
handle - the sessionHandle to disconnect
Throws:
IOException

userlogin

public String userlogin(String userID,
                        String password,
                        boolean encrypt)
                 throws IOException
Throws:
IOException

userlogin

public String userlogin(String userID,
                        String password)
                 throws IOException
Throws:
IOException

userlogout

public String userlogout(String handle)
                  throws IOException
Throws:
IOException

isValidUserSession

public String isValidUserSession(String handle)
                          throws IOException
Throws:
IOException

checkConnection

public String checkConnection(String handle)
                       throws IOException
Throws:
IOException

getParticipantFromUserID

public String getParticipantFromUserID(String userid,
                                       String handle)
                                throws IOException
Throws:
IOException

getFullNameForUserID

public String getFullNameForUserID(String userid,
                                   String handle)
                            throws IOException
Throws:
IOException

getUserPrivileges

public String getUserPrivileges(String pid,
                                String handle)
                         throws IOException
Throws:
IOException

getTaskPrivileges

public String getTaskPrivileges(String itemid,
                                String handle)
                         throws IOException
Throws:
IOException

getReportingToParticipant

public String getReportingToParticipant(String pid,
                                        String handle)
                                 throws IOException
Throws:
IOException

getOrgGroupMembers

public String getOrgGroupMembers(String oid,
                                 String handle)
                          throws IOException
Throws:
IOException

getRoleMembers

public String getRoleMembers(String rid,
                             String handle)
                      throws IOException
Throws:
IOException

getParticipant

public String getParticipant(String pid,
                             String handle)
                      throws IOException
Throws:
IOException

getAllParticipants

public String getAllParticipants(String handle)
                          throws IOException
Throws:
IOException

getDistributionSet

public String getDistributionSet(String itemid,
                                 String handle)
                          throws IOException
Throws:
IOException

getAdminQueues

public String getAdminQueues(String handle)
                      throws IOException
Throws:
IOException

getQueuedWorkItems

public String getQueuedWorkItems(String pid,
                                 int queue,
                                 String handle)
                          throws IOException
Throws:
IOException

getWorkItem

public String getWorkItem(String itemID,
                          String handle)
                   throws IOException
Throws:
IOException

getWorkItemChildren

public String getWorkItemChildren(String itemID,
                                  String handle)
                           throws IOException
Throws:
IOException

updateWorkItemData

public String updateWorkItemData(String itemID,
                                 String data,
                                 String handle)
                          throws IOException
Throws:
IOException

getWorkItemParameters

public String getWorkItemParameters(String itemID,
                                    String handle)
                             throws IOException
Throws:
IOException

getWorkItemDataSchema

public String getWorkItemDataSchema(String itemID,
                                    String handle)
                             throws IOException
Throws:
IOException

getCaseDataSchema

public String getCaseDataSchema(YSpecificationID specID,
                                String handle)
                         throws IOException
Throws:
IOException

getWorkItemOutputOnlyParameters

public String getWorkItemOutputOnlyParameters(String itemID,
                                              String handle)
                                       throws IOException
Throws:
IOException

synchroniseCaches

public String synchroniseCaches(String handle)
                         throws IOException
Throws:
IOException

getParticipantsAssignedWorkItem

public String getParticipantsAssignedWorkItem(String workItemID,
                                              int queueType,
                                              String handle)
                                       throws IOException
Throws:
IOException

acceptOffer

public String acceptOffer(String pid,
                          String itemID,
                          String handle)
                   throws IOException
Throws:
IOException

startItem

public String startItem(String pid,
                        String itemID,
                        String handle)
                 throws IOException
Throws:
IOException

deallocateItem

public String deallocateItem(String pid,
                             String itemID,
                             String handle)
                      throws IOException
Throws:
IOException

delegateItem

public String delegateItem(String pFrom,
                           String pTo,
                           String itemID,
                           String handle)
                    throws IOException
Throws:
IOException

skipItem

public String skipItem(String pid,
                       String itemID,
                       String handle)
                throws IOException
Throws:
IOException

pileItem

public String pileItem(String pid,
                       String itemID,
                       String handle)
                throws IOException
Throws:
IOException

suspendItem

public String suspendItem(String pid,
                          String itemID,
                          String handle)
                   throws IOException
Throws:
IOException

reallocateItem

public String reallocateItem(String pFrom,
                             String pTo,
                             String itemID,
                             boolean stateful,
                             String handle)
                      throws IOException
Throws:
IOException

completeItem

public String completeItem(String pid,
                           String itemID,
                           String handle)
                    throws IOException
Throws:
IOException

unsuspendItem

public String unsuspendItem(String pid,
                            String itemID,
                            String handle)
                     throws IOException
Throws:
IOException

offerItem

public String offerItem(Set<String> pids,
                        String itemID,
                        String handle)
                 throws IOException
Throws:
IOException

reofferItem

public String reofferItem(Set<String> pids,
                          String itemID,
                          String handle)
                   throws IOException
Throws:
IOException

allocateItem

public String allocateItem(String pid,
                           String itemID,
                           String handle)
                    throws IOException
Throws:
IOException

reallocateItem

public String reallocateItem(String pid,
                             String itemID,
                             String handle)
                      throws IOException
Throws:
IOException

restartItem

public String restartItem(String pid,
                          String itemID,
                          String handle)
                   throws IOException
Throws:
IOException

redirectWorkItemToYawlService

public String redirectWorkItemToYawlService(String itemID,
                                            String serviceName,
                                            String handle)
                                     throws IOException
Throws:
IOException

getLoadedSpecs

public String getLoadedSpecs(String handle)
                      throws IOException
Throws:
IOException

getSpecList

public String getSpecList(String handle)
                   throws IOException
Throws:
IOException

getSpecData

public String getSpecData(YSpecificationID specID,
                          String handle)
                   throws IOException
Throws:
IOException

uploadSpecification

public String uploadSpecification(String fileContents,
                                  String fileName,
                                  String handle)
                           throws IOException
Throws:
IOException

unloadSpecification

public String unloadSpecification(YSpecificationID specID,
                                  String handle)
                           throws IOException
Throws:
IOException

launchCase

public String launchCase(YSpecificationID specID,
                         String caseData,
                         String handle)
                  throws IOException
Throws:
IOException

getRunningCases

public String getRunningCases(YSpecificationID specID,
                              String handle)
                       throws IOException
Throws:
IOException

cancelCase

public String cancelCase(String caseID,
                         String handle)
                  throws IOException
Throws:
IOException

updateWIRCache

public String updateWIRCache(WorkItemRecord wir,
                             String handle)
                      throws IOException
Throws:
IOException

getDecompID

public String getDecompID(WorkItemRecord wir,
                          String handle)
                   throws IOException
Throws:
IOException

getCaseData

public String getCaseData(String caseID,
                          String handle)
                   throws IOException
Throws:
IOException

getWorkItemDurationsForParticipant

public String getWorkItemDurationsForParticipant(YSpecificationID specID,
                                                 String taskName,
                                                 String pid,
                                                 String handle)
                                          throws IOException
Throws:
IOException

getRegisteredServices

public String getRegisteredServices(String handle)
                             throws IOException
Throws:
IOException

removeRegisteredService

public String removeRegisteredService(String id,
                                      String handle)
                               throws IOException
Throws:
IOException

addRegisteredService

public String addRegisteredService(String uri,
                                   String name,
                                   String doco,
                                   boolean assignable,
                                   String handle)
                            throws IOException
Throws:
IOException


Copyright © 2004-2012 The YAWL Foundation.