org.flowable.spring.boot.dmn.FlowableDmnProperties Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of flowable-spring-boot-autoconfigure Show documentation
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.dmn;

import java.util.Arrays;
import java.util.List;

import org.flowable.spring.boot.FlowableServlet;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.context.properties.NestedConfigurationProperty;

/**
 * Properties for configuring the dmn engine.
 *
 * @author Filip Hrisafov
 */
@ConfigurationProperties(prefix = "flowable.dmn")
public class FlowableDmnProperties {

    /**
     * The name of the deployment for the dmn resources.
     */
    private String deploymentName = "SpringBootAutoDeployment";

    /**
     * The location where the dmn resources are located.
     * Default is {@code classpath*:/dmn/}
     */
    private String resourceLocation = "classpath*:/dmn/";

    /**
     * The suffixes for the resources that need to be scanned.
     * Default is {@code **.dmn, **.dmn.xml, **.dmn11, **.dmn11.xml}
     */
    private List resourceSuffixes = Arrays.asList("**.dmn", "**.dmn.xml", "**.dmn11", "**.dmn11.xml");

    /**
     * Whether to perform deployment of resources, default is {@code true}.
     */
    private boolean deployResources = true;

    /**
     * Whether the dmn engine needs to be started.
     */
    private boolean enabled = true;

    /**
     * Whether the history for the DMN engine should be enabled.
     */
    private boolean historyEnabled = true;

    /**
     * Enables extra checks on the DMN xml that is parsed.
     * Unfortunately, this feature is not available on some platforms, hence you need to disable if your platform does not allow the use of
     * StaxSource during XML parsing.
     */
    private boolean enableSafeXml = true;

    /**
     * Set this to false if you want to ignore the decision table hit policy validity checks to result in an failed decision table state.
     * 
     * A result is that intermediate results created up to the point the validation error occurs are returned.
     */
    private boolean strictMode = true;

    /**
     * The servlet configuration for the DMN Rest API.
     */
    @NestedConfigurationProperty
    private final FlowableServlet servlet = new FlowableServlet("/dmn-api", "Flowable DMN Rest API");

    public String getDeploymentName() {
        return deploymentName;
    }

    public void setDeploymentName(String deploymentName) {
        this.deploymentName = deploymentName;
    }

    public String getResourceLocation() {
        return resourceLocation;
    }

    public void setResourceLocation(String resourceLocation) {
        this.resourceLocation = resourceLocation;
    }

    public List getResourceSuffixes() {
        return resourceSuffixes;
    }

    public void setResourceSuffixes(List resourceSuffixes) {
        this.resourceSuffixes = resourceSuffixes;
    }

    public boolean isDeployResources() {
        return deployResources;
    }

    public void setDeployResources(boolean deployResources) {
        this.deployResources = deployResources;
    }

    public boolean isEnabled() {
        return enabled;
    }

    public void setEnabled(boolean enabled) {
        this.enabled = enabled;
    }

    public boolean isHistoryEnabled() {
        return historyEnabled;
    }

    public void setHistoryEnabled(boolean historyEnabled) {
        this.historyEnabled = historyEnabled;
    }

    public boolean isEnableSafeXml() {
        return enableSafeXml;
    }

    public void setEnableSafeXml(boolean enableSafeXml) {
        this.enableSafeXml = enableSafeXml;
    }

    public boolean isStrictMode() {
        return strictMode;
    }

    public void setStrictMode(boolean strictMode) {
        this.strictMode = strictMode;
    }

    public FlowableServlet getServlet() {
        return servlet;
    }
}