org.camunda.bpm.engine.repository

Interface DeploymentBuilder

All Known Subinterfaces:

ProcessApplicationDeploymentBuilder

All Known Implementing Classes:

DeploymentBuilderImpl, ProcessApplicationDeploymentBuilderImpl

public interface DeploymentBuilder

Builder for creating new deployments. A builder instance can be obtained through RepositoryService.createDeployment(). Multiple resources can be added to one deployment before calling the deploy() operation. After deploying, no more changes can be made to the returned deployment and the builder instance can be disposed.

Author:

Tom Baeyens, Joram Barrez

Method Summary

Methods

Modifier and Type	Method and Description
DeploymentBuilder	activateProcessDefinitionsOn(Date date) Sets the date on which the process definitions contained in this deployment will be activated.
DeploymentBuilder	addClasspathResource(String resource)
DeploymentBuilder	addInputStream(String resourceName, InputStream inputStream)
DeploymentBuilder	addModelInstance(String resourceName, BpmnModelInstance modelInstance)
DeploymentBuilder	addString(String resourceName, String text)
DeploymentBuilder	addZipInputStream(ZipInputStream zipInputStream)
Deployment	deploy() Deploys all provided sources to the process engine.
DeploymentBuilder	enableDuplicateFiltering() Deprecated.
DeploymentBuilder	enableDuplicateFiltering(boolean deployChangedOnly) Check the resources for duplicates in the set of previous deployments.
Collection<String>	getResourceNames()
DeploymentBuilder	name(String name) Gives the deployment the given name.

Method Detail

addInputStream

DeploymentBuilder addInputStream(String resourceName,
                               InputStream inputStream)

addClasspathResource

DeploymentBuilder addClasspathResource(String resource)

addString

DeploymentBuilder addString(String resourceName,
                          String text)

addModelInstance

DeploymentBuilder addModelInstance(String resourceName,
                                 BpmnModelInstance modelInstance)

addZipInputStream

DeploymentBuilder addZipInputStream(ZipInputStream zipInputStream)

name

DeploymentBuilder name(String name)

Gives the deployment the given name.

enableDuplicateFiltering

@Deprecated
DeploymentBuilder enableDuplicateFiltering()

Deprecated.

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 enableDuplicateFiltering(boolean)

enableDuplicateFiltering

DeploymentBuilder enableDuplicateFiltering(boolean deployChangedOnly)

Check the resources for duplicates in the set of previous deployments. If no resources have changed in this deployment, its contained resources are not deployed at all. For further configuration, use the parameter deployChangedOnly.

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

DeploymentBuilder activateProcessDefinitionsOn(Date date)

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.

deploy

Deployment deploy()

Deploys all provided sources to the process engine.

Throws:

AuthorizationException - If the user has no Permissions.CREATE permission on Resources.DEPLOYMENT.

getResourceNames

Collection<String> getResourceNames()

Returns:

the names of the resources which were added to this builder.