org.camunda.bpm.engine.impl.repository

Class ProcessApplicationDeploymentBuilderImpl

java.lang.Object

org.camunda.bpm.engine.impl.repository.DeploymentBuilderImpl

org.camunda.bpm.engine.impl.repository.ProcessApplicationDeploymentBuilderImpl

All Implemented Interfaces:

Serializable, DeploymentBuilder, ProcessApplicationDeploymentBuilder

public class ProcessApplicationDeploymentBuilderImpl
extends DeploymentBuilderImpl
implements ProcessApplicationDeploymentBuilder

Author:

Daniel Meyer

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	isResumePreviousVersions
protected ProcessApplicationReference	processApplicationReference
protected String	resumePreviousVersionsBy

Fields inherited from class org.camunda.bpm.engine.impl.repository.DeploymentBuilderImpl

deployChangedOnly, deployment, deploymentResourcesById, deploymentResourcesByName, deployments, isDuplicateFilterEnabled, nameFromDeployment, processDefinitionsActivationDate, repositoryService

Constructor Summary

Constructors

Constructor and Description
ProcessApplicationDeploymentBuilderImpl(RepositoryServiceImpl repositoryService, ProcessApplicationReference reference)

Method Summary

Modifier and Type	Method and Description
ProcessApplicationDeploymentBuilderImpl	activateProcessDefinitionsOn(Date date) Sets the date on which the process definitions contained in this deployment will be activated.
ProcessApplicationDeploymentBuilderImpl	addClasspathResource(String resource)
ProcessApplicationDeploymentBuilderImpl	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.
ProcessApplicationDeploymentBuilderImpl	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.
ProcessApplicationDeploymentBuilderImpl	addDeploymentResources(String deploymentId) All existing resources contained by the given deployment will be added to the new deployment to re-deploy them.
ProcessApplicationDeploymentBuilderImpl	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.
ProcessApplicationDeploymentBuilderImpl	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.
ProcessApplicationDeploymentBuilderImpl	addInputStream(String resourceName, InputStream inputStream)
ProcessApplicationDeploymentBuilderImpl	addModelInstance(String resourceName, BpmnModelInstance modelInstance) Adds a BPMN model to the deployment.
ProcessApplicationDeploymentBuilderImpl	addString(String resourceName, String text)
ProcessApplicationDeploymentBuilderImpl	addZipInputStream(ZipInputStream zipInputStream)
ProcessApplicationDeployment	deploy() Deploys all provided sources to the process engine and returns the created deployment.
ProcessApplicationDeploymentBuilderImpl	enableDuplicateFiltering() If set, this deployment will be compared to any previous deployment.
ProcessApplicationDeploymentBuilderImpl	enableDuplicateFiltering(boolean deployChangedOnly) Check the resources for duplicates in the set of previous deployments with same deployment source.
ProcessApplicationReference	getProcessApplicationReference()
String	getResumePreviousVersionsBy()
boolean	isResumePreviousVersions()
ProcessApplicationDeploymentBuilderImpl	name(String name) Gives the deployment the given name.
ProcessApplicationDeploymentBuilderImpl	nameFromDeployment(String deploymentId) Sets the deployment id to retrieve the deployment name from it.
ProcessApplicationDeploymentBuilder	resumePreviousVersions() If this method is called, additional registrations will be created for previous versions of the deployment.
ProcessApplicationDeploymentBuilder	resumePreviousVersionsBy(String resumePreviousVersionsBy) This method defines on what additional registrations will be based.
ProcessApplicationDeploymentBuilderImpl	source(String source) Sets the source of a deployment.
ProcessApplicationDeploymentBuilderImpl	tenantId(String tenantId) Sets the tenant id of a deployment.

Methods inherited from class org.camunda.bpm.engine.impl.repository.DeploymentBuilderImpl

addBytes, addModelInstance, addModelInstance, deployWithResult, getDeployment, getDeploymentResourcesById, getDeploymentResourcesByName, getDeployments, getNameFromDeployment, getProcessDefinitionsActivationDate, getResourceNames, isDeployChangedOnly, isDuplicateFilterEnabled

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.camunda.bpm.engine.repository.DeploymentBuilder

addModelInstance, addModelInstance, deployWithResult, getResourceNames

Field Detail

processApplicationReference

protected final ProcessApplicationReference processApplicationReference

isResumePreviousVersions

protected boolean isResumePreviousVersions

resumePreviousVersionsBy

protected String resumePreviousVersionsBy

Constructor Detail

ProcessApplicationDeploymentBuilderImpl

public ProcessApplicationDeploymentBuilderImpl(RepositoryServiceImpl repositoryService,
                                               ProcessApplicationReference reference)

Method Detail

resumePreviousVersions

public ProcessApplicationDeploymentBuilder resumePreviousVersions()

Description copied from interface: ProcessApplicationDeploymentBuilder

If this method is called, additional registrations will be created for previous versions of the deployment.

Specified by:

resumePreviousVersions in interface ProcessApplicationDeploymentBuilder

resumePreviousVersionsBy

public ProcessApplicationDeploymentBuilder resumePreviousVersionsBy(String resumePreviousVersionsBy)

Description copied from interface: ProcessApplicationDeploymentBuilder

This method defines on what additional registrations will be based. The value will only be recognized if ProcessApplicationDeploymentBuilder.resumePreviousVersions() is set.

Specified by:

resumePreviousVersionsBy in interface ProcessApplicationDeploymentBuilder

See Also:

ResumePreviousBy, ProcessApplicationDeploymentBuilder.resumePreviousVersions()

deploy

public 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 the DeploymentBuilder.deployWithResult() method. This method will return an instance of DeploymentWithDefinitions, which contains the information about the successful deployed definitions.

Specified by:

deploy in interface DeploymentBuilder

Specified by:

deploy in interface ProcessApplicationDeploymentBuilder

Overrides:

deploy in class DeploymentBuilderImpl

Returns:

the created deployment

activateProcessDefinitionsOn

public ProcessApplicationDeploymentBuilderImpl activateProcessDefinitionsOn(Date date)

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 interface DeploymentBuilder

Specified by:

activateProcessDefinitionsOn in interface ProcessApplicationDeploymentBuilder

Overrides:

activateProcessDefinitionsOn in class DeploymentBuilderImpl

addInputStream

public ProcessApplicationDeploymentBuilderImpl addInputStream(String resourceName,
                                                              InputStream inputStream)

Specified by:

addInputStream in interface DeploymentBuilder

Specified by:

addInputStream in interface ProcessApplicationDeploymentBuilder

Overrides:

addInputStream in class DeploymentBuilderImpl

addClasspathResource

public ProcessApplicationDeploymentBuilderImpl addClasspathResource(String resource)

Specified by:

addClasspathResource in interface DeploymentBuilder

Specified by:

addClasspathResource in interface ProcessApplicationDeploymentBuilder

Overrides:

addClasspathResource in class DeploymentBuilderImpl

addString

public ProcessApplicationDeploymentBuilderImpl addString(String resourceName,
                                                         String text)

Specified by:

addString in interface DeploymentBuilder

Specified by:

addString in interface ProcessApplicationDeploymentBuilder

Overrides:

addString in class DeploymentBuilderImpl

addModelInstance

public ProcessApplicationDeploymentBuilderImpl addModelInstance(String resourceName,
                                                                BpmnModelInstance modelInstance)

Description copied from interface: DeploymentBuilder

Adds a BPMN model to the deployment.

Specified by:

addModelInstance in interface DeploymentBuilder

Specified by:

addModelInstance in interface ProcessApplicationDeploymentBuilder

Overrides:

addModelInstance in class DeploymentBuilderImpl

Parameters:

resourceName - resource name. See suffix requirements for resource names: DeploymentBuilder.

modelInstance - model instance

Returns:

addZipInputStream

public ProcessApplicationDeploymentBuilderImpl addZipInputStream(ZipInputStream zipInputStream)

Specified by:

addZipInputStream in interface DeploymentBuilder

Specified by:

addZipInputStream in interface ProcessApplicationDeploymentBuilder

Overrides:

addZipInputStream in class DeploymentBuilderImpl

name

public ProcessApplicationDeploymentBuilderImpl name(String name)

Description copied from interface: DeploymentBuilder

Gives the deployment the given name.

Specified by:

name in interface DeploymentBuilder

Specified by:

name in interface ProcessApplicationDeploymentBuilder

Overrides:

name in class DeploymentBuilderImpl

tenantId

public ProcessApplicationDeploymentBuilderImpl tenantId(String tenantId)

Description copied from interface: DeploymentBuilder

Sets the tenant id of a deployment.

Specified by:

tenantId in interface DeploymentBuilder

Overrides:

tenantId in class DeploymentBuilderImpl

nameFromDeployment

public ProcessApplicationDeploymentBuilderImpl nameFromDeployment(String deploymentId)

Description copied from interface: DeploymentBuilder

Sets the deployment id to retrieve the deployment name from it.

Specified by:

nameFromDeployment in interface DeploymentBuilder

Specified by:

nameFromDeployment in interface ProcessApplicationDeploymentBuilder

Overrides:

nameFromDeployment in class DeploymentBuilderImpl

source

public ProcessApplicationDeploymentBuilderImpl source(String 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 interface DeploymentBuilder

Specified by:

source in interface ProcessApplicationDeploymentBuilder

Overrides:

source in class DeploymentBuilderImpl

enableDuplicateFiltering

public ProcessApplicationDeploymentBuilderImpl enableDuplicateFiltering()

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 interface DeploymentBuilder

Specified by:

enableDuplicateFiltering in interface ProcessApplicationDeploymentBuilder

Overrides:

enableDuplicateFiltering in class DeploymentBuilderImpl

enableDuplicateFiltering

public ProcessApplicationDeploymentBuilderImpl enableDuplicateFiltering(boolean deployChangedOnly)

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 parameter deployChangedOnly.

Specified by:

enableDuplicateFiltering in interface DeploymentBuilder

Specified by:

enableDuplicateFiltering in interface ProcessApplicationDeploymentBuilder

Overrides:

enableDuplicateFiltering in class DeploymentBuilderImpl

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.

addDeploymentResources

public ProcessApplicationDeploymentBuilderImpl addDeploymentResources(String deploymentId)

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 interface DeploymentBuilder

Specified by:

addDeploymentResources in interface ProcessApplicationDeploymentBuilder

Overrides:

addDeploymentResources in class DeploymentBuilderImpl

addDeploymentResourceById

public ProcessApplicationDeploymentBuilderImpl 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 interface DeploymentBuilder

Specified by:

addDeploymentResourceById in interface ProcessApplicationDeploymentBuilder

Overrides:

addDeploymentResourceById in class DeploymentBuilderImpl

addDeploymentResourcesById

public ProcessApplicationDeploymentBuilderImpl 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 interface DeploymentBuilder

Specified by:

addDeploymentResourcesById in interface ProcessApplicationDeploymentBuilder

Overrides:

addDeploymentResourcesById in class DeploymentBuilderImpl

addDeploymentResourceByName

public ProcessApplicationDeploymentBuilderImpl 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 interface DeploymentBuilder

Specified by:

addDeploymentResourceByName in interface ProcessApplicationDeploymentBuilder

Overrides:

addDeploymentResourceByName in class DeploymentBuilderImpl

addDeploymentResourcesByName

public ProcessApplicationDeploymentBuilderImpl 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 interface DeploymentBuilder

Specified by:

addDeploymentResourcesByName in interface ProcessApplicationDeploymentBuilder

Overrides:

addDeploymentResourcesByName in class DeploymentBuilderImpl

isResumePreviousVersions

public boolean isResumePreviousVersions()

getProcessApplicationReference

public ProcessApplicationReference getProcessApplicationReference()

getResumePreviousVersionsBy

public String getResumePreviousVersionsBy()