public class WorkQueueGatewayClientAdapter
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
protected ResourceMarshaller |
_marshaller |
protected java.lang.String |
_uri |
protected WorkQueueGatewayClient |
_wqclient |
Constructor and Description |
---|
WorkQueueGatewayClientAdapter() |
WorkQueueGatewayClientAdapter(java.lang.String uri) |
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)
|
protected WorkQueueGatewayClient _wqclient
protected java.lang.String _uri
protected ResourceMarshaller _marshaller
public WorkQueueGatewayClientAdapter()
public WorkQueueGatewayClientAdapter(java.lang.String uri)
public void setClientURI(java.lang.String uri)
public java.lang.String getClientURI()
public WorkQueueGatewayClient getClient()
public boolean successful(java.lang.String result)
protected java.lang.String successCheck(java.lang.String xml) throws ResourceGatewayException
ResourceGatewayException
public boolean checkConnection(java.lang.String handle)
handle
- the current sessionhandlepublic java.lang.String connect(java.lang.String userid, java.lang.String password)
userid
- the useridpassword
- the corresponding passwordpublic java.lang.String userlogin(java.lang.String userid, java.lang.String password)
userid
- the useridpassword
- the corresponding passwordpublic java.lang.String userlogout(java.lang.String handle)
handle
- the session handlejava.io.IOException
public java.lang.String userlogin(java.lang.String userid, java.lang.String password, boolean encrypt)
userid
- the useridpassword
- the corresponding passwordencrypt
- true if encryption is required (most cases); false if the
password is already encryptedpublic void disconnect(java.lang.String handle)
handle
- the sessionhandle of the session to disconnectpublic boolean isValidUserSession(java.lang.String handle) throws java.io.IOException
java.io.IOException
public Participant getParticipantFromUserID(java.lang.String userid, java.lang.String handle) throws java.io.IOException, ResourceGatewayException
java.io.IOException
ResourceGatewayException
public java.lang.String getFullNameForUserID(java.lang.String userid, java.lang.String handle) throws java.io.IOException, ResourceGatewayException
java.io.IOException
ResourceGatewayException
public UserPrivileges getUserPrivileges(java.lang.String pid, java.lang.String handle) throws java.io.IOException, ResourceGatewayException
java.io.IOException
ResourceGatewayException
public TaskPrivileges getTaskPrivileges(java.lang.String itemid, java.lang.String handle) throws java.io.IOException, ResourceGatewayException
java.io.IOException
ResourceGatewayException
public java.util.Set<Participant> getReportingToParticipant(java.lang.String pid, java.lang.String handle) throws java.io.IOException, ResourceGatewayException
java.io.IOException
ResourceGatewayException
public java.util.Set<Participant> getOrgGroupMembers(java.lang.String oid, java.lang.String handle) throws java.io.IOException, ResourceGatewayException
java.io.IOException
ResourceGatewayException
public java.util.Set<Participant> getRoleMembers(java.lang.String rid, java.lang.String handle) throws java.io.IOException, ResourceGatewayException
java.io.IOException
ResourceGatewayException
public Participant getParticipant(java.lang.String pid, java.lang.String handle) throws java.io.IOException, ResourceGatewayException
java.io.IOException
ResourceGatewayException
public java.util.Set<Participant> getAllParticipants(java.lang.String handle) throws java.io.IOException, ResourceGatewayException
java.io.IOException
ResourceGatewayException
public java.util.Set<Participant> getDistributionSet(java.lang.String itemID, java.lang.String handle) throws java.io.IOException, ResourceGatewayException
java.io.IOException
ResourceGatewayException
public QueueSet getAdminQueues(java.lang.String handle) throws java.io.IOException, ResourceGatewayException
java.io.IOException
ResourceGatewayException
public java.util.Set<WorkItemRecord> getQueuedWorkItems(java.lang.String pid, int queue, java.lang.String handle) throws java.io.IOException, ResourceGatewayException
java.io.IOException
ResourceGatewayException
public java.lang.String getWorkItem(java.lang.String itemID, java.lang.String handle) throws java.io.IOException, ResourceGatewayException
java.io.IOException
ResourceGatewayException
public java.util.Set<WorkItemRecord> getWorkItemChildren(java.lang.String itemID, java.lang.String handle) throws java.io.IOException, ResourceGatewayException
java.io.IOException
ResourceGatewayException
public java.util.Set<YParameter> getWorkItemParameters(java.lang.String itemID, java.lang.String handle) throws java.io.IOException, ResourceGatewayException
java.io.IOException
ResourceGatewayException
public java.util.Set<YParameter> getWorkItemOutputOnlyParameters(java.lang.String itemID, java.lang.String handle) throws java.io.IOException, ResourceGatewayException
java.io.IOException
ResourceGatewayException
public java.lang.String getWorkItemDataSchema(java.lang.String itemID, java.lang.String handle) throws java.io.IOException, ResourceGatewayException
java.io.IOException
ResourceGatewayException
public java.lang.String getCaseDataSchema(YSpecificationID specID, java.lang.String handle) throws java.io.IOException, ResourceGatewayException
java.io.IOException
ResourceGatewayException
public boolean synchroniseCaches(java.lang.String handle) throws java.io.IOException
java.io.IOException
public java.lang.String updateWorkItemData(java.lang.String itemID, java.lang.String data, java.lang.String handle) throws java.io.IOException, ResourceGatewayException
java.io.IOException
ResourceGatewayException
public java.util.Set<Participant> getParticipantsAssignedWorkItem(java.lang.String workItemID, int queueType, java.lang.String handle) throws java.io.IOException, ResourceGatewayException
java.io.IOException
ResourceGatewayException
public java.lang.String acceptOffer(java.lang.String pid, java.lang.String itemID, java.lang.String handle) throws java.io.IOException, ResourceGatewayException
java.io.IOException
ResourceGatewayException
public WorkItemRecord startItem(java.lang.String pid, java.lang.String itemID, java.lang.String handle) throws java.io.IOException, ResourceGatewayException
java.io.IOException
ResourceGatewayException
public java.lang.String deallocateItem(java.lang.String pid, java.lang.String itemID, java.lang.String handle) throws java.io.IOException, ResourceGatewayException
java.io.IOException
ResourceGatewayException
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
java.io.IOException
ResourceGatewayException
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
java.io.IOException
ResourceGatewayException
public java.lang.String skipItem(java.lang.String pid, java.lang.String itemID, java.lang.String handle) throws java.io.IOException, ResourceGatewayException
java.io.IOException
ResourceGatewayException
public java.lang.String pileItem(java.lang.String pid, java.lang.String itemID, java.lang.String handle) throws java.io.IOException, ResourceGatewayException
java.io.IOException
ResourceGatewayException
public java.lang.String suspendItem(java.lang.String pid, java.lang.String itemID, java.lang.String handle) throws java.io.IOException, ResourceGatewayException
java.io.IOException
ResourceGatewayException
public java.lang.String unsuspendItem(java.lang.String pid, java.lang.String itemID, java.lang.String handle) throws java.io.IOException, ResourceGatewayException
java.io.IOException
ResourceGatewayException
public java.lang.String completeItem(java.lang.String pid, java.lang.String itemID, java.lang.String handle) throws java.io.IOException, ResourceGatewayException
java.io.IOException
ResourceGatewayException
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
java.io.IOException
ResourceGatewayException
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
java.io.IOException
ResourceGatewayException
public java.lang.String allocateItem(java.lang.String pid, java.lang.String itemID, java.lang.String handle) throws java.io.IOException, ResourceGatewayException
java.io.IOException
ResourceGatewayException
public java.lang.String reallocateItem(java.lang.String pid, java.lang.String itemID, java.lang.String handle) throws java.io.IOException, ResourceGatewayException
java.io.IOException
ResourceGatewayException
public java.lang.String restartItem(java.lang.String pid, java.lang.String itemID, java.lang.String handle) throws java.io.IOException, ResourceGatewayException
java.io.IOException
ResourceGatewayException
public java.lang.String redirectWorkItemToYawlService(java.lang.String itemID, java.lang.String serviceName, java.lang.String handle) throws java.io.IOException, ResourceGatewayException
java.io.IOException
ResourceGatewayException
public java.util.Set<SpecificationData> getLoadedSpecs(java.lang.String handle) throws java.io.IOException
java.io.IOException
public java.util.Set<SpecificationData> getSpecList(java.lang.String handle) throws java.io.IOException
java.io.IOException
public SpecificationData getSpecData(YSpecificationID specID, java.lang.String handle) throws java.io.IOException
java.io.IOException
public java.lang.String uploadSpecification(java.lang.String fileContents, java.lang.String fileName, java.lang.String handle) throws java.io.IOException
java.io.IOException
public java.lang.String unloadSpecification(YSpecificationID specID, java.lang.String handle) throws java.io.IOException
java.io.IOException
public java.lang.String launchCase(YSpecificationID specID, java.lang.String caseData, java.lang.String handle) throws java.io.IOException
java.io.IOException
public java.lang.String getRunningCases(YSpecificationID specID, java.lang.String handle) throws java.io.IOException
java.io.IOException
public java.lang.String cancelCase(java.lang.String caseID, java.lang.String handle) throws java.io.IOException
java.io.IOException
public void updateWIRCache(WorkItemRecord wir, java.lang.String handle) throws java.io.IOException
java.io.IOException
public java.lang.String getDecompID(WorkItemRecord wir, java.lang.String handle) throws java.io.IOException
java.io.IOException
public java.lang.String getCaseData(java.lang.String caseID, java.lang.String handle) throws java.io.IOException
java.io.IOException
public java.lang.String getWorkItemDurationsForParticipant(YSpecificationID specID, java.lang.String taskName, java.lang.String pid, java.lang.String handle) throws java.io.IOException
java.io.IOException
public java.util.Set<YAWLServiceReference> getRegisteredServices(java.lang.String handle) throws java.io.IOException
java.io.IOException
public java.lang.String removeRegisteredService(java.lang.String id, java.lang.String handle) throws java.io.IOException
java.io.IOException
public java.lang.String addRegisteredService(YAWLServiceReference service, java.lang.String handle) throws java.io.IOException
java.io.IOException
public boolean addResourceEventListener(java.lang.String uri, java.lang.String handle) throws java.io.IOException
java.io.IOException
public boolean removeResourceEventListener(java.lang.String uri, java.lang.String handle) throws java.io.IOException
java.io.IOException
Copyright © 2004-2014 The YAWL Foundation.