java.lang.Object

com.flowable.spring.boot.properties.FlowableProperties

@ConfigurationProperties(prefix="flowable")
public class FlowableProperties
extends java.lang.Object

Author:: Josh Long, Joram Barrez, Filip Hrisafov

Field Summary

Fields
Modifier and Type	Field	Description
`protected java.lang.String`	`activityFontName`
`protected java.lang.String`	`annotationFontName`
`protected boolean`	`asyncExecutorActivate`	Whether the async executor should be activated.
`protected boolean`	`asyncHistoryExecutorActivate`	Whether the async history executor should be activated.
`protected boolean`	`bulkInsertEnabled`	Enable bulk insert for all engines
`protected boolean`	`checkProcessDefinitions`	Whether process definitions need to be auto deployed.
`protected java.util.List<java.lang.String>`	`customMybatisMappers`	The FQN of custom Mybatis mappers that need to be added to the engine.
`protected java.util.List<java.lang.String>`	`customMybatisXMLMappers`	The location of the custom Mybatis XML Mappers that need to be added to the engine.
`protected java.lang.String`	`databaseSchema`	In some situations you want to set the schema to use for table checks / generation if the database metadata doesn't return that correctly.
`protected java.lang.String`	`databaseSchemaUpdate`	The strategy that should be used for the database schema.
`protected java.lang.String`	`deploymentName`	The name of the auto deployment.
`protected boolean`	`formFieldValidationEnabled`	Enable form field validation after form submission on the engine level
`protected org.flowable.common.engine.impl.history.HistoryLevel`	`historyLevel`	The history level that needs to be used.
`protected boolean`	`isDbHistoryUsed`	Whether db history should be used.
`protected boolean`	`isDbIdentityUsed`	Deprecated. use `FlowableIdmProperties.setEnabled(boolean)`
`protected boolean`	`jpaEnabled`
`protected java.lang.String`	`labelFontName`
`protected java.time.Duration`	`lockPollRate`	Duration between the checks when acquiring a lock.
`protected java.lang.String`	`nodeName`	The name of node where the application is running.
`protected java.lang.String`	`processDefinitionLocationPrefix`	The folder in which processes need to be searched for auto deployment.
`protected java.util.List<java.lang.String>`	`processDefinitionLocationSuffixes`	The suffixes (extensions) of the files that needs to be deployed from the 'processDefinitionLocationPrefix' location.
`protected boolean`	`restApiEnabled`
`protected java.time.Duration`	`schemaLockWaitTime`	Duration to wait for the DB Schema lock before giving up.
`protected boolean`	`useLockForDatabaseSchemaUpdate`	Whether to use a lock when performing the database schema create or update operations.

Constructor Summary

Constructors

Constructor Description

FlowableProperties()

Method Summary

Modifier and Type	Method	Description
`java.lang.String`	`determineNodeName()`
`java.lang.String`	`getActivityFontName()`
`java.lang.String`	`getAnnotationFontName()`
`java.util.List<java.lang.String>`	`getCustomMybatisMappers()`
`java.util.List<java.lang.String>`	`getCustomMybatisXMLMappers()`
`java.lang.String`	`getDatabaseSchema()`
`java.lang.String`	`getDatabaseSchemaUpdate()`
`java.lang.String`	`getDeploymentName()`
`org.flowable.common.engine.impl.history.HistoryLevel`	`getHistoryLevel()`
`java.lang.String`	`getLabelFontName()`
`java.time.Duration`	`getLockPollRate()`
`java.lang.String`	`getNodeName()`
`java.lang.String`	`getProcessDefinitionLocationPrefix()`
`java.util.List<java.lang.String>`	`getProcessDefinitionLocationSuffixes()`
`java.lang.String`	`getRestApiMapping()`	Deprecated. use com.flowable.spring.boot.process.FlowableProcessProperties#getServlet()#getPath() instead
`java.lang.String`	`getRestApiServletName()`	Deprecated. use com.flowable.spring.boot.process.FlowableProcessProperties#getServlet()#getName() instead
`java.time.Duration`	`getSchemaLockWaitTime()`
`boolean`	`isAsyncExecutorActivate()`
`boolean`	`isAsyncHistoryExecutorActivate()`
`boolean`	`isBulkInsertEnabled()`
`boolean`	`isCheckProcessDefinitions()`
`boolean`	`isDbHistoryUsed()`
`boolean`	`isDbIdentityUsed()`	Deprecated. use `FlowableIdmProperties.isEnabled()`
`boolean`	`isFormFieldValidationEnabled()`
`boolean`	`isJpaEnabled()`
`boolean`	`isRestApiEnabled()`
`boolean`	`isUseLockForDatabaseSchemaUpdate()`
`void`	`setActivityFontName(java.lang.String activityFontName)`
`void`	`setAnnotationFontName(java.lang.String annotationFontName)`
`void`	`setAsyncExecutorActivate(boolean asyncExecutorActivate)`
`void`	`setAsyncHistoryExecutorActivate(boolean asyncHistoryExecutorActivate)`
`void`	`setBulkInsertEnabled(boolean bulkInsertEnabled)`
`void`	`setCheckProcessDefinitions(boolean checkProcessDefinitions)`
`void`	`setCustomMybatisMappers(java.util.List<java.lang.String> customMyBatisMappers)`
`void`	`setCustomMybatisXMLMappers(java.util.List<java.lang.String> customMybatisXMLMappers)`
`void`	`setDatabaseSchema(java.lang.String databaseSchema)`
`void`	`setDatabaseSchemaUpdate(java.lang.String databaseSchemaUpdate)`
`void`	`setDbHistoryUsed(boolean isDbHistoryUsed)`
`void`	`setDbIdentityUsed(boolean isDbIdentityUsed)`	Deprecated. use `FlowableIdmProperties.setEnabled(boolean)`
`void`	`setDeploymentName(java.lang.String deploymentName)`
`void`	`setFormFieldValidationEnabled(boolean formFieldValidationEnabled)`
`void`	`setHistoryLevel(org.flowable.common.engine.impl.history.HistoryLevel historyLevel)`
`void`	`setJpaEnabled(boolean jpaEnabled)`
`void`	`setLabelFontName(java.lang.String labelFontName)`
`void`	`setLockPollRate(java.time.Duration lockPollRate)`
`void`	`setNodeName(java.lang.String nodeName)`
`void`	`setProcessDefinitionLocationPrefix(java.lang.String processDefinitionLocationPrefix)`
`void`	`setProcessDefinitionLocationSuffixes(java.util.List<java.lang.String> processDefinitionLocationSuffixes)`
`void`	`setRestApiEnabled(boolean restApiEnabled)`
`void`	`setRestApiMapping(java.lang.String restApiMapping)`	Deprecated. use com.flowable.spring.boot.process.FlowableProcessProperties#getServlet()#setPath() instead
`void`	`setRestApiServletName(java.lang.String restApiServletName)`	Deprecated. use com.flowable.spring.boot.process.FlowableProcessProperties#getServlet()#setName() instead
`void`	`setSchemaLockWaitTime(java.time.Duration schemaLockWaitTime)`
`void`	`setUseLockForDatabaseSchemaUpdate(boolean useLockForDatabaseSchemaUpdate)`

Methods inherited from class java.lang.Object

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

Field Details
- checkProcessDefinitions
  
  protected boolean checkProcessDefinitions
  
  Whether process definitions need to be auto deployed.
- asyncExecutorActivate
  
  protected boolean asyncExecutorActivate
  
  Whether the async executor should be activated.
- asyncHistoryExecutorActivate
  
  protected boolean asyncHistoryExecutorActivate
  
  Whether the async history executor should be activated.
- nodeName
  
  protected java.lang.String nodeName
  
  The name of node where the application is running.
- restApiEnabled
  
  protected boolean restApiEnabled
- activityFontName
  
  protected java.lang.String activityFontName
- labelFontName
  
  protected java.lang.String labelFontName
- annotationFontName
  
  protected java.lang.String annotationFontName
- deploymentName
  
  protected java.lang.String deploymentName
  
  The name of the auto deployment.
- databaseSchemaUpdate
  
  protected java.lang.String databaseSchemaUpdate
  
  The strategy that should be used for the database schema.
- databaseSchema
  
  protected java.lang.String databaseSchema
  
  In some situations you want to set the schema to use for table checks / generation if the database metadata doesn't return that correctly.
- useLockForDatabaseSchemaUpdate
  
  protected boolean useLockForDatabaseSchemaUpdate
  
  Whether to use a lock when performing the database schema create or update operations.
- isDbIdentityUsed
  
  @Deprecated protected boolean isDbIdentityUsed
  
  Deprecated.
  use FlowableIdmProperties.setEnabled(boolean)
- isDbHistoryUsed
  
  protected boolean isDbHistoryUsed
  
  Whether db history should be used.
- historyLevel
  
  protected org.flowable.common.engine.impl.history.HistoryLevel historyLevel
  
  The history level that needs to be used.
- processDefinitionLocationPrefix
  
  protected java.lang.String processDefinitionLocationPrefix
  
  The folder in which processes need to be searched for auto deployment.
- processDefinitionLocationSuffixes
  
  protected java.util.List<java.lang.String> processDefinitionLocationSuffixes
  
  The suffixes (extensions) of the files that needs to be deployed from the 'processDefinitionLocationPrefix' location.
- jpaEnabled
  
  protected boolean jpaEnabled
- customMybatisMappers
  
  protected java.util.List<java.lang.String> customMybatisMappers
  
  The FQN of custom Mybatis mappers that need to be added to the engine.
- customMybatisXMLMappers
  
  protected java.util.List<java.lang.String> customMybatisXMLMappers
  
  The location of the custom Mybatis XML Mappers that need to be added to the engine.
- bulkInsertEnabled
  
  protected boolean bulkInsertEnabled
  
  Enable bulk insert for all engines
- formFieldValidationEnabled
  
  protected boolean formFieldValidationEnabled
  
  Enable form field validation after form submission on the engine level
- lockPollRate
  
  protected java.time.Duration lockPollRate
  
  Duration between the checks when acquiring a lock.
- schemaLockWaitTime
  
  protected java.time.Duration schemaLockWaitTime
  
  Duration to wait for the DB Schema lock before giving up.
Constructor Details
- FlowableProperties
  
  public FlowableProperties()
Method Details
- isAsyncExecutorActivate
  
  public boolean isAsyncExecutorActivate()
- setAsyncExecutorActivate
  
  public void setAsyncExecutorActivate(boolean asyncExecutorActivate)
- isAsyncHistoryExecutorActivate
  
  public boolean isAsyncHistoryExecutorActivate()
- setAsyncHistoryExecutorActivate
  
  public void setAsyncHistoryExecutorActivate(boolean asyncHistoryExecutorActivate)
- getNodeName
  
  public java.lang.String getNodeName()
- setNodeName
  
  public void setNodeName(java.lang.String nodeName)
- determineNodeName
  
  public java.lang.String determineNodeName()
- isRestApiEnabled
  
  public boolean isRestApiEnabled()
- setRestApiEnabled
  
  public void setRestApiEnabled(boolean restApiEnabled)
- isJpaEnabled
  
  public boolean isJpaEnabled()
- setJpaEnabled
  
  public void setJpaEnabled(boolean jpaEnabled)
- getRestApiMapping
  
  @DeprecatedConfigurationProperty(replacement="flowable.process.servlet.path") @Deprecated public java.lang.String getRestApiMapping()
  
  Deprecated.
  use com.flowable.spring.boot.process.FlowableProcessProperties#getServlet()#getPath() instead
- setRestApiMapping
  
  @Deprecated public void setRestApiMapping(java.lang.String restApiMapping)
  
  Deprecated.
  use com.flowable.spring.boot.process.FlowableProcessProperties#getServlet()#setPath() instead
- getRestApiServletName
  
  @DeprecatedConfigurationProperty(replacement="flowable.process.servlet.name") @Deprecated public java.lang.String getRestApiServletName()
  
  Deprecated.
  use com.flowable.spring.boot.process.FlowableProcessProperties#getServlet()#getName() instead
- setRestApiServletName
  
  @Deprecated public void setRestApiServletName(java.lang.String restApiServletName)
  
  Deprecated.
  use com.flowable.spring.boot.process.FlowableProcessProperties#getServlet()#setName() instead
- isCheckProcessDefinitions
  
  public boolean isCheckProcessDefinitions()
- setCheckProcessDefinitions
  
  public void setCheckProcessDefinitions(boolean checkProcessDefinitions)
- getDeploymentName
  
  public java.lang.String getDeploymentName()
- setDeploymentName
  
  public void setDeploymentName(java.lang.String deploymentName)
- getDatabaseSchemaUpdate
  
  public java.lang.String getDatabaseSchemaUpdate()
- setDatabaseSchemaUpdate
  
  public void setDatabaseSchemaUpdate(java.lang.String databaseSchemaUpdate)
- getDatabaseSchema
  
  public java.lang.String getDatabaseSchema()
- setDatabaseSchema
  
  public void setDatabaseSchema(java.lang.String databaseSchema)
- isUseLockForDatabaseSchemaUpdate
  
  public boolean isUseLockForDatabaseSchemaUpdate()
- setUseLockForDatabaseSchemaUpdate
  
  public void setUseLockForDatabaseSchemaUpdate(boolean useLockForDatabaseSchemaUpdate)
- isDbIdentityUsed
  
  @DeprecatedConfigurationProperty(replacement="flowable.idm.enabled") @Deprecated public boolean isDbIdentityUsed()
  
  Deprecated.
  use FlowableIdmProperties.isEnabled()
- setDbIdentityUsed
  
  @Deprecated public void setDbIdentityUsed(boolean isDbIdentityUsed)
  
  Deprecated.
  use FlowableIdmProperties.setEnabled(boolean)
- isDbHistoryUsed
  
  public boolean isDbHistoryUsed()
- setDbHistoryUsed
  
  public void setDbHistoryUsed(boolean isDbHistoryUsed)
- getHistoryLevel
  
  public org.flowable.common.engine.impl.history.HistoryLevel getHistoryLevel()
- setHistoryLevel
  
  public void setHistoryLevel(org.flowable.common.engine.impl.history.HistoryLevel historyLevel)
- getProcessDefinitionLocationPrefix
  
  public java.lang.String getProcessDefinitionLocationPrefix()
- setProcessDefinitionLocationPrefix
  
  public void setProcessDefinitionLocationPrefix(java.lang.String processDefinitionLocationPrefix)
- getProcessDefinitionLocationSuffixes
  
  public java.util.List<java.lang.String> getProcessDefinitionLocationSuffixes()
- setProcessDefinitionLocationSuffixes
  
  public void setProcessDefinitionLocationSuffixes(java.util.List<java.lang.String> processDefinitionLocationSuffixes)
- getCustomMybatisMappers
  
  public java.util.List<java.lang.String> getCustomMybatisMappers()
- setCustomMybatisMappers
  
  public void setCustomMybatisMappers(java.util.List<java.lang.String> customMyBatisMappers)
- getCustomMybatisXMLMappers
  
  public java.util.List<java.lang.String> getCustomMybatisXMLMappers()
- setCustomMybatisXMLMappers
  
  public void setCustomMybatisXMLMappers(java.util.List<java.lang.String> customMybatisXMLMappers)
- getActivityFontName
  
  public java.lang.String getActivityFontName()
- setActivityFontName
  
  public void setActivityFontName(java.lang.String activityFontName)
- getLabelFontName
  
  public java.lang.String getLabelFontName()
- setLabelFontName
  
  public void setLabelFontName(java.lang.String labelFontName)
- getAnnotationFontName
  
  public java.lang.String getAnnotationFontName()
- setAnnotationFontName
  
  public void setAnnotationFontName(java.lang.String annotationFontName)
- isBulkInsertEnabled
  
  public boolean isBulkInsertEnabled()
- setBulkInsertEnabled
  
  public void setBulkInsertEnabled(boolean bulkInsertEnabled)
- isFormFieldValidationEnabled
  
  public boolean isFormFieldValidationEnabled()
- setFormFieldValidationEnabled
  
  public void setFormFieldValidationEnabled(boolean formFieldValidationEnabled)
- getLockPollRate
  
  public java.time.Duration getLockPollRate()
- setLockPollRate
  
  public void setLockPollRate(java.time.Duration lockPollRate)
- getSchemaLockWaitTime
  
  public java.time.Duration getSchemaLockWaitTime()
- setSchemaLockWaitTime
  
  public void setSchemaLockWaitTime(java.time.Duration schemaLockWaitTime)

Class FlowableProperties

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details

Constructor Details

Method Details