eu.vicci.process.client.rest

Class ProteusRestClient

java.lang.Object

eu.vicci.process.client.rest.ProteusRestClient

public class ProteusRestClient
extends Object

Implementation of a REST Client which can access the PROtEUS REST API. This backs a Feign Rest Client

Author:

andre

Constructor Summary

Constructors

Constructor and Description
ProteusRestClient()
ProteusRestClient(String host, String port)

Method Summary

Modifier and Type	Method and Description
String	deployProcessInstance(String processId) Deploy a process instance
eu.vicci.process.model.sofiainstance.ProcessInstance	getProcessStepInstance(String processInstanceId) Get the process step instance.
eu.vicci.process.model.util.messages.core.IStateChangeMessage	getRecentState(String processInstanceId) Gets the most recent state change message for the given process.
List<? extends eu.vicci.process.engine.core.IProcessInfo>	listDeployedProcesses() Lists all deployed processes, which can be executed.
List<? extends eu.vicci.process.engine.core.IProcessInstanceInfo>	listDeployedProcessInstances() listing deployed process instances
void	startProcessInstance(String processInstanceId)
void	startProcessInstance(String processInstanceId, Map<String,eu.vicci.process.model.sofiainstance.DataTypeInstance> inputParameters)
String	uploadAndDeploy(String processDocument) Same as uploadAndDeploy(String, boolean) with args (processDocument, true).
String	uploadAndDeploy(String processDocument, boolean overrideExisting)

Methods inherited from class java.lang.Object

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

Constructor Detail

ProteusRestClient

public ProteusRestClient()

ProteusRestClient

public ProteusRestClient(String host,
                         String port)

Method Detail

listDeployedProcesses

public List<? extends eu.vicci.process.engine.core.IProcessInfo> listDeployedProcesses()

Lists all deployed processes, which can be executed.

listDeployedProcessInstances

public List<? extends eu.vicci.process.engine.core.IProcessInstanceInfo> listDeployedProcessInstances()

listing deployed process instances

uploadAndDeploy

public String uploadAndDeploy(String processDocument,
                              boolean overrideExisting)

Parameters:

processDocument - the process as string

overrideExisting - override the existing model file

Returns:

process id or null if failed

uploadAndDeploy

public String uploadAndDeploy(String processDocument)

Same as uploadAndDeploy(String, boolean) with args (processDocument, true).

Parameters:

processDocument - the process as string

Returns:

process id or null if failed

deployProcessInstance

public String deployProcessInstance(String processId)

Deploy a process instance

Parameters:

processId - the process id for the process which should be deployed as instance.

Returns:

instance id or null if failed

startProcessInstance

public void startProcessInstance(String processInstanceId)

Parameters:

processInstanceId - the instance id of the process which should be started

startProcessInstance

public void startProcessInstance(String processInstanceId,
                                 Map<String,eu.vicci.process.model.sofiainstance.DataTypeInstance> inputParameters)

Parameters:

processInstanceId - the instance id of the process which should be started

inputParameters - the input parameters as map, with the id of the datatype as key (not instance id!)

getProcessStepInstance

public eu.vicci.process.model.sofiainstance.ProcessInstance getProcessStepInstance(String processInstanceId)

Get the process step instance.

Parameters:

processInstanceId - The instance id of the root process.

Returns:

ProcessStepInstance

getRecentState

public eu.vicci.process.model.util.messages.core.IStateChangeMessage getRecentState(String processInstanceId)

Gets the most recent state change message for the given process.

Parameters:

processInstanceId -

Returns:

IStateChangeMessage