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

Packages that use ProcessEngine
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 BPM 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.impl API implementation classes, which shouldn't directly be used by end-users. 
org.camunda.bpm.engine.impl.cfg   
org.camunda.bpm.engine.impl.metrics   
org.camunda.bpm.engine.impl.migration.instance.parser   
org.camunda.bpm.engine.impl.plugin   
org.camunda.bpm.engine.impl.test   
org.camunda.bpm.engine.impl.util   
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
 ProcessEngine ProcessEngineService.getDefaultProcessEngine()
           
static ProcessEngine BpmPlatform.getDefaultProcessEngine()
           
 ProcessEngine ProcessEngineService.getProcessEngine(String name)
           
 

Methods in org.camunda.bpm that return types with arguments of type ProcessEngine
 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
 void EjbProcessApplicationReference.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
 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
 ProcessEngine RuntimeContainerDelegateImpl.getDefaultProcessEngine()
           
 ProcessEngine RuntimeContainerDelegateImpl.getProcessEngine(String name)
           
 

Methods in org.camunda.bpm.container.impl that return types with arguments of type ProcessEngine
 List<ProcessEngine> RuntimeContainerDelegateImpl.getProcessEngines()
           
 

Methods in org.camunda.bpm.container.impl with parameters of type ProcessEngine
 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
protected  ProcessEngine DeployProcessArchiveStep.getProcessEngine(PlatformServiceContainer serviceContainer)
           
 

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

Methods in org.camunda.bpm.container.impl.deployment.util that return ProcessEngine
static ProcessEngine InjectionUtil.getDefaultProcessEngine(DeploymentOperation operationContext)
           
 

Methods in org.camunda.bpm.container.impl.deployment.util that return types with arguments of type ProcessEngine
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
protected  ProcessEngine JmxManagedProcessEngine.processEngine
           
 

Methods in org.camunda.bpm.container.impl.jmx.services that return ProcessEngine
 ProcessEngine JmxManagedProcessEngine.getProcessEngine()
           
 ProcessEngine JmxManagedProcessEngine.getValue()
           
 

Constructors in org.camunda.bpm.container.impl.jmx.services with parameters of type ProcessEngine
JmxManagedProcessEngine(ProcessEngine processEngine)
           
 

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

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

Uses of ProcessEngine in org.camunda.bpm.engine
 

Fields in org.camunda.bpm.engine with type parameters of type ProcessEngine
protected static Map<String,ProcessEngine> ProcessEngines.processEngines
           
 

Methods in org.camunda.bpm.engine that return ProcessEngine
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
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
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.impl
 

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

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

Methods in org.camunda.bpm.engine.impl.cfg that return ProcessEngine
 ProcessEngine ProcessEngineConfigurationImpl.buildProcessEngine()
           
 

Methods in org.camunda.bpm.engine.impl.cfg with parameters of type ProcessEngine
protected  void ProcessEngineConfigurationImpl.invokePostProcessEngineBuild(ProcessEngine engine)
           
 void CompositeProcessEnginePlugin.postProcessEngineBuild(ProcessEngine processEngine)
           
 void AbstractProcessEnginePlugin.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.metrics
 

Methods in org.camunda.bpm.engine.impl.metrics with parameters of type ProcessEngine
 String MetricsReporterIdProvider.provideId(ProcessEngine processEngine)
          Provides an id that identifies the metrics reported as part of the given engine's process execution.
 String SimpleIpBasedProvider.provideId(ProcessEngine processEngine)
           
 

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
protected  ProcessEngine MigratingInstanceParser.engine
           
 

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

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

Methods in org.camunda.bpm.engine.impl.plugin with parameters of type ProcessEngine
 void AdministratorAuthorizationPlugin.postProcessEngineBuild(ProcessEngine processEngine)
           
 

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

Fields in org.camunda.bpm.engine.impl.test declared as ProcessEngine
protected static ProcessEngine PluggableProcessEngineTestCase.cachedProcessEngine
           
protected  ProcessEngine AbstractProcessEngineTestCase.processEngine
           
 

Methods in org.camunda.bpm.engine.impl.test that return ProcessEngine
static ProcessEngine PluggableProcessEngineTestCase.getProcessEngine()
           
static ProcessEngine TestHelper.getProcessEngine(String configurationResource)
           
 

Methods in org.camunda.bpm.engine.impl.test with parameters of type ProcessEngine
static String TestHelper.annotationDeploymentSetUp(ProcessEngine processEngine, Class<?> testClass, String methodName)
           
static String TestHelper.annotationDeploymentSetUp(ProcessEngine processEngine, Class<?> testClass, String methodName, Deployment deploymentAnnotation)
           
static void TestHelper.annotationDeploymentTearDown(ProcessEngine processEngine, String deploymentId, Class<?> testClass, String methodName)
           
static boolean TestHelper.annotationRequiredHistoryLevelCheck(ProcessEngine processEngine, Class<?> testClass, String methodName)
           
static boolean TestHelper.annotationRequiredHistoryLevelCheck(ProcessEngine processEngine, org.junit.runner.Description description)
           
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 TestHelper.assertProcessEnded(ProcessEngine processEngine, String processInstanceId)
          Deprecated. 
static void ProcessEngineAssert.assertProcessEnded(ProcessEngine processEngine, String processInstanceId)
           
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
static String StringUtil.fromBytes(byte[] bytes, ProcessEngine processEngine)
          converts a byte array into a string using the provided process engine's 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.test
 

Fields in org.camunda.bpm.engine.test declared as ProcessEngine
protected  ProcessEngine ProcessEngineRule.processEngine
           
protected  ProcessEngine ProcessEngineTestCase.processEngine
           
 

Methods in org.camunda.bpm.engine.test that return ProcessEngine
 ProcessEngine ProcessEngineRule.getProcessEngine()
           
 

Methods in org.camunda.bpm.engine.test with parameters of type ProcessEngine
 void ProcessEngineRule.setProcessEngine(ProcessEngine processEngine)
           
 

Constructors in org.camunda.bpm.engine.test with parameters of type ProcessEngine
ProcessEngineRule(ProcessEngine processEngine)
           
ProcessEngineRule(ProcessEngine processEngine, boolean ensureCleanAfterTest)
           
 



Copyright © 2017 camunda services GmbH. All rights reserved.