Package org.camunda.bpm.engine

Interface ProcessEngine

All Superinterfaces:

ProcessEngineServices

All Known Implementing Classes:

ProcessEngineImpl

public interface ProcessEngine
extends ProcessEngineServices

Provides access to all the services that expose the BPM and workflow operations.

• RuntimeService: Allows the creation of Deployments and the starting of and searching on 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
• HistoryService: Service exposing information about ongoing and past process instances.
• AuthorizationService: Service allowing to manage access permissions for users and groups.

Typically, there will be only one central ProcessEngine instance needed in a end-user application. Building a ProcessEngine is done through a ProcessEngineConfiguration instance and is a costly operation which should be avoided. For that purpose, it is advised to store it in a static field or JNDI location (or something similar). This is a thread-safe object, so no special precautions need to be taken.

Author:

Tom Baeyens, Joram Barrez, Daniel Meyer

Field Summary

Fields

Modifier and Type	Field	Description
static final String	VERSION	the version of the process engine library

Method Summary

Modifier and Type	Method	Description
void	close()
String	getName()	The name as specified in 'process-engine-name' in the camunda.cfg.xml configuration file.
ProcessEngineConfiguration	getProcessEngineConfiguration()

Methods inherited from interface org.camunda.bpm.engine.ProcessEngineServices

getAuthorizationService, getCaseService, getDecisionService, getExternalTaskService, getFilterService, getFormService, getHistoryService, getIdentityService, getManagementService, getRepositoryService, getRuntimeService, getTaskService

Field Details

VERSION

static final String VERSION

the version of the process engine library

See Also:

• Constant Field Values

Method Details

getName

String getName()

The name as specified in 'process-engine-name' in the camunda.cfg.xml configuration file. The default name for a process engine is 'default

close

void close()

getProcessEngineConfiguration

ProcessEngineConfiguration getProcessEngineConfiguration()