Package org.camunda.bpm.engine
package org.camunda.bpm.engine
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 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.-
ClassDescriptionClass contains constants that identifies the activity types, which are used by Camunda.Create and destroy artifacts of a given class in a container specific way.Exception thrown by the process engine in case a user tries to interact with a resource in an unauthorized way.The authorization service allows managing
Authorizations.Exception resulting from a bad user request.Exception during the parsing of an BPMN model.Service which provides access tocase instancesandcase executions.Runtime exception indicating the requested class was not found or an error occurred while loading the class.Exception that is thrown when an optimistic locking error occurs in CockroachDB, caused by concurrent access to the same data entries by multiple transactions.Service to evaluate decisions inside the DMN engine.Service that provides access toExternalTaskinstances.Access to form data and rendered forms for starting new process instances and completing tasks.Service exposing information about ongoing and past process instances.Service for admin and maintenance operations on the process engine.Exception that is thrown when an optimistic locking occurs in the datastore caused by concurrent access of the same data entry.Interface of a problem occurred during parsingProvides access to all the services that expose the BPM and workflow operations.Configuration information from which a process engine can be build.Runtime exception that is the superclass of all exceptions in the process engine.Represents information about the initialization of the process engine.Exception thrown by the persistence layer of the process engine in the occurrence of a problematic interaction with the datasource.Helper for initializing and closing process engines in server environments.Base interface providing access to the process engine's public API services.Service providing access to the repository of process definitions and deployments.This a report created during a parsing.Exception resulting from a error during a script compilation.Base exception resulting from a script engine interaction.Exception resulting from a error during a script evaluation.This exception is thrown, if an operation that requires a non-suspended entity (execution, task, process definition) is executed on a suspended one.This exception is thrown when you try to claim a task that is already claimed by someone else.Service which provides access toTaskand form related operations.Exception that is thrown when the Activiti engine discovers a mismatch between the database schema version and the engine version.