| Package | Description |
|---|---|
| org.camunda.bpm.engine |
Public API of the camunda BPM engine.
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 DeploymentsRuntimeService:
For starting and searching ProcessInstancesTaskService:
Exposes operations to manage human (standalone) Tasks,
such as claiming, completing and assigning tasksIdentityService:
Used for managing Users,
Groups 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. |
| org.camunda.bpm.engine.impl |
API implementation classes, which shouldn't directly be used by end-users.
|
| org.camunda.bpm.engine.runtime |
Classes related to the
RuntimeService. |
| Modifier and Type | Method and Description |
|---|---|
MessageCorrelationBuilder |
RuntimeService.createMessageCorrelation(String messageName)
Define a complex message correlation using a fluent builder.
|
| Modifier and Type | Class and Description |
|---|---|
class |
MessageCorrelationBuilderImpl |
| Modifier and Type | Method and 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.
|
Copyright © 2013–2019 camunda services GmbH. All rights reserved.