Package org.camunda.automator.bpmnengine.camunda8

Class BpmnEngineCamunda8

java.lang.Object

org.camunda.automator.bpmnengine.camunda8.BpmnEngineCamunda8

All Implemented Interfaces:

BpmnEngine

public class BpmnEngineCamunda8
extends Object
implements BpmnEngine

Nested Class Summary

Nested classes/interfaces inherited from interface org.camunda.automator.bpmnengine.BpmnEngine

BpmnEngine.ProcessDescription, BpmnEngine.RegisteredTask, BpmnEngine.TaskDescription

Field Summary

Fields

Modifier and Type	Field	Description
static final int	SEARCH_MAX_SIZE
static final String	THIS_IS_A_COMPLETE_IMPOSSIBLE_VARIABLE_NAME

Constructor Summary

Constructors

Constructor	Description
BpmnEngineCamunda8(String zeebeSelfGatewayAddress, String zeebeSelfSecurityPlainText, String zeebeSaasCloudRegister, String zeebeSaasCloudRegion, String zeebeSaasCloudClusterId, String zeebeSaasCloudClientId, String zeebeSaasClientSecret, String operateUrl, String operateUserName, String operateUserPassword, String tasklistUrl)	Constructor to specify a Self Manage Zeebe Address por a Zeebe Saas
BpmnEngineCamunda8(ConfigurationBpmEngine engineConfiguration, ConfigurationBpmEngine.BpmnServerDefinition serverDefinition)	Constructor from existing object

Method Summary

Modifier and Type	Method	Description
void	connection()
long	countNumberOfProcessInstancesCreated(String processId, io.camunda.operate.search.DateFilter startDate, io.camunda.operate.search.DateFilter endDate)
long	countNumberOfProcessInstancesEnded(String processId, io.camunda.operate.search.DateFilter startDate, io.camunda.operate.search.DateFilter endDate)
long	countNumberOfTasks(String processId, String taskId)
String	createProcessInstance(String processId, String starterEventId, Map<String,Object> variables)
String	createProcessInstanceSimple(String processId, String starterEventId, Map<String,Object> variables)
String	deployBpmn(File processFile, ScenarioDeployment.Policy policy)	Deploy a BPMN file (may contains multiple processes)
void	disconnection()
void	endProcessInstance(String processInstanceId, boolean cleanAll)	we finish with this processinstanceid, engine can clean it
void	executeServiceTask(String serviceTaskId, String workerId, Map<String,Object> variables)	Execute a service task
void	executeUserTask(String userTaskId, String userId, Map<String,Object> variables)
String	getSignature()	return the signature of the engine, to log it for example
ConfigurationBpmEngine.CamundaEngine	getTypeCamundaEngine()
Map<String,Object>	getVariables(String processInstanceId)	Get variables of a process instanceId
int	getWorkerExecutionThreads()
io.camunda.zeebe.client.ZeebeClient	getZeebeClient()
void	init()	init the engine.
boolean	isReady()	Engine is ready.
BpmnEngine.RegisteredTask	registerServiceTask(String workerId, String topic, Duration lockTime, Object jobHandler, FixedBackoffSupplier backoffSupplier)
List<BpmnEngine.ProcessDescription>	searchProcessInstanceByVariable(String processId, Map<String,Object> filterVariables, int maxResult)	Search process instance by a variable content
List<String>	searchServiceTasks(String processInstanceId, String serviceTaskId, String topic, int maxResult)
List<BpmnEngine.TaskDescription>	searchTasksByProcessInstanceId(String processInstanceId, String taskId, int maxResult)	Search task.
List<String>	searchUserTasks(String userTaskId, int maxResult)	Return a list of task
List<String>	searchUserTasksByProcessInstance(String processInstanceId, String userTaskId, int maxResult)
void	turnHighFlowMode(boolean hightFlowMode)	HighFlowMode: when true, the class does not save anything, to reduce the footprint

Methods inherited from class java.lang.Object

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

Field Details

THIS_IS_A_COMPLETE_IMPOSSIBLE_VARIABLE_NAME

public static final String THIS_IS_A_COMPLETE_IMPOSSIBLE_VARIABLE_NAME

See Also:

• Constant Field Values

SEARCH_MAX_SIZE

public static final int SEARCH_MAX_SIZE

See Also:

• Constant Field Values

Constructor Details

BpmnEngineCamunda8

public BpmnEngineCamunda8(ConfigurationBpmEngine engineConfiguration,
 ConfigurationBpmEngine.BpmnServerDefinition serverDefinition)

Constructor from existing object

Parameters:

engineConfiguration - configuration for this engine

serverDefinition - server definition

BpmnEngineCamunda8

public BpmnEngineCamunda8(String zeebeSelfGatewayAddress,
 String zeebeSelfSecurityPlainText,
 String zeebeSaasCloudRegister,
 String zeebeSaasCloudRegion,
 String zeebeSaasCloudClusterId,
 String zeebeSaasCloudClientId,
 String zeebeSaasClientSecret,
 String operateUrl,
 String operateUserName,
 String operateUserPassword,
 String tasklistUrl)

Constructor to specify a Self Manage Zeebe Address por a Zeebe Saas

Parameters:

zeebeSelfGatewayAddress - Self Manage : zeebe address

zeebeSelfSecurityPlainText - Self Manage: Plain text

zeebeSaasCloudRegister - Saas Cloud Register information

zeebeSaasCloudRegion - Saas Cloud region

zeebeSaasCloudClusterId - Saas Cloud ClusterID

zeebeSaasCloudClientId - Saas Cloud ClientID

zeebeSaasClientSecret - Saas Cloud Client Secret

operateUrl - URL to access Operate

operateUserName - Operate user name

operateUserPassword - Operate password

tasklistUrl - Url to access TaskList

Method Details

init

public void init()

Description copied from interface: BpmnEngine

init the engine. This method will

Specified by:

init in interface BpmnEngine

connection

public void connection()
                throws AutomatorException

Specified by:

connection in interface BpmnEngine

Throws:

AutomatorException

disconnection

public void disconnection()
                   throws AutomatorException

Specified by:

disconnection in interface BpmnEngine

Throws:

AutomatorException

isReady

public boolean isReady()

Engine is ready. If not, a connection() method must be call

Specified by:

isReady in interface BpmnEngine

Returns:

turnHighFlowMode

public void turnHighFlowMode(boolean hightFlowMode)

HighFlowMode: when true, the class does not save anything, to reduce the footprint

Specified by:

turnHighFlowMode in interface BpmnEngine

Parameters:

hightFlowMode - true or false

createProcessInstance

public String createProcessInstance(String processId,
 String starterEventId,
 Map<String,Object> variables)
                             throws AutomatorException

Specified by:

createProcessInstance in interface BpmnEngine

Parameters:

processId - Process ID (BPMN ID : ExpenseNode)

starterEventId - BPMN ID (startEvent)

variables - List of variables to create the process instance

Returns:

a processInstanceId

Throws:

AutomatorException - in case of error

createProcessInstanceSimple

public String createProcessInstanceSimple(String processId,
 String starterEventId,
 Map<String,Object> variables)
                                   throws AutomatorException

Throws:

AutomatorException

endProcessInstance

public void endProcessInstance(String processInstanceId,
 boolean cleanAll)
                        throws AutomatorException

Description copied from interface: BpmnEngine

we finish with this processinstanceid, engine can clean it

Specified by:

endProcessInstance in interface BpmnEngine

Parameters:

processInstanceId - Process instance Id to clean

cleanAll - if true, the process instance must be clean.

Throws:

AutomatorException - in case of error

searchUserTasksByProcessInstance

public List<String> searchUserTasksByProcessInstance(String processInstanceId,
 String userTaskId,
 int maxResult)
                                              throws AutomatorException

Specified by:

searchUserTasksByProcessInstance in interface BpmnEngine

Parameters:

processInstanceId - Process Instance Id

userTaskId - BPMN Id (Review)

maxResult - maximum result to return.

Returns:

list of taskId

Throws:

AutomatorException - in case of error

searchUserTasks

public List<String> searchUserTasks(String userTaskId,
 int maxResult)
                             throws AutomatorException

Description copied from interface: BpmnEngine

Return a list of task

Specified by:

searchUserTasks in interface BpmnEngine

Parameters:

userTaskId - userTaskId

maxResult - maxResult returned

Returns:

list of TaskId

Throws:

AutomatorException

registerServiceTask

public BpmnEngine.RegisteredTask registerServiceTask(String workerId,
 String topic,
 Duration lockTime,
 Object jobHandler,
 FixedBackoffSupplier backoffSupplier)

Specified by:

registerServiceTask in interface BpmnEngine

Parameters:

workerId - workerId

topic - topic to register

lockTime - lock time for the job

jobHandler - C7: must implement ExternalTaskHandler. C8: must implement JobHandler

backoffSupplier - backOffStrategy

Returns:

executeUserTask

public void executeUserTask(String userTaskId,
 String userId,
 Map<String,Object> variables)
                     throws AutomatorException

Specified by:

executeUserTask in interface BpmnEngine

Parameters:

userTaskId - BPMN Id (Review)

userId - User id who executes the task

variables - variable to update

Throws:

AutomatorException - in case of error

searchServiceTasks

public List<String> searchServiceTasks(String processInstanceId,
 String serviceTaskId,
 String topic,
 int maxResult)
                                throws AutomatorException

Specified by:

searchServiceTasks in interface BpmnEngine

Parameters:

processInstanceId - process instance ID

serviceTaskId - BPMN IP (Review)

topic - topic to search to execute the service task

maxResult - maximum result

Returns:

list of taskId

Throws:

AutomatorException - in case of error

executeServiceTask

public void executeServiceTask(String serviceTaskId,
 String workerId,
 Map<String,Object> variables)
                        throws AutomatorException

Description copied from interface: BpmnEngine

Execute a service task

Specified by:

executeServiceTask in interface BpmnEngine

Parameters:

serviceTaskId - BPMN ID (Review)

workerId - Worker who execute the task

variables - variable to updates

Throws:

AutomatorException - in case of error

searchTasksByProcessInstanceId

public List<BpmnEngine.TaskDescription> searchTasksByProcessInstanceId(String processInstanceId,
 String taskId,
 int maxResult)
                                                                throws AutomatorException

Description copied from interface: BpmnEngine

Search task.

Specified by:

searchTasksByProcessInstanceId in interface BpmnEngine

Parameters:

processInstanceId - filter on the processInstanceId. may be null

taskId - filter on the taskId

maxResult - maximum Result

Returns:

List of task description

Throws:

AutomatorException - in case of error

searchProcessInstanceByVariable

public List<BpmnEngine.ProcessDescription> searchProcessInstanceByVariable(String processId,
 Map<String,Object> filterVariables,
 int maxResult)
                                                                    throws AutomatorException

Description copied from interface: BpmnEngine

Search process instance by a variable content

Specified by:

searchProcessInstanceByVariable in interface BpmnEngine

Parameters:

processId - BPMN Process ID

filterVariables - Variable name

maxResult - maxResult

Returns:

list of ProcessInstance which match the filter

Throws:

AutomatorException - in case of error

getVariables

public Map<String,Object> getVariables(String processInstanceId)
                                throws AutomatorException

Description copied from interface: BpmnEngine

Get variables of a process instanceId

Specified by:

getVariables in interface BpmnEngine

Parameters:

processInstanceId - the process instance ID

Returns:

variables attached to the process instance ID

Throws:

AutomatorException - in case of error

countNumberOfProcessInstancesCreated

public long countNumberOfProcessInstancesCreated(String processId,
 io.camunda.operate.search.DateFilter startDate,
 io.camunda.operate.search.DateFilter endDate)
                                          throws AutomatorException

Specified by:

countNumberOfProcessInstancesCreated in interface BpmnEngine

Throws:

AutomatorException

countNumberOfProcessInstancesEnded

public long countNumberOfProcessInstancesEnded(String processId,
 io.camunda.operate.search.DateFilter startDate,
 io.camunda.operate.search.DateFilter endDate)
                                        throws AutomatorException

Specified by:

countNumberOfProcessInstancesEnded in interface BpmnEngine

Throws:

AutomatorException

countNumberOfTasks

public long countNumberOfTasks(String processId,
 String taskId)
                        throws AutomatorException

Specified by:

countNumberOfTasks in interface BpmnEngine

Throws:

AutomatorException

deployBpmn

public String deployBpmn(File processFile,
 ScenarioDeployment.Policy policy)
                  throws AutomatorException

Description copied from interface: BpmnEngine

Deploy a BPMN file (may contains multiple processes)

Specified by:

deployBpmn in interface BpmnEngine

Parameters:

processFile - process to deploy

policy - policy to deploy the process

Returns:

the deploymentId

Throws:

AutomatorException - in case of error

getTypeCamundaEngine

public ConfigurationBpmEngine.CamundaEngine getTypeCamundaEngine()

Specified by:

getTypeCamundaEngine in interface BpmnEngine

getSignature

public String getSignature()

Description copied from interface: BpmnEngine

return the signature of the engine, to log it for example

Specified by:

getSignature in interface BpmnEngine

Returns:

signature of the engine

getWorkerExecutionThreads

public int getWorkerExecutionThreads()

Specified by:

getWorkerExecutionThreads in interface BpmnEngine

getZeebeClient

public io.camunda.zeebe.client.ZeebeClient getZeebeClient()