org.flowable.app.api.repository

Interface AppDeploymentBuilder

public interface AppDeploymentBuilder

Builder for creating new deployments, similar to the bpmn deployment builder. A builder instance can be obtained through AppRepositoryService.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:

Tijs Rademakers, Joram Barrez

Method Summary

Modifier and Type	Method and Description
AppDeploymentBuilder	addBytes(String resourceName, byte[] bytes)
AppDeploymentBuilder	addClasspathResource(String resource)
AppDeploymentBuilder	addInputStream(String resourceName, InputStream inputStream)
AppDeploymentBuilder	addString(String resourceName, String text)
AppDeploymentBuilder	addZipInputStream(ZipInputStream zipInputStream)
AppDeploymentBuilder	category(String category) Gives the deployment the given category.
AppDeployment	deploy() Deploys all provided sources to the CMMN engine.
AppDeploymentBuilder	disableSchemaValidation() If called, no XML schema validation against the XSD.
AppDeploymentBuilder	enableDuplicateFiltering() If set, this deployment will be compared to any previous deployment.
AppDeploymentBuilder	key(String key) Gives the deployment the given key.
AppDeploymentBuilder	name(String name) Gives the deployment the given name.
AppDeploymentBuilder	tenantId(String tenantId) Gives the deployment the given tenant id.

Method Detail

addInputStream

AppDeploymentBuilder addInputStream(String resourceName,
                                    InputStream inputStream)

addClasspathResource

AppDeploymentBuilder addClasspathResource(String resource)

addString

AppDeploymentBuilder addString(String resourceName,
                               String text)

addBytes

AppDeploymentBuilder addBytes(String resourceName,
                              byte[] bytes)

addZipInputStream

AppDeploymentBuilder addZipInputStream(ZipInputStream zipInputStream)

disableSchemaValidation

AppDeploymentBuilder disableSchemaValidation()

If called, no XML schema validation against the XSD. Not recommended in general.

name

AppDeploymentBuilder name(String name)

Gives the deployment the given name.

category

AppDeploymentBuilder category(String category)

Gives the deployment the given category.

key

AppDeploymentBuilder key(String key)

Gives the deployment the given key.

tenantId

AppDeploymentBuilder tenantId(String tenantId)

Gives the deployment the given tenant id.

enableDuplicateFiltering

AppDeploymentBuilder enableDuplicateFiltering()

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.

deploy

AppDeployment deploy()

Deploys all provided sources to the CMMN engine.