org.camunda.bpm.engine.package.html Maven / Gradle / Ivy
Public API of the Camunda Platform engine.
Typical usage of the API starts by the creation of a {@link org.camunda.bpm.engine.ProcessEngineConfiguration}
(typically based on a configuration file), from which a {@link org.camunda.bpm.engine.ProcessEngine} can be obtained.
Through the services obtained from such a {@link org.camunda.bpm.engine.ProcessEngine}, BPM and workflow operation
can be executed:
{@link org.camunda.bpm.engine.RepositoryService}:
Manages {@link org.camunda.bpm.engine.repository.Deployment}s
{@link org.camunda.bpm.engine.RuntimeService}:
For starting and searching {@link org.camunda.bpm.engine.runtime.ProcessInstance}s
{@link org.camunda.bpm.engine.TaskService}:
Exposes operations to manage human (standalone) {@link org.camunda.bpm.engine.task.Task}s,
such as claiming, completing and assigning tasks
{@link org.camunda.bpm.engine.IdentityService}:
Used for managing {@link org.camunda.bpm.engine.identity.User}s,
{@link org.camunda.bpm.engine.identity.Group}s and the relations between them
{@link org.camunda.bpm.engine.ManagementService}:
Exposes engine admin and maintenance operations,
which have no relation to the runtime execution of business processes
{@link org.camunda.bpm.engine.HistoryService}:
Exposes information about ongoing and past process instances.
{@link org.camunda.bpm.engine.FormService}:
Access to form data and rendered forms for starting new process instances and completing tasks.