org.flowable.spring.boot.FlowableProperties Maven / Gradle / Ivy
The newest version!
/* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.flowable.spring.boot;
import java.time.Duration;
import java.time.temporal.ChronoUnit;
import java.util.Arrays;
import java.util.List;
import org.flowable.common.engine.impl.history.HistoryLevel;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.context.properties.DeprecatedConfigurationProperty;
import org.springframework.boot.convert.DurationUnit;
/**
* @author Josh Long
* @author Joram Barrez
* @author Filip Hrisafov
*/
@ConfigurationProperties(prefix = "flowable")
public class FlowableProperties {
/**
* Whether process definitions need to be auto deployed.
*/
private boolean checkProcessDefinitions = true;
/**
* Whether the async executor should be activated.
*/
private boolean asyncExecutorActivate = true;
/**
* Whether the async history executor should be activated.
*/
private boolean asyncHistoryExecutorActivate = true;
private boolean restApiEnabled;
private String activityFontName = "Arial";
private String labelFontName = "Arial";
private String annotationFontName = "Arial";
/**
* The name of the auto deployment.
*/
private String deploymentName = "SpringBootAutoDeployment";
/**
* The strategy that should be used for the database schema.
*/
private String databaseSchemaUpdate = "true";
/**
* In some situations you want to set the schema to use for table checks / generation if the database metadata doesn't return that correctly.
*/
private String databaseSchema;
/**
* Whether to use a lock when performing the database schema create or update operations.
*/
private boolean useLockForDatabaseSchemaUpdate = false;
/**
* @deprecated use {@link org.flowable.spring.boot.idm.FlowableIdmProperties#isEnabled}
*/
@Deprecated
private boolean isDbIdentityUsed = true;
/**
* Whether db history should be used.
*/
private boolean isDbHistoryUsed = true;
/**
* The history level that needs to be used.
*/
private HistoryLevel historyLevel = HistoryLevel.AUDIT;
/**
* The folder in which processes need to be searched for auto deployment.
*/
private String processDefinitionLocationPrefix = "classpath*:/processes/";
/**
* The suffixes (extensions) of the files that needs to be deployed from the 'processDefinitionLocationPrefix' location.
*/
private List processDefinitionLocationSuffixes = Arrays.asList("**.bpmn20.xml", "**.bpmn");
private boolean jpaEnabled = true; // true by default
/**
* The FQN of custom Mybatis mappers that need to be added to the engine.
*/
private List customMybatisMappers;
/**
* The location of the custom Mybatis XML Mappers that need to be added to the engine.
*/
private List customMybatisXMLMappers;
/**
* Enable form field validation after form submission on the engine level
*/
protected boolean formFieldValidationEnabled = false;
/**
* Duration between the checks when acquiring a lock.
*/
private Duration lockPollRate = Duration.ofSeconds(10);
/**
* Duration to wait for the DB Schema lock before giving up.
*/
private Duration schemaLockWaitTime = Duration.ofMinutes(5);
private boolean enableHistoryCleaning = false;
private String historyCleaningCycle = "0 0 1 * * ?";
@DurationUnit(ChronoUnit.DAYS)
private Duration historyCleaningAfter = Duration.ofDays(365);
private int historyCleaningBatchSize = 100;
public boolean isAsyncExecutorActivate() {
return asyncExecutorActivate;
}
public void setAsyncExecutorActivate(boolean asyncExecutorActivate) {
this.asyncExecutorActivate = asyncExecutorActivate;
}
public boolean isAsyncHistoryExecutorActivate() {
return asyncHistoryExecutorActivate;
}
public void setAsyncHistoryExecutorActivate(boolean asyncHistoryExecutorActivate) {
this.asyncHistoryExecutorActivate = asyncHistoryExecutorActivate;
}
public boolean isRestApiEnabled() {
return restApiEnabled;
}
public void setRestApiEnabled(boolean restApiEnabled) {
this.restApiEnabled = restApiEnabled;
}
public boolean isJpaEnabled() {
return jpaEnabled;
}
public void setJpaEnabled(boolean jpaEnabled) {
this.jpaEnabled = jpaEnabled;
}
/**
* @deprecated use {@link org.flowable.spring.boot.process.FlowableProcessProperties#getServlet()#getPath()}
*/
@DeprecatedConfigurationProperty(replacement = "flowable.process.servlet.path")
@Deprecated
public String getRestApiMapping() {
throw new IllegalStateException("Usage of deprecated property. Use FlowableProcessProperties");
}
/**
* @deprecated use {@link org.flowable.spring.boot.process.FlowableProcessProperties#getServlet()#setPath()}
*/
@Deprecated
public void setRestApiMapping(String restApiMapping) {
throw new IllegalStateException("Usage of deprecated property. Use FlowableProcessProperties");
}
/**
* @deprecated use {@link org.flowable.spring.boot.process.FlowableProcessProperties#getServlet()#getName()}
*/
@DeprecatedConfigurationProperty(replacement = "flowable.process.servlet.name")
@Deprecated
public String getRestApiServletName() {
throw new IllegalStateException("Usage of deprecated property. Use FlowableProcessProperties");
}
/**
* @deprecated use {@link org.flowable.spring.boot.process.FlowableProcessProperties#getServlet()#setName()}
*/
@Deprecated
public void setRestApiServletName(String restApiServletName) {
throw new IllegalStateException("Usage of deprecated property. Use FlowableProcessProperties");
}
public boolean isCheckProcessDefinitions() {
return checkProcessDefinitions;
}
public void setCheckProcessDefinitions(boolean checkProcessDefinitions) {
this.checkProcessDefinitions = checkProcessDefinitions;
}
public String getDeploymentName() {
return deploymentName;
}
public void setDeploymentName(String deploymentName) {
this.deploymentName = deploymentName;
}
public String getDatabaseSchemaUpdate() {
return databaseSchemaUpdate;
}
public void setDatabaseSchemaUpdate(String databaseSchemaUpdate) {
this.databaseSchemaUpdate = databaseSchemaUpdate;
}
public String getDatabaseSchema() {
return databaseSchema;
}
public void setDatabaseSchema(String databaseSchema) {
this.databaseSchema = databaseSchema;
}
public boolean isUseLockForDatabaseSchemaUpdate() {
return useLockForDatabaseSchemaUpdate;
}
public void setUseLockForDatabaseSchemaUpdate(boolean useLockForDatabaseSchemaUpdate) {
this.useLockForDatabaseSchemaUpdate = useLockForDatabaseSchemaUpdate;
}
/**
* @deprecated use {@link org.flowable.spring.boot.idm.FlowableIdmProperties#isEnabled()}
*/
@DeprecatedConfigurationProperty(replacement = "flowable.idm.enabled")
@Deprecated
public boolean isDbIdentityUsed() {
return isDbIdentityUsed;
}
/**
* @deprecated use {@link org.flowable.spring.boot.idm.FlowableIdmProperties#setEnabled(boolean)}
*/
@Deprecated
public void setDbIdentityUsed(boolean isDbIdentityUsed) {
this.isDbIdentityUsed = isDbIdentityUsed;
}
public boolean isDbHistoryUsed() {
return isDbHistoryUsed;
}
public void setDbHistoryUsed(boolean isDbHistoryUsed) {
this.isDbHistoryUsed = isDbHistoryUsed;
}
public HistoryLevel getHistoryLevel() {
return historyLevel;
}
public void setHistoryLevel(HistoryLevel historyLevel) {
this.historyLevel = historyLevel;
}
public String getProcessDefinitionLocationPrefix() {
return processDefinitionLocationPrefix;
}
public void setProcessDefinitionLocationPrefix(
String processDefinitionLocationPrefix) {
this.processDefinitionLocationPrefix = processDefinitionLocationPrefix;
}
public List getProcessDefinitionLocationSuffixes() {
return processDefinitionLocationSuffixes;
}
public void setProcessDefinitionLocationSuffixes(
List processDefinitionLocationSuffixes) {
this.processDefinitionLocationSuffixes = processDefinitionLocationSuffixes;
}
public List getCustomMybatisMappers() {
return customMybatisMappers;
}
public void setCustomMybatisMappers(List customMyBatisMappers) {
this.customMybatisMappers = customMyBatisMappers;
}
public List getCustomMybatisXMLMappers() {
return customMybatisXMLMappers;
}
public void setCustomMybatisXMLMappers(List customMybatisXMLMappers) {
this.customMybatisXMLMappers = customMybatisXMLMappers;
}
public String getActivityFontName() {
return activityFontName;
}
public void setActivityFontName(String activityFontName) {
this.activityFontName = activityFontName;
}
public String getLabelFontName() {
return labelFontName;
}
public void setLabelFontName(String labelFontName) {
this.labelFontName = labelFontName;
}
public String getAnnotationFontName() {
return annotationFontName;
}
public void setAnnotationFontName(String annotationFontName) {
this.annotationFontName = annotationFontName;
}
public boolean isFormFieldValidationEnabled() {
return formFieldValidationEnabled;
}
public void setFormFieldValidationEnabled(boolean formFieldValidationEnabled) {
this.formFieldValidationEnabled = formFieldValidationEnabled;
}
public Duration getLockPollRate() {
return lockPollRate;
}
public void setLockPollRate(Duration lockPollRate) {
this.lockPollRate = lockPollRate;
}
public Duration getSchemaLockWaitTime() {
return schemaLockWaitTime;
}
public void setSchemaLockWaitTime(Duration schemaLockWaitTime) {
this.schemaLockWaitTime = schemaLockWaitTime;
}
public boolean isEnableHistoryCleaning() {
return enableHistoryCleaning;
}
public void setEnableHistoryCleaning(boolean enableHistoryCleaning) {
this.enableHistoryCleaning = enableHistoryCleaning;
}
public String getHistoryCleaningCycle() {
return historyCleaningCycle;
}
public void setHistoryCleaningCycle(String historyCleaningCycle) {
this.historyCleaningCycle = historyCleaningCycle;
}
@Deprecated
@DeprecatedConfigurationProperty(replacement = "flowable.history-cleaning-after", reason = "Switched to using a Duration that allows more flexible configuration")
public void setHistoryCleaningAfterDays(int historyCleaningAfterDays) {
this.historyCleaningAfter = Duration.ofDays(historyCleaningAfterDays);
}
public Duration getHistoryCleaningAfter() {
return historyCleaningAfter;
}
public void setHistoryCleaningAfter(Duration historyCleaningAfter) {
this.historyCleaningAfter = historyCleaningAfter;
}
public int getHistoryCleaningBatchSize() {
return historyCleaningBatchSize;
}
public void setHistoryCleaningBatchSize(int historyCleaningBatchSize) {
this.historyCleaningBatchSize = historyCleaningBatchSize;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy