org.camunda.bpm.application.impl.metadata.spi.ProcessArchiveXml Maven / Gradle / Ivy
/*
* Copyright Camunda Services GmbH and/or licensed to Camunda Services GmbH
* under one or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information regarding copyright
* ownership. Camunda licenses this file to you under the Apache License,
* Version 2.0; 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.camunda.bpm.application.impl.metadata.spi;
import java.util.List;
import java.util.Map;
import org.camunda.bpm.engine.repository.ResumePreviousBy;
/**
* Java API representation of a ProcessArchive definition inside a processes.xml file
*
* @author Daniel Meyer
* @author Ronny Bräunlich
*
*/
public interface ProcessArchiveXml {
/** Indicates whether the undeployment of the process archive should trigger deleting the process engine deployment.
* If the process engine deployment is deleted, all running and historic process instances are removed as well. */
public static final String PROP_IS_DELETE_UPON_UNDEPLOY = "isDeleteUponUndeploy";
/** Indicates whether the classloader should be scanned for process definitions. */
public static final String PROP_IS_SCAN_FOR_PROCESS_DEFINITIONS = "isScanForProcessDefinitions";
/** Indicates whether old versions of the deployment should be resumed.
* If this property is not set, the default value is used: true. */
public static final String PROP_IS_RESUME_PREVIOUS_VERSIONS = "isResumePreviousVersions";
/**
* Indicates which previous deployments should be resumed by this deployment.
* Can be any of the options in {@link ResumePreviousBy}.
*/
public static final String PROP_RESUME_PREVIOUS_BY = "resumePreviousBy";
/**
* Indicates whether only changed resources should be part of the deployment.
* This is independent of the setting that if no resources change, no deployment
* takes place but the previous deployment is resumed.
*/
public static final String PROP_IS_DEPLOY_CHANGED_ONLY = "isDeployChangedOnly";
/**
* The resource root of the proccess archive. This property is used when scanning for process definitions
* (if {@link #PROP_IS_SCAN_FOR_PROCESS_DEFINITIONS} is set to true).
*
* The path is interpreted as
*
*
* -
* local to the root of the classpath.
* By default or if the prefix "classpath:" is used, the path is interpreted as relative to the root
* of the classloader. Example: "path/to/my/processes" or "classpath:path/to/my/processes")
*
*
* -
* relative to the process archive's definig metafile (processes.xml).
* If the prefix "pa:" is used, the path is interpreted as relative to the metafile defining the
* process archive. Consider the situation of a process application packaged as a WAR file:
*
* The deployment structure could look like this:
*
* |-- My-Application.war
* |-- WEB-INF
* |-- lib/
* |-- Sales-Processes.jar
* |-- META-INF/processes.xml (1)
* |-- opps/openOpportunity.bpmn
* |-- leads/openLead.bpmn
*
* |-- Invoice-Processes.jar
* |-- META-INF/processes.xml (2)
*
* If the process archive(s) defined in (1) uses a path prefixed with "pa:", like for instance "pa:opps/",
* only the "opps/"-folder of sales-processes.jar is scanned. More precisely, a "pa-local path", is resolved
* relative to the the parent directory of the META-INF-directory containing the defining processes.xml file.
* This implies, that using a pa-local path in (1), no processes from (2) are visible.
*
*
*
*
*/
public static final String PROP_RESOURCE_ROOT_PATH = "resourceRootPath";
/**
* A semicolon separated list of additional suffixes for resources to scan for.
*/
public static final String PROP_ADDITIONAL_RESOURCE_SUFFIXES = "additionalResourceSuffixes";
public static final String PROP_ADDITIONAL_RESOURCE_SUFFIXES_SEPARATOR = ",";
/**
* @return the name of the process archive. Must not be null.
*/
public String getName();
/**
* @return the id of the tenant the resources of the process archive should deploy for. Can be null.
*/
public String getTenantId();
/**
* @return the name of the process engine which the deployment should be made to. If null, the "default engine" is used.
*/
public String getProcessEngineName();
/**
* @return a list of process definition resource names that make up the deployment.
*/
public List getProcessResourceNames();
/**
* @return a list of additional properties. See constant property names defined in this class for a list of available properties.
*
* @see #PROP_IS_DELETE_UPON_UNDEPLOY
* @see #PROP_IS_SCAN_FOR_PROCESS_DEFINITIONS
* @see #PROP_RESOURCE_ROOT_PATH
* @see #PROP_IS_DEPLOY_CHANGED_ONLY
*/
public Map getProperties();
}