Package org.activiti.engine

Interface ProcessEngine

All Known Implementing Classes:

ProcessEngineImpl

@Internal
public interface ProcessEngine

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
• ManagementService: Exposes engine admin and maintenance operations
• HistoryService: Service exposing information about ongoing and past process instances.

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.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
void	close()
DynamicBpmnService	getDynamicBpmnService()
HistoryService	getHistoryService()
ManagementService	getManagementService()
String	getName()	The name as specified in 'process-engine-name' in the activiti.cfg.xml configuration file.
ProcessEngineConfiguration	getProcessEngineConfiguration()
RepositoryService	getRepositoryService()
RuntimeService	getRuntimeService()
TaskService	getTaskService()

Field Details

VERSION

static final String VERSION

the version of the activiti library

See Also:

• Constant Field Values

Method Details

getName

String getName()

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

close

void close()

getRepositoryService

RepositoryService getRepositoryService()

getRuntimeService

RuntimeService getRuntimeService()

getTaskService

TaskService getTaskService()

getHistoryService

HistoryService getHistoryService()

getManagementService

ManagementService getManagementService()

getDynamicBpmnService

DynamicBpmnService getDynamicBpmnService()

getProcessEngineConfiguration

ProcessEngineConfiguration getProcessEngineConfiguration()