org.bonitasoft.engine.bpm.bar

Class BusinessArchiveBuilder

java.lang.Object

org.bonitasoft.engine.bpm.bar.BusinessArchiveBuilder

public class BusinessArchiveBuilder
extends Object

Creates BusinessArchive

A typical use of this class is to build programmatically Business archive in order to deploy it using the ProcessAPI

If you wish to deploy a BusinessArchived stored in a .bar file use BusinessArchiveFactory instead.

Usage example:

BusinessArchive businessArchive = BusinessArchiveBuilder().createNewBusinessArchive().setProcessDefinition(processDefinition).done();

Since:

6.0.0

Version:

6.3.5

Author:

Baptiste Mesta, Matthieu Chaffotte, Celine Souchet

Constructor Summary

Constructors

Constructor and Description
BusinessArchiveBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addBarResourceInPath(BarResource resource, String path)
BusinessArchiveBuilder	addClasspathResource(BarResource resource) Add JAR dependencies to the business archive.
BusinessArchiveBuilder	addConnectorImplementation(BarResource resource) Add connector implementation descriptor to the business archive.
BusinessArchiveBuilder	addDocumentResource(BarResource resource) Add document contents in the BusinessArchive
BusinessArchiveBuilder	addExternalResource(BarResource resource) Add resource in the BusinessArchive used by extensions
BusinessArchiveBuilder	addUserFilters(BarResource resource) same as addConnectorImplementation(BarResource) but for UserFilter
BusinessArchiveBuilder	createNewBusinessArchive()
BusinessArchive	done()
ActorMapping	getActorMapping()
BusinessArchiveBuilder	setActorMapping(ActorMapping actorMapping)
BusinessArchiveBuilder	setActorMapping(byte[] xmlContent) Deprecated.
BusinessArchiveBuilder	setFormMappings(FormMappingModel formMappingModel) Set the form mappings Model for this BusinessArchive.
BusinessArchiveBuilder	setParameters(Map<String,String> parameters) Set the parameters values
BusinessArchiveBuilder	setProcessDefinition(DesignProcessDefinition processDefinition) Set the process definition of the BusinessArchive that is currently build

Methods inherited from class java.lang.Object

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

Constructor Detail

BusinessArchiveBuilder

public BusinessArchiveBuilder()

Method Detail

createNewBusinessArchive

public BusinessArchiveBuilder createNewBusinessArchive()

setProcessDefinition

public BusinessArchiveBuilder setProcessDefinition(DesignProcessDefinition processDefinition)

Set the process definition of the BusinessArchive that is currently build

DesignProcessDefinition can be constructed using ProcessDefinitionBuilder

Parameters:

processDefinition -

Returns:

the same BusinessArchiveBuilder in order to chain calls

See Also:

ProcessDefinitionBuilder

setParameters

public BusinessArchiveBuilder setParameters(Map<String,String> parameters)

Set the parameters values

Parameters must also be defined in the ProcessDefinition using ProcessDefinitionBuilder

DesignProcessDefinition can be constructed using ProcessDefinitionBuilder

Parameters:

parameters - the parameters value to use

Returns:

the same BusinessArchiveBuilder in order to chain calls

See Also:

ProcessDefinitionBuilder

addClasspathResource

public BusinessArchiveBuilder addClasspathResource(BarResource resource)

Add JAR dependencies to the business archive.

Everything that is added as classpath resource will be added in the (JAVA) classpath of the process

e.g. if you add a connector in your process add here dependencies the process need to execute it

Parameters:

resource - the BarResource the represent a JAR file

Returns:

the same BusinessArchiveBuilder in order to chain calls

addConnectorImplementation

public BusinessArchiveBuilder addConnectorImplementation(BarResource resource)

Add connector implementation descriptor to the business archive.

This resource must be a connector implementation descriptor file (.impl) and must be compliant to the connector-implementation-descriptor.xsd

A connector definition should also be added in the ProcessDefinition using ProcessDefinitionBuilder.addConnector(String, String, String, org.bonitasoft.engine.bpm.connector.ConnectorEvent) or ActivityDefinitionBuilder.addConnector(String, String, String, org.bonitasoft.engine.bpm.connector.ConnectorEvent)

e.g. if you add a connector in your process add here dependencies the process need to execute it

Parameters:

resource - the BarResource the represent a connector implementation descriptor file

Returns:

the same BusinessArchiveBuilder in order to chain calls

addUserFilters

public BusinessArchiveBuilder addUserFilters(BarResource resource)

same as addConnectorImplementation(BarResource) but for UserFilter

Parameters:

resource -

Returns:

the same BusinessArchiveBuilder in order to chain calls

See Also:

addConnectorImplementation(BarResource)

setActorMapping

@Deprecated
public BusinessArchiveBuilder setActorMapping(byte[] xmlContent)
                                       throws IOException

Deprecated.

Set the actor mapping for this BusinessArchive

The file must be compliant with the xsd actorMapping.xsd The actor mapping specify for each ActorDefinition of the process who it is in the organization.

It is not mandatory to set it in the BusinessArchive, it can be set after the process was deployed using ProcessManagementAPI.addUserToActor(long, long), ProcessManagementAPI.addGroupToActor(long, long), ProcessManagementAPI.addRoleToActor(long, long) or ProcessManagementAPI.addRoleAndGroupToActor(long, long, long)

Parameters:

xmlContent - the xml file content that describe the actor mapping

Returns:

the same BusinessArchiveBuilder in order to chain calls

Throws:

IOException

setFormMappings

public BusinessArchiveBuilder setFormMappings(FormMappingModel formMappingModel)

Set the form mappings Model for this BusinessArchive.

This allows to map tasks and process to internal forms or external pages, so that .

Parameters:

formMappingModel - The model containing the form mappings for this process definition.

Returns:

the same BusinessArchiveBuilder in order to chain calls

addExternalResource

public BusinessArchiveBuilder addExternalResource(BarResource resource)

Add resource in the BusinessArchive used by extensions

Parameters:

resource - the resource to be added in the business archive

Returns:

the same BusinessArchiveBuilder in order to chain calls

addDocumentResource

public BusinessArchiveBuilder addDocumentResource(BarResource resource)

Add document contents in the BusinessArchive

Parameters:

resource -

Returns:

See Also:

ProcessDefinitionBuilder.addDocumentDefinition(String)

addBarResourceInPath

protected void addBarResourceInPath(BarResource resource,
                        String path)

done

public BusinessArchive done()
                     throws InvalidBusinessArchiveFormatException

Returns:

The BusinessArchive

Throws:

InvalidBusinessArchiveFormatException - when the business archive is inconsistent in the current state

getActorMapping

public ActorMapping getActorMapping()

setActorMapping

public BusinessArchiveBuilder setActorMapping(ActorMapping actorMapping)