Interface ProcessApplicationDeploymentBuilder
- All Superinterfaces:
DeploymentBuilder
- All Known Implementing Classes:
ProcessApplicationDeploymentBuilderImpl
Builder for a ProcessApplication
deployment
A process application deployment is different from a regular deployment.
Besides deploying a set of process definitions to the database,
this deployment has the additional side effect that the process application
is registered for the deployment. This means that the process engine will exeute
all process definitions contained in the deployment in the context of the process
application (by calling the process application's
ProcessApplicationInterface.execute(java.util.concurrent.Callable)
method.
- Author:
- Daniel Meyer
-
Method Summary
Modifier and TypeMethodDescriptionSets the date on which the process definitions contained in this deployment will be activated.addClasspathResource
(String resource) addDeploymentResourceById
(String deploymentId, String resourceId) A given resource specified by id and deployment id will be added to the new deployment to re-deploy the given resource.addDeploymentResourceByName
(String deploymentId, String resourceName) A given resource specified by name and deployment id will be added to the new deployment to re-deploy the given resource.addDeploymentResources
(String deploymentId) All existing resources contained by the given deployment will be added to the new deployment to re-deploy them.addDeploymentResourcesById
(String deploymentId, List<String> resourceIds) All given resources specified by id and deployment id will be added to the new deployment to re-deploy the given resource.addDeploymentResourcesByName
(String deploymentId, List<String> resourceNames) All given resources specified by name and deployment id will be added to the new deployment to re-deploy the given resource.addInputStream
(String resourceName, InputStream inputStream) addModelInstance
(String resourceName, BpmnModelInstance modelInstance) Adds a BPMN model to the deployment.addZipInputStream
(ZipInputStream zipInputStream) deploy()
Deploys all provided sources to the process engine and returns the created deployment.Deprecated.enableDuplicateFiltering
(boolean deployChangedOnly) Check the resources for duplicates in the set of previous deployments with same deployment source.Gives the deployment the given name.nameFromDeployment
(String deploymentId) Sets the deployment id to retrieve the deployment name from it.If this method is called, additional registrations will be created for previous versions of the deployment.resumePreviousVersionsBy
(String resumePreviousVersionsBy) This method defines on what additional registrations will be based.Sets the source of a deployment.Methods inherited from interface org.camunda.bpm.engine.repository.DeploymentBuilder
addModelInstance, addModelInstance, deployWithResult, getResourceNames, tenantId
-
Method Details
-
resumePreviousVersions
ProcessApplicationDeploymentBuilder resumePreviousVersions()If this method is called, additional registrations will be created for previous versions of the deployment.
-
resumePreviousVersionsBy
This method defines on what additional registrations will be based. The value will only be recognized ifresumePreviousVersions()
is set.- Parameters:
resumeByProcessDefinitionKey
- one of the constants fromResumePreviousBy
- See Also:
-
deploy
ProcessApplicationDeployment deploy()Description copied from interface:DeploymentBuilder
Deploys all provided sources to the process engine and returns the created deployment.
The returned
Deployment
instance has no information about the definitions, which are deployed with that deployment. To access this information you can use theDeploymentBuilder.deployWithResult()
method. This method will return an instance ofDeploymentWithDefinitions
, which contains the information about the successful deployed definitions.- Specified by:
deploy
in interfaceDeploymentBuilder
- Returns:
- the created deployment
-
addInputStream
- Specified by:
addInputStream
in interfaceDeploymentBuilder
-
addClasspathResource
- Specified by:
addClasspathResource
in interfaceDeploymentBuilder
-
addString
- Specified by:
addString
in interfaceDeploymentBuilder
-
addModelInstance
ProcessApplicationDeploymentBuilder addModelInstance(String resourceName, BpmnModelInstance modelInstance) Description copied from interface:DeploymentBuilder
Adds a BPMN model to the deployment.- Specified by:
addModelInstance
in interfaceDeploymentBuilder
- Parameters:
resourceName
- resource name. See suffix requirements for resource names: .modelInstance
- model instance- Returns:
-
addZipInputStream
- Specified by:
addZipInputStream
in interfaceDeploymentBuilder
-
name
Description copied from interface:DeploymentBuilder
Gives the deployment the given name.- Specified by:
name
in interfaceDeploymentBuilder
-
nameFromDeployment
Description copied from interface:DeploymentBuilder
Sets the deployment id to retrieve the deployment name from it.- Specified by:
nameFromDeployment
in interfaceDeploymentBuilder
-
source
Description copied from interface:DeploymentBuilder
Sets the source of a deployment.
Furthermore if duplicate check of deployment resources is enabled (by calling
DeploymentBuilder.enableDuplicateFiltering(boolean)
) then only previous deployments with the same given source are considered to perform the duplicate check.- Specified by:
source
in interfaceDeploymentBuilder
-
enableDuplicateFiltering
Deprecated.Description copied from interface:DeploymentBuilder
If set, this deployment will be compared to any previous deployment. This means that every (non-generated) resource will be compared with the provided resources of this deployment. If any resource of this deployment is different to the existing resources, all resources are re-deployed.
Deprecated: use
DeploymentBuilder.enableDuplicateFiltering(boolean)
- Specified by:
enableDuplicateFiltering
in interfaceDeploymentBuilder
-
enableDuplicateFiltering
Description copied from interface:DeploymentBuilder
Check the resources for duplicates in the set of previous deployments with same deployment source. If no resources have changed in this deployment, its contained resources are not deployed at all. For further configuration, use the parameterdeployChangedOnly
.- Specified by:
enableDuplicateFiltering
in interfaceDeploymentBuilder
- Parameters:
deployChangedOnly
- determines whether only those resources should be deployed that have changed from the previous versions of the deployment. If false, all of the resources are re-deployed if any resource differs.
-
activateProcessDefinitionsOn
Description copied from interface:DeploymentBuilder
Sets the date on which the process definitions contained in this deployment will be activated. This means that all process definitions will be deployed as usual, but they will be suspended from the start until the given activation date.- Specified by:
activateProcessDefinitionsOn
in interfaceDeploymentBuilder
-
addDeploymentResources
Description copied from interface:DeploymentBuilder
All existing resources contained by the given deployment will be added to the new deployment to re-deploy them.- Specified by:
addDeploymentResources
in interfaceDeploymentBuilder
-
addDeploymentResourceById
ProcessApplicationDeploymentBuilder addDeploymentResourceById(String deploymentId, String resourceId) Description copied from interface:DeploymentBuilder
A given resource specified by id and deployment id will be added to the new deployment to re-deploy the given resource.- Specified by:
addDeploymentResourceById
in interfaceDeploymentBuilder
-
addDeploymentResourcesById
ProcessApplicationDeploymentBuilder addDeploymentResourcesById(String deploymentId, List<String> resourceIds) Description copied from interface:DeploymentBuilder
All given resources specified by id and deployment id will be added to the new deployment to re-deploy the given resource.- Specified by:
addDeploymentResourcesById
in interfaceDeploymentBuilder
-
addDeploymentResourceByName
ProcessApplicationDeploymentBuilder addDeploymentResourceByName(String deploymentId, String resourceName) Description copied from interface:DeploymentBuilder
A given resource specified by name and deployment id will be added to the new deployment to re-deploy the given resource.- Specified by:
addDeploymentResourceByName
in interfaceDeploymentBuilder
-
addDeploymentResourcesByName
ProcessApplicationDeploymentBuilder addDeploymentResourcesByName(String deploymentId, List<String> resourceNames) Description copied from interface:DeploymentBuilder
All given resources specified by name and deployment id will be added to the new deployment to re-deploy the given resource.- Specified by:
addDeploymentResourcesByName
in interfaceDeploymentBuilder
-