public class WorkletClient extends YConnection
_handle, _url
Modifier and Type | Method and Description |
---|---|
boolean |
addRule(YSpecificationID specID,
java.lang.String taskID,
RuleType rule,
RdrNode node) |
boolean |
addRuleSet(YSpecificationID specID,
java.lang.String xml) |
boolean |
addWorklet(YSpecification worklet) |
boolean |
addWorklet(YSpecificationID specID,
java.lang.String workletXML) |
void |
clearCache() |
void |
connect() |
protected boolean |
connect(Interface_Client client)
Attempts to connect to a YAWL instance via an API client.
|
void |
disconnect()
Drop the current connection - if any
|
protected Interface_Client |
getClient() |
static WorkletClient |
getInstance() |
java.lang.String |
getOldTaskID(java.lang.String taskID) |
java.util.List<WorkletInfo> |
getOrphanedWorklets() |
RdrNode |
getRdrNode(long nodeId) |
java.lang.String |
getRdrSet(YSpecificationID specID) |
java.util.List<RdrSetID> |
getRdrSetIDs() |
java.lang.String |
getRdrTree(YSpecificationID specID,
java.lang.String taskID,
RuleType ruleType) |
java.util.List<WorkletRunner> |
getRunningWorkletList() |
SpecificationData |
getSpecificationInfo(YSpecificationID specID) |
TaskIDChangeMap |
getTaskIdChangeMap() |
TaskInformation |
getTaskInfo(YSpecificationID specID,
java.lang.String taskID) |
java.lang.String |
getUpdatedTaskID(java.lang.String taskID) |
protected java.lang.String |
getURLFilePath() |
java.lang.String |
getWorklet(YSpecificationID specID) |
WorkletInfoCache |
getWorkletCache() |
java.util.List<WorkletInfo> |
getWorkletInfoList() |
protected void |
init() |
boolean |
isConnected() |
boolean |
isConnected(Interface_Client client)
Checks that the client currently has a valid connection to a running YAWL
instance, and if not attempts to establish a connection.
|
boolean |
isLoadedSpecUnsavedWorklet() |
java.util.List<java.lang.String> |
loadFile(java.lang.String path,
java.lang.String type) |
void |
refreshSettings() |
void |
removeRdrSet(RdrSetID rdrSetID) |
RdrResult |
removeRule(YSpecificationID specID,
java.lang.String taskID,
RuleType rule,
RdrNode node) |
void |
removeWorklet(java.lang.String specKey) |
java.lang.String |
replaceWorklet(java.lang.String itemID) |
java.lang.String |
replaceWorklet(java.lang.String caseID,
java.lang.String itemID,
RuleType ruleType) |
void |
setLoadedSpecIsUnsavedWorklet(boolean isUnsaved) |
void |
setPassword(java.lang.String pw)
Sets the password for the connection.
|
void |
setTaskIdChangeMap(TaskIDChangeMap map) |
void |
setUserID(java.lang.String id)
Sets the user id for the connection.
|
boolean |
successful(java.lang.String msg) |
boolean |
testConnection(java.lang.String host,
int port,
java.lang.String userId,
java.lang.String password) |
boolean |
updateRdrSetTaskIDs(YSpecificationID specID,
java.util.Map<java.lang.String,java.lang.String> updates) |
disconnect, getHost, getPort, getURL, setURL, setURL, setURL, testConnection
public static WorkletClient getInstance()
public boolean testConnection(java.lang.String host, int port, java.lang.String userId, java.lang.String password) throws java.net.MalformedURLException
java.net.MalformedURLException
protected void init()
init
in class YConnection
protected java.lang.String getURLFilePath()
getURLFilePath
in class YConnection
protected Interface_Client getClient()
getClient
in class YConnection
public void setUserID(java.lang.String id)
YConnection
setUserID
in class YConnection
id
- the user id (cannot be null).public void setPassword(java.lang.String pw)
YConnection
setPassword
in class YConnection
pw
- the password (cannot be null).public void refreshSettings()
public void disconnect()
YConnection
disconnect
in class YConnection
protected boolean connect(Interface_Client client) throws java.io.IOException
YConnection
connect
in class YConnection
client
- the client object to connectjava.io.IOException
- if the client or URL is null, if the URL is not reachable,
or if there is some problem connecting to a YAWL instance at the given URLpublic boolean isConnected()
public boolean isConnected(Interface_Client client)
YConnection
isConnected
in class YConnection
client
- the client object to check and/or connectpublic void connect() throws java.io.IOException
java.io.IOException
public boolean successful(java.lang.String msg)
public void clearCache()
public WorkletInfoCache getWorkletCache()
public TaskIDChangeMap getTaskIdChangeMap()
public void setTaskIdChangeMap(TaskIDChangeMap map)
public java.lang.String getUpdatedTaskID(java.lang.String taskID)
public java.lang.String getOldTaskID(java.lang.String taskID)
public boolean isLoadedSpecUnsavedWorklet()
public void setLoadedSpecIsUnsavedWorklet(boolean isUnsaved)
public java.util.List<WorkletRunner> getRunningWorkletList() throws java.io.IOException
java.io.IOException
public java.util.List<WorkletInfo> getWorkletInfoList() throws java.io.IOException
java.io.IOException
public boolean addRule(YSpecificationID specID, java.lang.String taskID, RuleType rule, RdrNode node) throws java.io.IOException
java.io.IOException
public RdrResult removeRule(YSpecificationID specID, java.lang.String taskID, RuleType rule, RdrNode node) throws java.io.IOException
java.io.IOException
public boolean addRuleSet(YSpecificationID specID, java.lang.String xml) throws java.io.IOException
java.io.IOException
public boolean addWorklet(YSpecification worklet) throws java.io.IOException
java.io.IOException
public boolean addWorklet(YSpecificationID specID, java.lang.String workletXML) throws java.io.IOException
java.io.IOException
public java.lang.String replaceWorklet(java.lang.String itemID) throws java.io.IOException
java.io.IOException
public java.lang.String replaceWorklet(java.lang.String caseID, java.lang.String itemID, RuleType ruleType) throws java.io.IOException
java.io.IOException
public java.lang.String getWorklet(YSpecificationID specID) throws java.io.IOException
java.io.IOException
public java.util.List<WorkletInfo> getOrphanedWorklets() throws java.io.IOException
java.io.IOException
public RdrNode getRdrNode(long nodeId) throws java.io.IOException
java.io.IOException
public java.lang.String getRdrSet(YSpecificationID specID) throws java.io.IOException
java.io.IOException
public java.lang.String getRdrTree(YSpecificationID specID, java.lang.String taskID, RuleType ruleType) throws java.io.IOException
java.io.IOException
public java.util.List<RdrSetID> getRdrSetIDs() throws java.io.IOException
java.io.IOException
public void removeRdrSet(RdrSetID rdrSetID) throws java.io.IOException
java.io.IOException
public void removeWorklet(java.lang.String specKey) throws java.io.IOException
java.io.IOException
public java.util.List<java.lang.String> loadFile(java.lang.String path, java.lang.String type) throws java.io.IOException
java.io.IOException
public boolean updateRdrSetTaskIDs(YSpecificationID specID, java.util.Map<java.lang.String,java.lang.String> updates) throws java.io.IOException
java.io.IOException
public TaskInformation getTaskInfo(YSpecificationID specID, java.lang.String taskID) throws java.io.IOException
java.io.IOException
public SpecificationData getSpecificationInfo(YSpecificationID specID) throws java.io.IOException
java.io.IOException