org.yawlfoundation.yawl.resourcing.rsInterface

Class WorkQueueGatewayClientAdapter

java.lang.Object

org.yawlfoundation.yawl.resourcing.rsInterface.WorkQueueGatewayClientAdapter

public class WorkQueueGatewayClientAdapter
extends java.lang.Object

This adapter class adds a transformation layer to the resource gateway client, effectively reconstituting the Strings returned from the gateway into java objects.

Author: Michael Adams Date: 26/10/2007 Version: 2.0

Field Summary

Fields

Modifier and Type	Field and Description
protected ResourceMarshaller	_marshaller
protected java.lang.String	_uri
protected WorkQueueGatewayClient	_wqclient

Constructor Summary

Constructors

Constructor and Description
WorkQueueGatewayClientAdapter()
WorkQueueGatewayClientAdapter(java.lang.String uri)

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(YAWLServiceReference service, java.lang.String handle)
boolean	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)
boolean	checkConnection(java.lang.String handle) Checks that the connection to the service is valid
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) Attempts to connect to the service (as a 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 a session from the service
QueueSet	getAdminQueues(java.lang.String handle) *************************************************************************
java.util.Set<Participant>	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)
WorkQueueGatewayClient	getClient()
java.lang.String	getClientURI()
java.lang.String	getDecompID(WorkItemRecord wir, java.lang.String handle)
java.util.Set<Participant>	getDistributionSet(java.lang.String itemID, java.lang.String handle)
java.lang.String	getFullNameForUserID(java.lang.String userid, java.lang.String handle)
java.util.Set<SpecificationData>	getLoadedSpecs(java.lang.String handle) ****************************************************************************
java.util.Set<Participant>	getOrgGroupMembers(java.lang.String oid, java.lang.String handle)
Participant	getParticipant(java.lang.String pid, java.lang.String handle)
Participant	getParticipantFromUserID(java.lang.String userid, java.lang.String handle)
java.util.Set<Participant>	getParticipantsAssignedWorkItem(java.lang.String workItemID, int queueType, java.lang.String handle)
java.util.Set<WorkItemRecord>	getQueuedWorkItems(java.lang.String pid, int queue, java.lang.String handle)
java.util.Set<YAWLServiceReference>	getRegisteredServices(java.lang.String handle) ****************************************************************************
java.util.Set<Participant>	getReportingToParticipant(java.lang.String pid, java.lang.String handle)
java.util.Set<Participant>	getRoleMembers(java.lang.String rid, java.lang.String handle)
java.lang.String	getRunningCases(YSpecificationID specID, java.lang.String handle)
SpecificationData	getSpecData(YSpecificationID specID, java.lang.String handle)
java.util.Set<SpecificationData>	getSpecList(java.lang.String handle)
TaskPrivileges	getTaskPrivileges(java.lang.String itemid, java.lang.String handle)
UserPrivileges	getUserPrivileges(java.lang.String pid, java.lang.String handle)
java.lang.String	getWorkItem(java.lang.String itemID, java.lang.String handle)
java.util.Set<WorkItemRecord>	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.util.Set<YParameter>	getWorkItemOutputOnlyParameters(java.lang.String itemID, java.lang.String handle)
java.util.Set<YParameter>	getWorkItemParameters(java.lang.String itemID, java.lang.String handle)
boolean	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> pid, 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)
boolean	removeResourceEventListener(java.lang.String uri, java.lang.String handle)
java.lang.String	reofferItem(java.util.Set<java.lang.String> pid, java.lang.String itemID, java.lang.String handle)
java.lang.String	restartItem(java.lang.String pid, java.lang.String itemID, java.lang.String handle)
void	setClientURI(java.lang.String uri)
java.lang.String	skipItem(java.lang.String pid, java.lang.String itemID, java.lang.String handle)
WorkItemRecord	startItem(java.lang.String pid, java.lang.String itemID, java.lang.String handle)
protected java.lang.String	successCheck(java.lang.String xml)
boolean	successful(java.lang.String result)
java.lang.String	suspendItem(java.lang.String pid, java.lang.String itemID, java.lang.String handle)
boolean	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)
void	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) Attempts to connect to the service (as a user/participant)
java.lang.String	userlogin(java.lang.String userid, java.lang.String password, boolean encrypt) Attempts to connect to the service (as a user/participant)
java.lang.String	userlogout(java.lang.String handle) Logs out a user session (as opposed to a service connection)

Methods inherited from class java.lang.Object

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

Field Detail

_wqclient

protected WorkQueueGatewayClient _wqclient

_uri

protected java.lang.String _uri

_marshaller

protected ResourceMarshaller _marshaller

Constructor Detail

WorkQueueGatewayClientAdapter

public WorkQueueGatewayClientAdapter()

WorkQueueGatewayClientAdapter

public WorkQueueGatewayClientAdapter(java.lang.String uri)

Method Detail

setClientURI

public void setClientURI(java.lang.String uri)

getClientURI

public java.lang.String getClientURI()

getClient

public WorkQueueGatewayClient getClient()

successful

public boolean successful(java.lang.String result)

successCheck

protected java.lang.String successCheck(java.lang.String xml)
                                 throws ResourceGatewayException

Throws:

ResourceGatewayException

checkConnection

public boolean checkConnection(java.lang.String handle)

Checks that the connection to the service is valid

Parameters:

handle - the current sessionhandle

Returns:

true if the connection is valid, false if otherwise

connect

public java.lang.String connect(java.lang.String userid,
                                java.lang.String password)

Attempts to connect to the service (as a service)

Parameters:

userid - the userid

password - the corresponding password

Returns:

a sessionhandle if successful, or a failure message if otherwise

userlogin

public java.lang.String userlogin(java.lang.String userid,
                                  java.lang.String password)

Attempts to connect to the service (as a user/participant)

Parameters:

userid - the userid

password - the corresponding password

Returns:

a sessionhandle if successful, or a failure message if otherwise

userlogout

public java.lang.String userlogout(java.lang.String handle)

Logs out a user session (as opposed to a service connection)

Parameters:

handle - the session handle

Returns:

a success message

Throws:

java.io.IOException

userlogin

public java.lang.String userlogin(java.lang.String userid,
                                  java.lang.String password,
                                  boolean encrypt)

Attempts to connect to the service (as a user/participant)

Parameters:

userid - the userid

password - the corresponding password

encrypt - true if encryption is required (most cases); false if the password is already encrypted

Returns:

a sessionhandle if successful, or a failure message if otherwise

disconnect

public void disconnect(java.lang.String handle)

Disconnects a session from the service

Parameters:

handle - the sessionhandle of the session to disconnect

isValidUserSession

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

Throws:

java.io.IOException

getParticipantFromUserID

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

Throws:

java.io.IOException

ResourceGatewayException

getFullNameForUserID

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

Throws:

java.io.IOException

ResourceGatewayException

getUserPrivileges

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

Throws:

java.io.IOException

ResourceGatewayException

getTaskPrivileges

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

Throws:

java.io.IOException

ResourceGatewayException

getReportingToParticipant

public java.util.Set<Participant> getReportingToParticipant(java.lang.String pid,
                                                            java.lang.String handle)
                                                     throws java.io.IOException,
                                                            ResourceGatewayException

Throws:

java.io.IOException

ResourceGatewayException

getOrgGroupMembers

public java.util.Set<Participant> getOrgGroupMembers(java.lang.String oid,
                                                     java.lang.String handle)
                                              throws java.io.IOException,
                                                     ResourceGatewayException

Throws:

java.io.IOException

ResourceGatewayException

getRoleMembers

public java.util.Set<Participant> getRoleMembers(java.lang.String rid,
                                                 java.lang.String handle)
                                          throws java.io.IOException,
                                                 ResourceGatewayException

Throws:

java.io.IOException

ResourceGatewayException

getParticipant

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

Throws:

java.io.IOException

ResourceGatewayException

getAllParticipants

public java.util.Set<Participant> getAllParticipants(java.lang.String handle)
                                              throws java.io.IOException,
                                                     ResourceGatewayException

Throws:

java.io.IOException

ResourceGatewayException

getDistributionSet

public java.util.Set<Participant> getDistributionSet(java.lang.String itemID,
                                                     java.lang.String handle)
                                              throws java.io.IOException,
                                                     ResourceGatewayException

Throws:

java.io.IOException

ResourceGatewayException

getAdminQueues

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

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

Throws:

java.io.IOException

ResourceGatewayException

getQueuedWorkItems

public java.util.Set<WorkItemRecord> getQueuedWorkItems(java.lang.String pid,
                                                        int queue,
                                                        java.lang.String handle)
                                                 throws java.io.IOException,
                                                        ResourceGatewayException

Throws:

java.io.IOException

ResourceGatewayException

getWorkItem

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

Throws:

java.io.IOException

ResourceGatewayException

getWorkItemChildren

public java.util.Set<WorkItemRecord> getWorkItemChildren(java.lang.String itemID,
                                                         java.lang.String handle)
                                                  throws java.io.IOException,
                                                         ResourceGatewayException

Throws:

java.io.IOException

ResourceGatewayException

getWorkItemParameters

public java.util.Set<YParameter> getWorkItemParameters(java.lang.String itemID,
                                                       java.lang.String handle)
                                                throws java.io.IOException,
                                                       ResourceGatewayException

Throws:

java.io.IOException

ResourceGatewayException

getWorkItemOutputOnlyParameters

public java.util.Set<YParameter> getWorkItemOutputOnlyParameters(java.lang.String itemID,
                                                                 java.lang.String handle)
                                                          throws java.io.IOException,
                                                                 ResourceGatewayException

Throws:

java.io.IOException

ResourceGatewayException

getWorkItemDataSchema

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

Throws:

java.io.IOException

ResourceGatewayException

getCaseDataSchema

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

Throws:

java.io.IOException

ResourceGatewayException

synchroniseCaches

public boolean synchroniseCaches(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,
                                           ResourceGatewayException

Throws:

java.io.IOException

ResourceGatewayException

getParticipantsAssignedWorkItem

public java.util.Set<Participant> getParticipantsAssignedWorkItem(java.lang.String workItemID,
                                                                  int queueType,
                                                                  java.lang.String handle)
                                                           throws java.io.IOException,
                                                                  ResourceGatewayException

Throws:

java.io.IOException

ResourceGatewayException

acceptOffer

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

Throws:

java.io.IOException

ResourceGatewayException

startItem

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

Throws:

java.io.IOException

ResourceGatewayException

deallocateItem

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

Throws:

java.io.IOException

ResourceGatewayException

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,
                                     ResourceGatewayException

Throws:

java.io.IOException

ResourceGatewayException

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,
                                       ResourceGatewayException

Throws:

java.io.IOException

ResourceGatewayException

skipItem

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

Throws:

java.io.IOException

ResourceGatewayException

pileItem

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

Throws:

java.io.IOException

ResourceGatewayException

suspendItem

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

Throws:

java.io.IOException

ResourceGatewayException

unsuspendItem

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

Throws:

java.io.IOException

ResourceGatewayException

completeItem

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

Throws:

java.io.IOException

ResourceGatewayException

offerItem

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

Throws:

java.io.IOException

ResourceGatewayException

reofferItem

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

Throws:

java.io.IOException

ResourceGatewayException

allocateItem

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

Throws:

java.io.IOException

ResourceGatewayException

reallocateItem

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

Throws:

java.io.IOException

ResourceGatewayException

restartItem

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

Throws:

java.io.IOException

ResourceGatewayException

redirectWorkItemToYawlService

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

Throws:

java.io.IOException

ResourceGatewayException

getLoadedSpecs

public java.util.Set<SpecificationData> getLoadedSpecs(java.lang.String handle)
                                                throws java.io.IOException

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

Throws:

java.io.IOException

getSpecList

public java.util.Set<SpecificationData> getSpecList(java.lang.String handle)
                                             throws java.io.IOException

Throws:

java.io.IOException

getSpecData

public SpecificationData 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 void 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.util.Set<YAWLServiceReference> 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(YAWLServiceReference service,
                                             java.lang.String handle)
                                      throws java.io.IOException

Throws:

java.io.IOException

addResourceEventListener

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

Throws:

java.io.IOException

removeResourceEventListener

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

Throws:

java.io.IOException