Uses of Interface
org.camunda.bpm.engine.runtime.MessageCorrelationBuilder
-
Packages that use MessageCorrelationBuilder Package Description org.camunda.bpm.engine Public API of the Camunda Platform engine.
Typical usage of the API starts by the creation of aProcessEngineConfiguration
(typically based on a configuration file), from which aProcessEngine
can be obtained.
Through the services obtained from such aProcessEngine
, BPM and workflow operation can be executed:
RepositoryService
: ManagesDeployment
s
RuntimeService
: For starting and searchingProcessInstance
s
TaskService
: Exposes operations to manage human (standalone)Task
s, such as claiming, completing and assigning tasks
IdentityService
: Used for managingUser
s,Group
s and the relations between them
ManagementService
: Exposes engine admin and maintenance operations, which have no relation to the runtime execution of business processes
HistoryService
: Exposes information about ongoing and past process instances.
FormService
: Access to form data and rendered forms for starting new process instances and completing tasks.org.camunda.bpm.engine.impl API implementation classes, which shouldn't directly be used by end-users.org.camunda.bpm.engine.impl.batch.message org.camunda.bpm.engine.rest.impl org.camunda.bpm.engine.runtime Classes related to theRuntimeService
.org.camunda.bpm.qa.upgrade -
-
Uses of MessageCorrelationBuilder in org.camunda.bpm.engine
Methods in org.camunda.bpm.engine that return MessageCorrelationBuilder Modifier and Type Method Description MessageCorrelationBuilder
RuntimeService. createMessageCorrelation(String messageName)
Define a complex message correlation using a fluent builder. -
Uses of MessageCorrelationBuilder in org.camunda.bpm.engine.impl
Classes in org.camunda.bpm.engine.impl that implement MessageCorrelationBuilder Modifier and Type Class Description class
MessageCorrelationBuilderImpl
-
Uses of MessageCorrelationBuilder in org.camunda.bpm.engine.impl.batch.message
Methods in org.camunda.bpm.engine.impl.batch.message with parameters of type MessageCorrelationBuilder Modifier and Type Method Description protected void
MessageCorrelationBatchJobHandler. setVariables(String batchId, MessageCorrelationBuilder correlationBuilder, CommandContext commandContext)
-
Uses of MessageCorrelationBuilder in org.camunda.bpm.engine.rest.impl
Methods in org.camunda.bpm.engine.rest.impl that return MessageCorrelationBuilder Modifier and Type Method Description protected MessageCorrelationBuilder
MessageRestServiceImpl. createMessageCorrelationBuilder(CorrelationMessageDto messageDto)
Methods in org.camunda.bpm.engine.rest.impl with parameters of type MessageCorrelationBuilder Modifier and Type Method Description protected 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
Methods in org.camunda.bpm.engine.runtime that return MessageCorrelationBuilder Modifier and Type Method Description MessageCorrelationBuilder
MessageCorrelationBuilder. localVariableEquals(String variableName, Object variableValue)
Correlate the message such that the execution has a local variable with the given name and value.MessageCorrelationBuilder
MessageCorrelationBuilder. localVariablesEqual(Map<String,Object> variables)
Correlate the message such that the execution has the given variables as local variables.MessageCorrelationBuilder
MessageCorrelationBuilder. processDefinitionId(String processDefinitionId)
Correlate the message such that a process definition with the given id is selected.MessageCorrelationBuilder
MessageCorrelationBuilder. processInstanceBusinessKey(String businessKey)
Correlate the message such that the process instance has a business key with the given name.MessageCorrelationBuilder
MessageCorrelationBuilder. processInstanceId(String id)
Correlate the message such that a process instance with the given id is selected.MessageCorrelationBuilder
MessageCorrelationBuilder. processInstanceVariableEquals(String variableName, Object variableValue)
Correlate the message such that the process instance has a variable with the given name and value.MessageCorrelationBuilder
MessageCorrelationBuilder. processInstanceVariablesEqual(Map<String,Object> variables)
Correlate the message such that the process instance has the given variables.MessageCorrelationBuilder
MessageCorrelationBuilder. setVariable(String variableName, Object variableValue)
Pass a variable to the execution waiting on the message.MessageCorrelationBuilder
MessageCorrelationBuilder. setVariableLocal(String variableName, Object variableValue)
Pass a local variable to the execution waiting on the message.MessageCorrelationBuilder
MessageCorrelationBuilder. setVariables(Map<String,Object> variables)
Pass a map of variables to the execution waiting on the message.MessageCorrelationBuilder
MessageCorrelationBuilder. setVariablesLocal(Map<String,Object> variables)
Pass a map of local variables to the execution waiting on the message.MessageCorrelationBuilder
MessageCorrelationBuilder. startMessageOnly()
Specify that only start message can be correlated.MessageCorrelationBuilder
MessageCorrelationBuilder. tenantId(String tenantId)
Specify a tenant to deliver the message to.MessageCorrelationBuilder
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
Methods in org.camunda.bpm.qa.upgrade that return MessageCorrelationBuilder Modifier and Type Method Description MessageCorrelationBuilder
UpgradeTestRule. messageCorrelation(String messageName)
-