Package org.camunda.bpm.application.impl.metadata.spi

Interface ProcessArchiveXml

  • All Known Implementing Classes:
    ProcessArchiveXmlImpl
    public interface ProcessArchiveXml

    Java API representation of a ProcessArchive definition inside a processes.xml file

    Author:
    Daniel Meyer, Ronny Bräunlich

    • Field Detail

      • PROP_IS_DELETE_UPON_UNDEPLOY

        static final String PROP_IS_DELETE_UPON_UNDEPLOY
        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.
        See Also:
        Constant Field Values

      • PROP_IS_SCAN_FOR_PROCESS_DEFINITIONS

        static final String PROP_IS_SCAN_FOR_PROCESS_DEFINITIONS
        Indicates whether the classloader should be scanned for process definitions.
        See Also:
        Constant Field Values

      • PROP_IS_RESUME_PREVIOUS_VERSIONS

        static final String PROP_IS_RESUME_PREVIOUS_VERSIONS
        Indicates whether old versions of the deployment should be resumed. If this property is not set, the default value is used: true.
        See Also:
        Constant Field Values

      • PROP_RESUME_PREVIOUS_BY

        static final String PROP_RESUME_PREVIOUS_BY
        Indicates which previous deployments should be resumed by this deployment. Can be any of the options in ResumePreviousBy.
        See Also:
        Constant Field Values

      • PROP_IS_DEPLOY_CHANGED_ONLY

        static final String PROP_IS_DEPLOY_CHANGED_ONLY
        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.
        See Also:
        Constant Field Values

      • PROP_RESOURCE_ROOT_PATH

        static final String PROP_RESOURCE_ROOT_PATH

        The resource root of the proccess archive. This property is used when scanning for process definitions (if 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.

        See Also:
        Constant Field Values

      • PROP_ADDITIONAL_RESOURCE_SUFFIXES

        static final String PROP_ADDITIONAL_RESOURCE_SUFFIXES
        A semicolon separated list of additional suffixes for resources to scan for.
        See Also:
        Constant Field Values

      • PROP_ADDITIONAL_RESOURCE_SUFFIXES_SEPARATOR

        static final String PROP_ADDITIONAL_RESOURCE_SUFFIXES_SEPARATOR
        See Also:
        Constant Field Values

    • Method Detail

      • getName

        String getName()
        Returns:
        the name of the process archive. Must not be null.

      • getTenantId

        String getTenantId()
        Returns:
        the id of the tenant the resources of the process archive should deploy for. Can be null.

      • getProcessEngineName

        String getProcessEngineName()
        Returns:
        the name of the process engine which the deployment should be made to. If null, the "default engine" is used.

      • getProcessResourceNames

        List<String> getProcessResourceNames()
        Returns:
        a list of process definition resource names that make up the deployment.