org.wso2.bps.integration.common.clients.bpmn

Class ActivitiRestClient

java.lang.Object

org.wso2.bps.integration.common.clients.bpmn.ActivitiRestClient

public class ActivitiRestClient
extends Object

This Class contains methods which uses the BPMN Rest Services to carryout BPMN Task

Version:

1.0

Author:

WSO2

Constructor Summary

Constructors

Constructor and Description
ActivitiRestClient(String portM, String hostnameM)

Method Summary

Methods

Modifier and Type	Method and Description
String	activateProcessInstanceById(String processDefintionID) Method used to activate a process instance
String[]	addNewCommentOnTaskByTaskId(String taskID, String comment) Method used to add a new comment to a task
String	claimTaskByTaskId(String taskID) Method to claim task by a user
String	delegateTaskByTaskId(String taskID) Mehtod to delegate a task to certain user
String	deleteProcessInstanceByID(String processInstanceId) Method used to remove/delete a process instance
String	deleteTaskByTaskId(String taskId, boolean cascadeHistory, String deleteReason) Method to delete a task
String[]	deployBPMNPackage(String filePath, String fileName) This Method is used to deploy BPMN packages to the BPMN Server
String[]	findProcessDefinitionInfoById(String deploymentID) Method to find the definitionID which is necessary to start a process instance
String[]	findTaskIdByProcessInstanceID(String processInstanceId) Method used to find task by using the process instance ID
String	getAssigneeByTaskId(String taskID) Method to get the asignee of a task
String	getCommentByTaskIdAndCommentId(String taskID, String commentID) This method is used to get the comment by comment id and task id
String	getDelegationsStateByTaskId(String taskID) Method used to get the delegation state of a task
String[]	getDeploymentInfoById(String deploymentID) Method is used to acquire deployment details using the deployment ID
String	getSuspendedStateOfProcessInstanceByID(String processInstanceID) Method is used to find thw suspended state of a process instance
String[]	getValueOfVariableOfProcessInstanceById(String processInstanceId, String variable) Method to get the value of a variable in the process instance
String	resolveTaskByTaskId(String taskID) Method used to resolve a task
String	searchProcessInstanceByDefintionID(String processDefintionID) Methods used to test/search if the specify process instance is present
String[]	startProcessInstanceByDefintionID(String processDefintionID) Method use to instantiate a process instance using the definition ID
String[]	suspendProcessInstanceById(String processInstanceID) Method used to suspend a process instance
String	unDeployBPMNPackage(String deploymentID) Method is used to undeploy/remove a deployment from the server
String	validateProcessInstanceById(String processDefinitionID) This method is used to validate/check if the process instance is present or not

Methods inherited from class java.lang.Object

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

Constructor Detail

ActivitiRestClient

public ActivitiRestClient(String portM,
                  String hostnameM)
                   throws MalformedURLException

Throws:

MalformedURLException

Method Detail

deployBPMNPackage

public String[] deployBPMNPackage(String filePath,
                         String fileName)
                           throws RestClientException,
                                  IOException,
                                  org.json.JSONException

This Method is used to deploy BPMN packages to the BPMN Server

Parameters:

fileName - The name of the Package to be deployed

filePath - The location of the BPMN package to be deployed

Throws:

IOException

org.json.JSONException

RestClientException

getDeploymentInfoById

public String[] getDeploymentInfoById(String deploymentID)
                               throws RestClientException,
                                      IOException,
                                      org.json.JSONException

Method is used to acquire deployment details using the deployment ID

Parameters:

deploymentID - Deployment ID of the BPMN Package

Throws:

IOException

org.json.JSONException

RestClientException

unDeployBPMNPackage

public String unDeployBPMNPackage(String deploymentID)
                           throws IOException

Method is used to undeploy/remove a deployment from the server

Parameters:

deploymentID - used to identify the deployment to be removed

Returns:

String with the Status

Throws:

IOException

findProcessDefinitionInfoById

public String[] findProcessDefinitionInfoById(String deploymentID)
                                       throws IOException,
                                              org.json.JSONException

Method to find the definitionID which is necessary to start a process instance

Parameters:

deploymentID - the deployment id is used to identify the deployment uniquely

Returns:

String Array containing status and definitionID

Throws:

IOException

org.json.JSONException

searchProcessInstanceByDefintionID

public String searchProcessInstanceByDefintionID(String processDefintionID)
                                          throws IOException

Methods used to test/search if the specify process instance is present

Parameters:

processDefintionID - used to start a processInstance

Returns:

String which contains the status

Throws:

IOException

validateProcessInstanceById

public String validateProcessInstanceById(String processDefinitionID)
                                   throws IOException,
                                          org.json.JSONException,
                                          RestClientException

This method is used to validate/check if the process instance is present or not

Parameters:

processDefinitionID - used to identify the process instance

Returns:

a String value of the status

Throws:

IOException

org.json.JSONException

RestClientException

startProcessInstanceByDefintionID

public String[] startProcessInstanceByDefintionID(String processDefintionID)
                                           throws IOException,
                                                  org.json.JSONException,
                                                  RestClientException

Method use to instantiate a process instance using the definition ID

Parameters:

processDefintionID - used to start a processInstance

Throws:

IOException

org.json.JSONException

RestClientException

activateProcessInstanceById

public String activateProcessInstanceById(String processDefintionID)
                                   throws IOException

Method used to activate a process instance

Parameters:

processDefintionID - used to identify the process instance to activate

Throws:

IOException

suspendProcessInstanceById

public String[] suspendProcessInstanceById(String processInstanceID)
                                    throws IOException,
                                           org.json.JSONException,
                                           RestClientException

Method used to suspend a process instance

Parameters:

processInstanceID - used to identify the process instance to suspend

Returns:

String array containing the status and the current state

Throws:

IOException

org.json.JSONException

RestClientException

getSuspendedStateOfProcessInstanceByID

public String getSuspendedStateOfProcessInstanceByID(String processInstanceID)
                                              throws IOException,
                                                     org.json.JSONException

Method is used to find thw suspended state of a process instance

Parameters:

processInstanceID - used to identify the process instance

Returns:

String containing the suspended state of the process instance

Throws:

IOException

org.json.JSONException

getValueOfVariableOfProcessInstanceById

public String[] getValueOfVariableOfProcessInstanceById(String processInstanceId,
                                               String variable)
                                                 throws IOException,
                                                        org.json.JSONException

Method to get the value of a variable in the process instance

Parameters:

processInstanceId - To identify the process instance

variable - to identify the variable name

Returns:

String Array containing status, name and the value of the variable

Throws:

IOException

org.json.JSONException

deleteProcessInstanceByID

public String deleteProcessInstanceByID(String processInstanceId)
                                 throws IOException

Method used to remove/delete a process instance

Parameters:

processInstanceId - used to identify a process instance

Returns:

String value containing the status of the request.

Throws:

IOException

getDelegationsStateByTaskId

public String getDelegationsStateByTaskId(String taskID)
                                   throws IOException,
                                          org.json.JSONException

Method used to get the delegation state of a task

Parameters:

taskID - used to identify the task

Returns:

String which contains the state of the task

Throws:

IOException

org.json.JSONException

resolveTaskByTaskId

public String resolveTaskByTaskId(String taskID)
                           throws IOException

Method used to resolve a task

Parameters:

taskID - used to identify the task

Returns:

String which contains the status of the request

Throws:

IOException

getAssigneeByTaskId

public String getAssigneeByTaskId(String taskID)
                           throws IOException,
                                  org.json.JSONException

Method to get the asignee of a task

Parameters:

taskID - used to identify the task

Returns:

String containing the Asignee

Throws:

IOException

org.json.JSONException

getCommentByTaskIdAndCommentId

public String getCommentByTaskIdAndCommentId(String taskID,
                                    String commentID)
                                      throws IOException,
                                             org.json.JSONException

This method is used to get the comment by comment id and task id

Parameters:

taskID - used to identify the task where the comment is made

commentID - used to identify the comment uniquely

Returns:

String containing the comment

Throws:

IOException

org.json.JSONException

findTaskIdByProcessInstanceID

public String[] findTaskIdByProcessInstanceID(String processInstanceId)
                                       throws IOException,
                                              org.json.JSONException

Method used to find task by using the process instance ID

Parameters:

processInstanceId - used to identify task through a process instance

Returns:

String Array containing status and the taskID

Throws:

IOException

org.json.JSONException

claimTaskByTaskId

public String claimTaskByTaskId(String taskID)
                         throws IOException

Method to claim task by a user

Parameters:

taskID - used to identify the task to be claimed

Returns:

String Array containing status

Throws:

IOException

delegateTaskByTaskId

public String delegateTaskByTaskId(String taskID)
                            throws IOException

Mehtod to delegate a task to certain user

Parameters:

taskID - used to identify the task to be delegated

Returns:

String with the status of the delegation

Throws:

IOException

addNewCommentOnTaskByTaskId

public String[] addNewCommentOnTaskByTaskId(String taskID,
                                   String comment)
                                     throws RestClientException,
                                            IOException,
                                            org.json.JSONException

Method used to add a new comment to a task

Parameters:

taskID - used to identify the task

comment - comment to be added

Returns:

String Array containing status and the message

Throws:

IOException

org.json.JSONException

RestClientException

deleteTaskByTaskId

public String deleteTaskByTaskId(String taskId,
                        boolean cascadeHistory,
                        String deleteReason)
                          throws IOException

Method to delete a task

Parameters:

taskId - used to identify a task

cascadeHistory - boolean to either delete the task history or not

deleteReason - reason for deleteing the task

Returns:

String containing the status of the request

Throws:

IOException