Uses of Interface
org.camunda.bpm.engine.runtime.MessageCorrelationBuilder
Package
Description
Public API of the Camunda Platform engine.
Typical usage of the API starts by the creation of a
Through the services obtained from such a
Typical usage of the API starts by the creation of a
ProcessEngineConfiguration
(typically based on a configuration file), from which a ProcessEngine
can be obtained.Through the services obtained from such a
ProcessEngine
, BPM and workflow operation
can be executed:RepositoryService
:
Manages Deployment
sRuntimeService
:
For starting and searching ProcessInstance
sTaskService
:
Exposes operations to manage human (standalone) Task
s,
such as claiming, completing and assigning tasksIdentityService
:
Used for managing User
s,
Group
s and the relations between themManagementService
:
Exposes engine admin and maintenance operations,
which have no relation to the runtime execution of business processesHistoryService
:
Exposes information about ongoing and past process instances.FormService
:
Access to form data and rendered forms for starting new process instances and completing tasks.API implementation classes, which shouldn't directly be used by end-users.
Classes related to the
RuntimeService
.-
Uses of MessageCorrelationBuilder in org.camunda.bpm.engine
Modifier and TypeMethodDescriptionRuntimeService.createMessageCorrelation
(String messageName) Define a complex message correlation using a fluent builder. -
Uses of MessageCorrelationBuilder in org.camunda.bpm.engine.impl
Modifier and TypeMethodDescriptionRuntimeServiceImpl.createMessageCorrelation
(String messageName) MessageCorrelationBuilderImpl.executionsOnly()
MessageCorrelationBuilderImpl.localVariableEquals
(String variableName, Object variableValue) MessageCorrelationBuilderImpl.localVariablesEqual
(Map<String, Object> variables) MessageCorrelationBuilderImpl.processDefinitionId
(String processDefinitionId) MessageCorrelationBuilderImpl.processInstanceBusinessKey
(String businessKey) MessageCorrelationBuilderImpl.processInstanceId
(String id) MessageCorrelationBuilderImpl.processInstanceVariableEquals
(String variableName, Object variableValue) MessageCorrelationBuilderImpl.processInstanceVariablesEqual
(Map<String, Object> variables) MessageCorrelationBuilderImpl.setVariable
(String variableName, Object variableValue) MessageCorrelationBuilderImpl.setVariableLocal
(String variableName, Object variableValue) MessageCorrelationBuilderImpl.setVariables
(Map<String, Object> variables) MessageCorrelationBuilderImpl.setVariablesLocal
(Map<String, Object> variables) MessageCorrelationBuilderImpl.setVariablesToTriggeredScope
(Map<String, Object> variables) MessageCorrelationBuilderImpl.setVariableToTriggeredScope
(String variableName, Object variableValue) MessageCorrelationBuilderImpl.startMessageOnly()
MessageCorrelationBuilderImpl.withoutTenantId()
-
Uses of MessageCorrelationBuilder in org.camunda.bpm.engine.impl.batch.message
Modifier and TypeMethodDescriptionprotected void
MessageCorrelationBatchJobHandler.setVariables
(String batchId, MessageCorrelationBuilder correlationBuilder, CommandContext commandContext) -
Uses of MessageCorrelationBuilder in org.camunda.bpm.engine.rest.impl
Modifier and TypeMethodDescriptionprotected MessageCorrelationBuilder
MessageRestServiceImpl.createMessageCorrelationBuilder
(CorrelationMessageDto messageDto) Modifier and TypeMethodDescriptionprotected List<MessageCorrelationResultDto>
MessageRestServiceImpl.correlate
(CorrelationMessageDto messageDto, MessageCorrelationBuilder correlation) protected List<MessageCorrelationResultWithVariableDto>
MessageRestServiceImpl.correlateWithVariablesEnabled
(CorrelationMessageDto messageDto, MessageCorrelationBuilder correlation) -
Uses of MessageCorrelationBuilder in org.camunda.bpm.engine.runtime
Modifier and TypeMethodDescriptionMessageCorrelationBuilder.localVariableEquals
(String variableName, Object variableValue) Correlate the message such that the execution has a local variable with the given name and value.MessageCorrelationBuilder.localVariablesEqual
(Map<String, Object> variables) Correlate the message such that the execution has the given variables as local variables.MessageCorrelationBuilder.processDefinitionId
(String processDefinitionId) Correlate the message such that a process definition with the given id is selected.MessageCorrelationBuilder.processInstanceBusinessKey
(String businessKey) Correlate the message such that the process instance has a business key with the given name.MessageCorrelationBuilder.processInstanceId
(String id) Correlate the message such that a process instance with the given id is selected.MessageCorrelationBuilder.processInstanceVariableEquals
(String variableName, Object variableValue) Correlate the message such that the process instance has a variable with the given name and value.MessageCorrelationBuilder.processInstanceVariablesEqual
(Map<String, Object> variables) Correlate the message such that the process instance has the given variables.MessageCorrelationBuilder.setVariable
(String variableName, Object variableValue) Pass a variable to the execution waiting on the message.MessageCorrelationBuilder.setVariableLocal
(String variableName, Object variableValue) Pass a local variable to the execution waiting on the message.MessageCorrelationBuilder.setVariables
(Map<String, Object> variables) Pass a map of variables to the execution waiting on the message.MessageCorrelationBuilder.setVariablesLocal
(Map<String, Object> variables) Pass a map of local variables to the execution waiting on the message.MessageCorrelationBuilder.setVariablesToTriggeredScope
(Map<String, Object> variables) Pass a map of variables to the new scope triggered by message correlation.MessageCorrelationBuilder.setVariableToTriggeredScope
(String variableName, Object variableValue) Pass a variable to the new scope triggered by message correlation.MessageCorrelationBuilder.startMessageOnly()
Specify that only start message can be correlated.Specify a tenant to deliver the message to.MessageCorrelationBuilder.withoutTenantId()
Specify that the message can only be received on executions or process definitions which belongs to no tenant. -
Uses of MessageCorrelationBuilder in org.camunda.bpm.qa.upgrade