public interface ProcessApplicationDeploymentBuilder extends DeploymentBuilder
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.
Modifier and Type | Method and Description |
---|---|
ProcessApplicationDeploymentBuilder |
activateProcessDefinitionsOn(Date date)
Sets the date on which the process definitions contained in this deployment
will be activated.
|
ProcessApplicationDeploymentBuilder |
addClasspathResource(String resource) |
ProcessApplicationDeploymentBuilder |
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.
|
ProcessApplicationDeploymentBuilder |
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.
|
ProcessApplicationDeploymentBuilder |
addDeploymentResources(String deploymentId)
All existing resources contained by the given deployment
will be added to the new deployment to re-deploy them.
|
ProcessApplicationDeploymentBuilder |
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.
|
ProcessApplicationDeploymentBuilder |
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.
|
ProcessApplicationDeploymentBuilder |
addInputStream(String resourceName,
InputStream inputStream) |
ProcessApplicationDeploymentBuilder |
addModelInstance(String resourceName,
BpmnModelInstance modelInstance)
Adds a BPMN model to the deployment.
|
ProcessApplicationDeploymentBuilder |
addString(String resourceName,
String text) |
ProcessApplicationDeploymentBuilder |
addZipInputStream(ZipInputStream zipInputStream) |
ProcessApplicationDeployment |
deploy()
Deploys all provided sources to the process engine and returns the created deployment.
|
ProcessApplicationDeploymentBuilder |
enableDuplicateFiltering()
Deprecated.
|
ProcessApplicationDeploymentBuilder |
enableDuplicateFiltering(boolean deployChangedOnly)
Check the resources for duplicates in the set of previous deployments with
same deployment source.
|
ProcessApplicationDeploymentBuilder |
name(String name)
Gives the deployment the given name.
|
ProcessApplicationDeploymentBuilder |
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.
|
ProcessApplicationDeploymentBuilder |
source(String source)
Sets the source of a deployment.
|
addModelInstance, addModelInstance, deployWithResult, getResourceNames, tenantId
ProcessApplicationDeploymentBuilder resumePreviousVersions()
If this method is called, additional registrations will be created for previous versions of the deployment.
ProcessApplicationDeploymentBuilder resumePreviousVersionsBy(String resumePreviousVersionsBy)
resumePreviousVersions()
is set.
resumeByProcessDefinitionKey
- one of the constants from ResumePreviousBy
ResumePreviousBy
,
resumePreviousVersions()
ProcessApplicationDeployment deploy()
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.
deploy
in interface DeploymentBuilder
ProcessApplicationDeploymentBuilder addInputStream(String resourceName, InputStream inputStream)
addInputStream
in interface DeploymentBuilder
ProcessApplicationDeploymentBuilder addClasspathResource(String resource)
addClasspathResource
in interface DeploymentBuilder
ProcessApplicationDeploymentBuilder addString(String resourceName, String text)
addString
in interface DeploymentBuilder
ProcessApplicationDeploymentBuilder addModelInstance(String resourceName, BpmnModelInstance modelInstance)
DeploymentBuilder
addModelInstance
in interface DeploymentBuilder
resourceName
- resource name. See suffix requirements for resource names: DeploymentBuilder
.modelInstance
- model instanceProcessApplicationDeploymentBuilder addZipInputStream(ZipInputStream zipInputStream)
addZipInputStream
in interface DeploymentBuilder
ProcessApplicationDeploymentBuilder name(String name)
DeploymentBuilder
name
in interface DeploymentBuilder
ProcessApplicationDeploymentBuilder nameFromDeployment(String deploymentId)
DeploymentBuilder
nameFromDeployment
in interface DeploymentBuilder
ProcessApplicationDeploymentBuilder source(String source)
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.
source
in interface DeploymentBuilder
@Deprecated ProcessApplicationDeploymentBuilder enableDuplicateFiltering()
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)
enableDuplicateFiltering
in interface DeploymentBuilder
ProcessApplicationDeploymentBuilder enableDuplicateFiltering(boolean deployChangedOnly)
DeploymentBuilder
deployChangedOnly
.enableDuplicateFiltering
in interface DeploymentBuilder
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.ProcessApplicationDeploymentBuilder activateProcessDefinitionsOn(Date date)
DeploymentBuilder
activateProcessDefinitionsOn
in interface DeploymentBuilder
ProcessApplicationDeploymentBuilder addDeploymentResources(String deploymentId)
DeploymentBuilder
addDeploymentResources
in interface DeploymentBuilder
ProcessApplicationDeploymentBuilder addDeploymentResourceById(String deploymentId, String resourceId)
DeploymentBuilder
addDeploymentResourceById
in interface DeploymentBuilder
ProcessApplicationDeploymentBuilder addDeploymentResourcesById(String deploymentId, List<String> resourceIds)
DeploymentBuilder
addDeploymentResourcesById
in interface DeploymentBuilder
ProcessApplicationDeploymentBuilder addDeploymentResourceByName(String deploymentId, String resourceName)
DeploymentBuilder
addDeploymentResourceByName
in interface DeploymentBuilder
ProcessApplicationDeploymentBuilder addDeploymentResourcesByName(String deploymentId, List<String> resourceNames)
DeploymentBuilder
addDeploymentResourcesByName
in interface DeploymentBuilder
Copyright © 2022. All rights reserved.