| Package | Description |
|---|---|
| org.flowable.cdi.impl | |
| org.flowable.cdi.impl.util | |
| org.flowable.cdi.spi | |
| org.flowable.crystalball.simulator | |
| org.flowable.engine |
Public API of the Flowable 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 administration and maintenance operations,
which have no relation to the runtime exection 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.flowable.engine.configurator | |
| org.flowable.engine.impl |
API implementation classes, which shouldn't directly be used by end-users.
|
| org.flowable.engine.impl.cfg | |
| org.flowable.engine.impl.cfg.multitenant | |
| org.flowable.engine.impl.test | |
| org.flowable.engine.spring.configurator | |
| org.flowable.engine.test |
Helper classes for testing processes.
|
| org.flowable.engine.test.mock | |
| org.flowable.osgi.blueprint | |
| org.flowable.rest.service.api.management | |
| org.flowable.spring | |
| org.flowable.spring.boot | |
| org.flowable.spring.boot.actuate.endpoint | |
| org.flowable.spring.configurator | |
| org.flowable.spring.impl.test | |
| org.flowable.spring.integration | |
| org.flowable.ui.task.conf |
| Modifier and Type | Field and Description |
|---|---|
protected ProcessEngine |
ProcessDeployer.processEngine |
| Modifier and Type | Method and Description |
|---|---|
ProcessEngine |
LocalProcessEngineLookup.getProcessEngine() |
protected ProcessEngine |
FlowableExtension.lookupProcessEngine(javax.enterprise.inject.spi.BeanManager beanManager) |
| Constructor and Description |
|---|
ProcessDeployer(ProcessEngine processEngine) |
| Modifier and Type | Method and Description |
|---|---|
ProcessEngine |
FlowableServices.processEngine() |
| Modifier and Type | Method and Description |
|---|---|
void |
FlowableServices.setProcessEngine(ProcessEngine processEngine) |
| Modifier and Type | Method and Description |
|---|---|
ProcessEngine |
ProcessEngineLookup.getProcessEngine()
This method will only be called once by the
FlowableExtension, at startup |
| Modifier and Type | Field and Description |
|---|---|
protected ProcessEngine |
AbstractSimulationRun.processEngine |
| Modifier and Type | Field and Description |
|---|---|
protected static ThreadLocal<Stack<ProcessEngine>> |
SimulationRunContext.processEngineThreadLocal |
| Modifier and Type | Method and Description |
|---|---|
static ProcessEngine |
SimulationRunContext.getProcessEngine() |
| Modifier and Type | Method and Description |
|---|---|
static void |
SimulationRunContext.setProcessEngine(ProcessEngine processEngine) |
| Constructor and Description |
|---|
ReplaySimulationRun(ProcessEngine processEngine,
EventCalendar eventCalendar,
Map<String,SimulationEventHandler> customEventHandlerMap) |
ReplaySimulationRun(ProcessEngine processEngine,
Map<String,SimulationEventHandler> customEventHandlerMap) |
| Modifier and Type | Field and Description |
|---|---|
protected static Map<String,ProcessEngine> |
ProcessEngines.processEngines |
| Modifier and Type | Method and Description |
|---|---|
abstract ProcessEngine |
ProcessEngineConfiguration.buildProcessEngine() |
static ProcessEngine |
ProcessEngines.getDefaultProcessEngine() |
static ProcessEngine |
ProcessEngines.getProcessEngine(String processEngineName)
obtain a process engine by name.
|
| Modifier and Type | Method and Description |
|---|---|
static Map<String,ProcessEngine> |
ProcessEngines.getProcessEngines()
provides access to process engine to application clients in a managed server environment.
|
| Modifier and Type | Method and Description |
|---|---|
void |
ProcessEngineLifecycleListener.onProcessEngineBuilt(ProcessEngine processEngine)
Called right after the process-engine has been built.
|
void |
ProcessEngineLifecycleListener.onProcessEngineClosed(ProcessEngine processEngine)
Called right after the process-engine has been closed.
|
static void |
ProcessEngines.registerProcessEngine(ProcessEngine processEngine)
Registers the given process engine.
|
static void |
ProcessEngines.unregister(ProcessEngine processEngine)
Unregisters the given process engine.
|
| Modifier and Type | Method and Description |
|---|---|
protected ProcessEngine |
ProcessEngineConfigurator.initProcessEngine() |
| Modifier and Type | Class and Description |
|---|---|
class |
ProcessEngineImpl |
| Modifier and Type | Method and Description |
|---|---|
ProcessEngine |
ProcessEngineConfigurationImpl.buildProcessEngine() |
| Modifier and Type | Method and Description |
|---|---|
ProcessEngine |
MultiSchemaMultiTenantProcessEngineConfiguration.buildProcessEngine() |
| Modifier and Type | Field and Description |
|---|---|
protected ProcessEngine |
AbstractFlowableTestCase.processEngine |
| Modifier and Type | Method and Description |
|---|---|
protected ProcessEngine |
PluggableFlowableExtension.getProcessEngine(org.junit.jupiter.api.extension.ExtensionContext context) |
protected abstract ProcessEngine |
InternalFlowableExtension.getProcessEngine(org.junit.jupiter.api.extension.ExtensionContext context) |
protected ProcessEngine |
ResourceFlowableExtension.getProcessEngine(org.junit.jupiter.api.extension.ExtensionContext context) |
static ProcessEngine |
TestHelper.getProcessEngine(String configurationResource) |
protected ProcessEngine |
ResourceFlowableExtension.initializeProcessEngine() |
protected ProcessEngine |
PluggableFlowableExtension.initializeProcessEngine(String configurationResource) |
ProcessEngine |
ResourceFlowableExtension.rebootEngine() |
| Modifier and Type | Method and Description |
|---|---|
static String |
TestHelper.annotationDeploymentSetUp(ProcessEngine processEngine,
Class<?> testClass,
Method method) |
static String |
TestHelper.annotationDeploymentSetUp(ProcessEngine processEngine,
Class<?> testClass,
Method method,
Deployment deploymentAnnotation) |
static String |
TestHelper.annotationDeploymentSetUp(ProcessEngine processEngine,
Class<?> testClass,
String methodName) |
static String |
TestHelper.annotationDeploymentSetUp(ProcessEngine processEngine,
Method method,
Deployment deploymentAnnotation) |
static void |
TestHelper.annotationDeploymentTearDown(ProcessEngine processEngine,
String deploymentId,
Class<?> testClass,
String methodName) |
static void |
TestHelper.assertAndEnsureCleanDb(ProcessEngine processEngine)
Each test is assumed to clean up all DB content it entered.
|
protected void |
InternalFlowableExtension.assertAndEnsureCleanDb(ProcessEngine processEngine,
org.junit.jupiter.api.extension.ExtensionContext context,
EnsureCleanDb ensureCleanDb)
Each test is assumed to clean up all DB content it entered.
|
static void |
TestHelper.assertProcessEnded(ProcessEngine processEngine,
String processInstanceId) |
protected static void |
AbstractFlowableTestCase.cleanDeployments(ProcessEngine processEngine) |
protected void |
InternalFlowableExtension.cleanTestAndAssertAndEnsureCleanDb(org.junit.jupiter.api.extension.ExtensionContext context,
ProcessEngine processEngine) |
void |
AbstractFlowableTestCase.initializeServices(ProcessEngine processEngine) |
protected void |
PluggableFlowableExtension.swapCommandInvoker(ProcessEngine processEngine,
boolean debug) |
protected static void |
AbstractFlowableTestCase.validateHistoryData(ProcessEngine processEngine) |
| Modifier and Type | Method and Description |
|---|---|
protected ProcessEngine |
SpringProcessEngineConfigurator.initProcessEngine() |
| Modifier and Type | Field and Description |
|---|---|
protected ProcessEngine |
FlowableRule.processEngine |
protected ProcessEngine |
FlowableTestCase.processEngine |
protected ProcessEngine |
FlowableTestHelper.processEngine |
| Modifier and Type | Method and Description |
|---|---|
protected ProcessEngine |
FlowableExtension.createProcessEngine(org.junit.jupiter.api.extension.ExtensionContext context) |
ProcessEngine |
FlowableRule.getProcessEngine() |
ProcessEngine |
FlowableTestHelper.getProcessEngine() |
| Modifier and Type | Method and Description |
|---|---|
void |
FlowableRule.setProcessEngine(ProcessEngine processEngine) |
| Constructor and Description |
|---|
FlowableRule(ProcessEngine processEngine) |
FlowableTestHelper(ProcessEngine processEngine) |
| Modifier and Type | Method and Description |
|---|---|
static boolean |
FlowableMockSupport.isMockSupportPossible(ProcessEngine processEngine) |
| Constructor and Description |
|---|
FlowableMockSupport(ProcessEngine processEngine) |
| Modifier and Type | Method and Description |
|---|---|
ProcessEngine |
ProcessEngineFactory.getObject() |
| Modifier and Type | Field and Description |
|---|---|
protected ProcessEngine |
ProcessEngineResource.engine |
| Modifier and Type | Field and Description |
|---|---|
protected ProcessEngine |
ProcessEngineFactoryBean.processEngine |
| Modifier and Type | Field and Description |
|---|---|
protected Collection<AutoDeploymentStrategy<ProcessEngine>> |
SpringProcessEngineConfiguration.deploymentStrategies |
| Modifier and Type | Method and Description |
|---|---|
ProcessEngine |
SpringProcessEngineConfiguration.buildProcessEngine() |
static ProcessEngine |
SpringConfigurationHelper.buildProcessEngine(URL resource) |
ProcessEngine |
ProcessEngineFactoryBean.getObject() |
| Modifier and Type | Method and Description |
|---|---|
protected AutoDeploymentStrategy<ProcessEngine> |
SpringProcessEngineConfiguration.getAutoDeploymentStrategy(String mode)
Gets the
AutoDeploymentStrategy for the provided mode. |
Collection<AutoDeploymentStrategy<ProcessEngine>> |
SpringProcessEngineConfiguration.getDeploymentStrategies() |
Class<ProcessEngine> |
ProcessEngineFactoryBean.getObjectType() |
| Modifier and Type | Method and Description |
|---|---|
protected void |
SpringProcessEngineConfiguration.autoDeployResources(ProcessEngine processEngine) |
| Modifier and Type | Method and Description |
|---|---|
void |
SpringProcessEngineConfiguration.setDeploymentStrategies(Collection<AutoDeploymentStrategy<ProcessEngine>> deploymentStrategies) |
| Modifier and Type | Method and Description |
|---|---|
DynamicBpmnService |
ProcessEngineServicesAutoConfiguration.dynamicBpmnServiceBean(ProcessEngine processEngine) |
FormService |
ProcessEngineServicesAutoConfiguration.formServiceBean(ProcessEngine processEngine) |
HistoryService |
ProcessEngineServicesAutoConfiguration.historyServiceBean(ProcessEngine processEngine) |
IdentityService |
ProcessEngineServicesAutoConfiguration.identityServiceBean(ProcessEngine processEngine) |
ManagementService |
ProcessEngineServicesAutoConfiguration.managementServiceBean(ProcessEngine processEngine) |
ProcessEngineEndpoint |
EndpointAutoConfiguration.processEngineEndpoint(ProcessEngine engine) |
ProcessMigrationService |
ProcessEngineServicesAutoConfiguration.processInstanceMigrationService(ProcessEngine processEngine) |
RepositoryService |
ProcessEngineServicesAutoConfiguration.repositoryServiceBean(ProcessEngine processEngine) |
RuntimeService |
ProcessEngineServicesAutoConfiguration.runtimeServiceBean(ProcessEngine processEngine) |
TaskService |
ProcessEngineServicesAutoConfiguration.taskServiceBean(ProcessEngine processEngine) |
| Modifier and Type | Method and Description |
|---|---|
SpringProcessEngineConfiguration |
ProcessEngineAutoConfiguration.springProcessEngineConfiguration(DataSource dataSource,
org.springframework.transaction.PlatformTransactionManager platformTransactionManager,
org.springframework.beans.factory.ObjectProvider<com.fasterxml.jackson.databind.ObjectMapper> objectMapperProvider,
org.springframework.beans.factory.ObjectProvider<IdGenerator> processIdGenerator,
org.springframework.beans.factory.ObjectProvider<IdGenerator> globalIdGenerator,
org.springframework.beans.factory.ObjectProvider<AsyncExecutor> asyncExecutorProvider,
org.springframework.beans.factory.ObjectProvider<org.springframework.core.task.AsyncListenableTaskExecutor> applicationTaskExecutorProvider,
org.springframework.beans.factory.ObjectProvider<AsyncExecutor> asyncHistoryExecutorProvider,
org.springframework.beans.factory.ObjectProvider<org.springframework.core.task.AsyncListenableTaskExecutor> taskExecutor,
org.springframework.beans.factory.ObjectProvider<org.springframework.core.task.AsyncListenableTaskExecutor> processTaskExecutor,
org.springframework.beans.factory.ObjectProvider<FlowableHttpClient> flowableHttpClient,
org.springframework.beans.factory.ObjectProvider<List<AutoDeploymentStrategy<ProcessEngine>>> processEngineAutoDeploymentStrategies) |
| Constructor and Description |
|---|
ProcessEngineEndpoint(ProcessEngine processEngine) |
| Modifier and Type | Method and Description |
|---|---|
protected void |
SingleResourceAutoDeploymentStrategy.deployResourcesInternal(String deploymentNameHint,
org.springframework.core.io.Resource[] resources,
ProcessEngine engine) |
protected void |
DefaultAutoDeploymentStrategy.deployResourcesInternal(String deploymentNameHint,
org.springframework.core.io.Resource[] resources,
ProcessEngine engine) |
protected void |
ResourceParentFolderAutoDeploymentStrategy.deployResourcesInternal(String deploymentNameHint,
org.springframework.core.io.Resource[] resources,
ProcessEngine engine) |
protected LockManager |
AbstractProcessAutoDeploymentStrategy.getLockManager(ProcessEngine engine,
String deploymentNameHint) |
| Modifier and Type | Method and Description |
|---|---|
protected ProcessEngine |
FlowableSpringExtension.createProcessEngine(org.junit.jupiter.api.extension.ExtensionContext context) |
protected ProcessEngine |
InternalFlowableSpringExtension.getProcessEngine(org.junit.jupiter.api.extension.ExtensionContext context) |
| Modifier and Type | Method and Description |
|---|---|
static FlowableInboundGateway |
Flowable.inboundGateway(ProcessEngine processEngine,
String... varsToPreserve)
This is the component that you'll use in your Spring Integration
IntegrationFlow. |
static org.springframework.messaging.MessageHandler |
Flowable.signallingMessageHandler(ProcessEngine processEngine)
Any message that enters this
MessageHandler containing a executionId parameter will trigger a
org.flowable.engine.RuntimeService#signal(String). |
| Constructor and Description |
|---|
FlowableInboundGateway(ProcessEngine processEngine,
String... pvsOrHeadersToPreserve) |
| Modifier and Type | Method and Description |
|---|---|
Clock |
FlowableEngineConfiguration.getClock(ProcessEngine processEngine) |
Copyright © 2023 Flowable. All rights reserved.