Package org.camunda.bpm.engine

Public API of the Camunda Platform 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 Deployments
RuntimeService: For starting and searching ProcessInstances
TaskService: Exposes operations to manage human (standalone) Tasks, such as claiming, completing and assigning tasks
IdentityService: Used for managing Users, Groups 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.

Interface Summary

Interface	Description
ArtifactFactory	Create and destroy artifacts of a given class in a container specific way.
AuthorizationService	The authorization service allows managing Authorizations.
CaseService	Service which provides access to case instances and case executions.
DecisionService	Service to evaluate decisions inside the DMN engine.
ExternalTaskService	Service that provides access to ExternalTask instances.
FilterService
FormService	Access to form data and rendered forms for starting new process instances and completing tasks.
HistoryService	Service exposing information about ongoing and past process instances.
IdentityService	Service to manage Users and Groups.
ManagementService	Service for admin and maintenance operations on the process engine.
Problem	Interface of a problem occurred during parsing
ProcessEngine	Provides access to all the services that expose the BPM and workflow operations.
ProcessEngineBootstrapCommand
ProcessEngineInfo	Represents information about the initialization of the process engine.
ProcessEngineServices	Base interface providing access to the process engine's public API services.
RepositoryService	Service providing access to the repository of process definitions and deployments.
ResourceReport	This a report created during a parsing.
RuntimeService	Service which provides access to Deployments, ProcessDefinitions and ProcessInstances.
SchemaOperationsCommand
TaskService	Service which provides access to Task and form related operations.

Class Summary

Class	Description
ActivityTypes	Class contains constants that identifies the activity types, which are used by Camunda.
EntityTypes
ProcessEngineConfiguration	Configuration information from which a process engine can be build.
ProcessEngines	Helper for initializing and closing process engines in server environments.

Exception Summary

Exception	Description
AuthenticationException
AuthorizationException	Exception thrown by the process engine in case a user tries to interact with a resource in an unauthorized way.
BadUserRequestException	Exception resulting from a bad user request.
BpmnParseException	Exception during the parsing of an BPMN model.
ClassLoadingException	Runtime exception indicating the requested class was not found or an error occurred while loading the class.
CrdbTransactionRetryException	Exception that is thrown when an optimistic locking error occurs in CockroachDB, caused by concurrent access to the same data entries by multiple transactions.
MismatchingMessageCorrelationException
OptimisticLockingException	Exception that is thrown when an optimistic locking occurs in the datastore caused by concurrent access of the same data entry.
ParseException
ProcessEngineException	Runtime exception that is the superclass of all exceptions in the process engine.
ScriptCompilationException	Exception resulting from a error during a script compilation.
ScriptEngineException	Base exception resulting from a script engine interaction.
ScriptEvaluationException	Exception resulting from a error during a script evaluation.
SuspendedEntityInteractionException	This exception is thrown, if an operation that requires a non-suspended entity (execution, task, process definition) is executed on a suspended one.
TaskAlreadyClaimedException	This exception is thrown when you try to claim a task that is already claimed by someone else.
WrongDbException	Exception that is thrown when the Activiti engine discovers a mismatch between the database schema version and the engine version.