org.flowable.spring.boot

Class AbstractSpringEngineAutoConfiguration

java.lang.Object

org.flowable.spring.boot.AbstractEngineAutoConfiguration

org.flowable.spring.boot.AbstractSpringEngineAutoConfiguration

Direct Known Subclasses:

AppEngineAutoConfiguration, CmmnEngineAutoConfiguration, DmnEngineAutoConfiguration, EventRegistryAutoConfiguration, FormEngineAutoConfiguration, ProcessEngineAutoConfiguration

public abstract class AbstractSpringEngineAutoConfiguration
extends AbstractEngineAutoConfiguration

Base auto configuration for the different engines.

Author:

Filip Hrisafov, Javier Casal

Field Summary

Fields inherited from class org.flowable.spring.boot.AbstractEngineAutoConfiguration

flowableProperties, logger, resourcePatternResolver

Constructor Summary

Constructors

Constructor and Description
AbstractSpringEngineAutoConfiguration(FlowableProperties flowableProperties)

Method Summary

Modifier and Type	Method and Description
protected void	configureSpringEngine(org.flowable.common.spring.SpringEngineConfiguration engineConfiguration, org.springframework.transaction.PlatformTransactionManager transactionManager)
protected <T> T	getIfAvailable(org.springframework.beans.factory.ObjectProvider<T> availableProvider, org.springframework.beans.factory.ObjectProvider<T> uniqueProvider) Get the Object provided by the availableProvider, otherwise get a unique object from uniqueProvider.

Methods inherited from class org.flowable.spring.boot.AbstractEngineAutoConfiguration

configureEngine, defaultIfNotNull, defaultText, discoverDeploymentResources, getCustomMybatisMapperClasses, setResourcePatternResolver

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractSpringEngineAutoConfiguration

public AbstractSpringEngineAutoConfiguration(FlowableProperties flowableProperties)

Method Detail

configureSpringEngine

protected void configureSpringEngine(org.flowable.common.spring.SpringEngineConfiguration engineConfiguration,
                                     org.springframework.transaction.PlatformTransactionManager transactionManager)

getIfAvailable

protected <T> T getIfAvailable(org.springframework.beans.factory.ObjectProvider<T> availableProvider,
                               org.springframework.beans.factory.ObjectProvider<T> uniqueProvider)

Get the Object provided by the availableProvider, otherwise get a unique object from uniqueProvider. This can be used when we allow users to provide specific implementations per engine. For example to provide a specific TaskExecutor and / or SpringRejectedJobsHandler for the CMMN Async Executor. Example:

 @Configuration
 public class MyCustomConfiguration {

     @Bean
     @Cmmn
     public TaskExecutor cmmnTaskExecutor() {
         return new MyCustomTaskExecutor()
     }

     @@Bean
     @Primary
     public TaskExecutor primaryTaskExecutor() {
         return new SimpleAsyncTaskExecutor()
     }

 }
 

Then when using:

 @Configuration
 public class FlowableJobConfiguration {

     public SpringAsyncExecutor cmmnAsyncExecutor(
         ObjectProvider<TaskExecutor> taskExecutor,
         @Cmmn ObjectProvider<TaskExecutor> cmmnTaskExecutor
     ) {
         TaskExecutor executor = getIfAvailable(
             cmmnTaskExecutor,
             taskExecutor
         );
         // executor is an instance of MyCustomTaskExecutor
     }

     public SpringAsyncExecutor processAsyncExecutor(
         ObjectProvider<TaskExecutor> taskExecutor,
         @Process ObjectProvider<TaskExecutor> processTaskExecutor
     ) {
         TaskExecutor executor = getIfAvailable(
             processTaskExecutor,
             taskExecutor
         );
         // executor is an instance of SimpleAsyncTaskExecutor
     }
 }
 

Type Parameters:

T - the type of the object being provided

Parameters:

availableProvider - a provider that can provide an available object

uniqueProvider - a provider that would be used if there is no available object, but only if it is unique

Returns:

the available object from availableProvider if there, otherwise the unique object from uniqueProvider