Uses of Interface
org.camunda.bpm.engine.ProcessEngine

Packages that use ProcessEngine

Package	Description
org.camunda.bpm
org.camunda.bpm.application.impl
org.camunda.bpm.container
org.camunda.bpm.container.impl
org.camunda.bpm.container.impl.deployment
org.camunda.bpm.container.impl.deployment.util
org.camunda.bpm.container.impl.jmx.services
org.camunda.bpm.container.impl.tomcat
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.
org.camunda.bpm.engine.delegate	Interfaces used to include Java code in a process as the behavior of an activity or as a listener to process events with JavaDelegates.
org.camunda.bpm.engine.impl	API implementation classes, which shouldn't directly be used by end-users.
org.camunda.bpm.engine.impl.cfg
org.camunda.bpm.engine.impl.cmmn.entity.runtime
org.camunda.bpm.engine.impl.cmmn.execution
org.camunda.bpm.engine.impl.metrics
org.camunda.bpm.engine.impl.migration.instance.parser
org.camunda.bpm.engine.impl.persistence.entity
org.camunda.bpm.engine.impl.plugin
org.camunda.bpm.engine.impl.pvm.runtime
org.camunda.bpm.engine.impl.repository
org.camunda.bpm.engine.impl.test
org.camunda.bpm.engine.impl.util
org.camunda.bpm.engine.impl.variable.listener
org.camunda.bpm.engine.repository	Classes related to the RepositoryService.
org.camunda.bpm.engine.test	Helper classes for testing processes.

Uses of ProcessEngine in org.camunda.bpm

Methods in org.camunda.bpm that return ProcessEngine

Modifier and Type	Method	Description
static ProcessEngine	BpmPlatform.getDefaultProcessEngine()
ProcessEngine	ProcessEngineService.getDefaultProcessEngine()
ProcessEngine	ProcessEngineService.getProcessEngine(String name)

Methods in org.camunda.bpm that return types with arguments of type ProcessEngine

Modifier and Type	Method	Description
List<ProcessEngine>	ProcessEngineService.getProcessEngines()

Uses of ProcessEngine in org.camunda.bpm.application.impl

Methods in org.camunda.bpm.application.impl with parameters of type ProcessEngine

Modifier and Type	Method	Description
void	EjbProcessApplicationReference.processEngineStopping(ProcessEngine processEngine)
void	JakartaEjbProcessApplicationReference.processEngineStopping(ProcessEngine processEngine)
void	ProcessApplicationReferenceImpl.processEngineStopping(ProcessEngine processEngine)

Uses of ProcessEngine in org.camunda.bpm.container

Methods in org.camunda.bpm.container with parameters of type ProcessEngine

Modifier and Type	Method	Description
void	RuntimeContainerDelegate.registerProcessEngine(ProcessEngine processEngine)	Adds a managed ProcessEngine to the runtime container.
void	RuntimeContainerDelegate.unregisterProcessEngine(ProcessEngine processEngine)	Unregisters a managed ProcessEngine instance from the Runtime Container.

Uses of ProcessEngine in org.camunda.bpm.container.impl

Methods in org.camunda.bpm.container.impl that return ProcessEngine

Modifier and Type	Method	Description
ProcessEngine	RuntimeContainerDelegateImpl.getDefaultProcessEngine()
ProcessEngine	RuntimeContainerDelegateImpl.getProcessEngine(String name)

Methods in org.camunda.bpm.container.impl that return types with arguments of type ProcessEngine

Modifier and Type	Method	Description
List<ProcessEngine>	RuntimeContainerDelegateImpl.getProcessEngines()

Methods in org.camunda.bpm.container.impl with parameters of type ProcessEngine

Modifier and Type	Method	Description
void	RuntimeContainerDelegateImpl.registerProcessEngine(ProcessEngine processEngine)
void	RuntimeContainerDelegateImpl.unregisterProcessEngine(ProcessEngine processEngine)

Uses of ProcessEngine in org.camunda.bpm.container.impl.deployment

Methods in org.camunda.bpm.container.impl.deployment that return ProcessEngine

Modifier and Type	Method	Description
protected ProcessEngine	DeployProcessArchiveStep.getProcessEngine(PlatformServiceContainer serviceContainer)
protected ProcessEngine	DeployProcessArchiveStep.getProcessEngine(PlatformServiceContainer serviceContainer, String defaultDeployToProcessEngineName)

Uses of ProcessEngine in org.camunda.bpm.container.impl.deployment.util

Methods in org.camunda.bpm.container.impl.deployment.util that return ProcessEngine

Modifier and Type	Method	Description
static ProcessEngine	InjectionUtil.getDefaultProcessEngine(DeploymentOperation operationContext)

Methods in org.camunda.bpm.container.impl.deployment.util that return types with arguments of type ProcessEngine

Modifier and Type	Method	Description
static List<ProcessEngine>	InjectionUtil.getProcessEngines(DeploymentOperation operationContext)

Uses of ProcessEngine in org.camunda.bpm.container.impl.jmx.services

Fields in org.camunda.bpm.container.impl.jmx.services declared as ProcessEngine

Modifier and Type	Field	Description
protected ProcessEngine	JmxManagedProcessEngine.processEngine

Methods in org.camunda.bpm.container.impl.jmx.services that return ProcessEngine

Modifier and Type	Method	Description
ProcessEngine	JmxManagedProcessEngine.getProcessEngine()
ProcessEngine	JmxManagedProcessEngine.getValue()

Constructors in org.camunda.bpm.container.impl.jmx.services with parameters of type ProcessEngine

Modifier	Constructor	Description
	JmxManagedProcessEngine(ProcessEngine processEngine)

Uses of ProcessEngine in org.camunda.bpm.container.impl.tomcat

Fields in org.camunda.bpm.container.impl.tomcat declared as ProcessEngine

Modifier and Type	Field	Description
protected ProcessEngine	TomcatBpmPlatformBootstrap.processEngine

Uses of ProcessEngine in org.camunda.bpm.engine

Fields in org.camunda.bpm.engine with type parameters of type ProcessEngine

Modifier and Type	Field	Description
protected static Map<String,ProcessEngine>	ProcessEngines.processEngines

Methods in org.camunda.bpm.engine that return ProcessEngine

Modifier and Type	Method	Description
abstract ProcessEngine	ProcessEngineConfiguration.buildProcessEngine()
static ProcessEngine	ProcessEngines.getDefaultProcessEngine()
static ProcessEngine	ProcessEngines.getDefaultProcessEngine(boolean forceCreate)
static ProcessEngine	ProcessEngines.getProcessEngine(String processEngineName)
static ProcessEngine	ProcessEngines.getProcessEngine(String processEngineName, boolean forceCreate)	obtain a process engine by name.

Methods in org.camunda.bpm.engine that return types with arguments of type ProcessEngine

Modifier and Type	Method	Description
static Map<String,ProcessEngine>	ProcessEngines.getProcessEngines()	provides access to process engine to application clients in a managed server environment.

Methods in org.camunda.bpm.engine with parameters of type ProcessEngine

Modifier and Type	Method	Description
static void	ProcessEngines.registerProcessEngine(ProcessEngine processEngine)	Registers the given process engine.
static void	ProcessEngines.unregister(ProcessEngine processEngine)	Unregisters the given process engine.

Uses of ProcessEngine in org.camunda.bpm.engine.delegate

Methods in org.camunda.bpm.engine.delegate that return ProcessEngine

Modifier and Type	Method	Description
ProcessEngine	ProcessEngineServicesAware.getProcessEngine()	Returns the ProcessEngine providing access to the public API of the process engine.

Uses of ProcessEngine in org.camunda.bpm.engine.impl

Classes in org.camunda.bpm.engine.impl that implement ProcessEngine

Modifier and Type	Class	Description
class	ProcessEngineImpl

Uses of ProcessEngine in org.camunda.bpm.engine.impl.cfg

Methods in org.camunda.bpm.engine.impl.cfg that return ProcessEngine

Modifier and Type	Method	Description
ProcessEngine	ProcessEngineConfigurationImpl.buildProcessEngine()

Methods in org.camunda.bpm.engine.impl.cfg with parameters of type ProcessEngine

Modifier and Type	Method	Description
protected void	ProcessEngineConfigurationImpl.invokePostProcessEngineBuild(ProcessEngine engine)
void	AbstractProcessEnginePlugin.postProcessEngineBuild(ProcessEngine processEngine)
void	CompositeProcessEnginePlugin.postProcessEngineBuild(ProcessEngine processEngine)
void	ProcessEnginePlugin.postProcessEngineBuild(ProcessEngine processEngine)	Invoked after the process engine has been built.

Uses of ProcessEngine in org.camunda.bpm.engine.impl.cmmn.entity.runtime

Methods in org.camunda.bpm.engine.impl.cmmn.entity.runtime that return ProcessEngine

Modifier and Type	Method	Description
ProcessEngine	CaseExecutionEntity.getProcessEngine()

Uses of ProcessEngine in org.camunda.bpm.engine.impl.cmmn.execution

Methods in org.camunda.bpm.engine.impl.cmmn.execution that return ProcessEngine

Modifier and Type	Method	Description
ProcessEngine	CaseExecutionImpl.getProcessEngine()

Uses of ProcessEngine in org.camunda.bpm.engine.impl.metrics

Methods in org.camunda.bpm.engine.impl.metrics with parameters of type ProcessEngine

Modifier and Type	Method	Description
String	MetricsReporterIdProvider.provideId(ProcessEngine processEngine)	Deprecated. Provides an id that identifies the metrics reported as part of the given engine's process execution.

Uses of ProcessEngine in org.camunda.bpm.engine.impl.migration.instance.parser

Fields in org.camunda.bpm.engine.impl.migration.instance.parser declared as ProcessEngine

Modifier and Type	Field	Description
protected ProcessEngine	MigratingInstanceParser.engine

Constructors in org.camunda.bpm.engine.impl.migration.instance.parser with parameters of type ProcessEngine

Modifier	Constructor	Description
	MigratingInstanceParser(ProcessEngine engine)

Uses of ProcessEngine in org.camunda.bpm.engine.impl.persistence.entity

Methods in org.camunda.bpm.engine.impl.persistence.entity that return ProcessEngine

Modifier and Type	Method	Description
ProcessEngine	ExecutionEntity.getProcessEngine()
ProcessEngine	TaskEntity.getProcessEngine()

Uses of ProcessEngine in org.camunda.bpm.engine.impl.plugin

Methods in org.camunda.bpm.engine.impl.plugin with parameters of type ProcessEngine

Modifier and Type	Method	Description
void	AdministratorAuthorizationPlugin.postProcessEngineBuild(ProcessEngine processEngine)

Uses of ProcessEngine in org.camunda.bpm.engine.impl.pvm.runtime

Methods in org.camunda.bpm.engine.impl.pvm.runtime that return ProcessEngine

Modifier and Type	Method	Description
ProcessEngine	ExecutionImpl.getProcessEngine()

Uses of ProcessEngine in org.camunda.bpm.engine.impl.repository

Fields in org.camunda.bpm.engine.impl.repository declared as ProcessEngine

Modifier and Type	Field	Description
protected ProcessEngine	DefaultDeploymentHandler.processEngine

Methods in org.camunda.bpm.engine.impl.repository with parameters of type ProcessEngine

Modifier and Type	Method	Description
DeploymentHandler	DefaultDeploymentHandlerFactory.buildDeploymentHandler(ProcessEngine processEngine)

Constructors in org.camunda.bpm.engine.impl.repository with parameters of type ProcessEngine

Modifier	Constructor	Description
	DefaultDeploymentHandler(ProcessEngine processEngine)

Uses of ProcessEngine in org.camunda.bpm.engine.impl.test

Fields in org.camunda.bpm.engine.impl.test declared as ProcessEngine

Modifier and Type	Field	Description
protected static ProcessEngine	PluggableProcessEngineTestCase.cachedProcessEngine	This class isn't used in the Process Engine test suite anymore.
protected ProcessEngine	AbstractProcessEngineTestCase.processEngine

Methods in org.camunda.bpm.engine.impl.test that return ProcessEngine

Modifier and Type	Method	Description
static ProcessEngine	PluggableProcessEngineTestCase.getProcessEngine()
static ProcessEngine	TestHelper.getProcessEngine(String configurationResource)

Methods in org.camunda.bpm.engine.impl.test with parameters of type ProcessEngine

Modifier and Type	Method	Description
static String	TestHelper.annotationDeploymentSetUp(ProcessEngine processEngine, Class<?> testClass, String methodName, Class<?>... parameterTypes)
static String	TestHelper.annotationDeploymentSetUp(ProcessEngine processEngine, Class<?> testClass, String methodName, Deployment deploymentAnnotation, Class<?>... parameterTypes)
static String	TestHelper.annotationDeploymentSetUp(ProcessEngine processEngine, String[] resources, Class<?> testClass, boolean onMethod, String methodName)
static String	TestHelper.annotationDeploymentSetUp(ProcessEngine processEngine, String[] resources, Class<?> testClass, String methodName)
static void	TestHelper.annotationDeploymentTearDown(ProcessEngine processEngine, String deploymentId, Class<?> testClass, String methodName)
static boolean	TestHelper.annotationRequiredDatabaseCheck(ProcessEngine processEngine, Class<?> testClass, String methodName, Class<?>... parameterTypes)
static boolean	TestHelper.annotationRequiredDatabaseCheck(ProcessEngine processEngine, RequiredDatabase annotation, Class<?> testClass, String methodName, Class<?>... parameterTypes)
static boolean	TestHelper.annotationRequiredHistoryLevelCheck(ProcessEngine processEngine, Class<?> testClass, String methodName, Class<?>... parameterTypes)
static boolean	TestHelper.annotationRequiredHistoryLevelCheck(ProcessEngine processEngine, RequiredHistoryLevel annotation, Class<?> testClass, String methodName)
static void	TestHelper.assertAndEnsureCleanDbAndCache(ProcessEngine processEngine)	Ensures that the deployment cache and database is clean after a test.
static String	TestHelper.assertAndEnsureCleanDbAndCache(ProcessEngine processEngine, boolean fail)	Ensures that the deployment cache and database is clean after a test.
static void	TestHelper.assertAndEnsureCleanDeploymentCache(ProcessEngine processEngine)	Ensures that the deployment cache is empty after a test.
static String	TestHelper.assertAndEnsureCleanDeploymentCache(ProcessEngine processEngine, boolean fail)	Ensures that the deployment cache is empty after a test.
static String	TestHelper.assertAndEnsureNoProcessApplicationsRegistered(ProcessEngine processEngine)
static void	ProcessEngineAssert.assertProcessEnded(ProcessEngine processEngine, String processInstanceId)
static void	TestHelper.assertProcessEnded(ProcessEngine processEngine, String processInstanceId)	Deprecated.
static void	TestHelper.deleteDeployment(ProcessEngine processEngine, String deploymentId)

Uses of ProcessEngine in org.camunda.bpm.engine.impl.util

Methods in org.camunda.bpm.engine.impl.util with parameters of type ProcessEngine

Modifier and Type	Method	Description
static String	StringUtil.fromBytes(byte[] bytes, ProcessEngine processEngine)	Converts a byte array into a string using the current process engines default charset as returned by ProcessEngineConfigurationImpl.getDefaultCharset().
static byte[]	StringUtil.toByteArray(String string, ProcessEngine processEngine)	Gets the bytes from a string using the provided process engine's default charset

Uses of ProcessEngine in org.camunda.bpm.engine.impl.variable.listener

Methods in org.camunda.bpm.engine.impl.variable.listener that return ProcessEngine

Modifier and Type	Method	Description
ProcessEngine	DelegateCaseVariableInstanceImpl.getProcessEngine()

Uses of ProcessEngine in org.camunda.bpm.engine.repository

Methods in org.camunda.bpm.engine.repository with parameters of type ProcessEngine

Modifier and Type	Method	Description
DeploymentHandler	DeploymentHandlerFactory.buildDeploymentHandler(ProcessEngine processEngine)	Creates a DeploymentHandler instance.

Uses of ProcessEngine in org.camunda.bpm.engine.test

Fields in org.camunda.bpm.engine.test declared as ProcessEngine

Modifier and Type	Field	Description
protected ProcessEngine	ProcessEngineRule.processEngine
protected ProcessEngine	ProcessEngineTestCase.processEngine

Methods in org.camunda.bpm.engine.test that return ProcessEngine

Modifier and Type	Method	Description
ProcessEngine	ProcessEngineRule.getProcessEngine()

Methods in org.camunda.bpm.engine.test with parameters of type ProcessEngine

Modifier and Type	Method	Description
void	ProcessEngineRule.setProcessEngine(ProcessEngine processEngine)

Constructors in org.camunda.bpm.engine.test with parameters of type ProcessEngine

Modifier	Constructor	Description
	ProcessEngineRule(ProcessEngine processEngine)
	ProcessEngineRule(ProcessEngine processEngine, boolean ensureCleanAfterTest)