org.bonitasoft.engine.bpm.bar

Class BusinessArchive

java.lang.Object

org.bonitasoft.engine.bpm.bar.BusinessArchive

All Implemented Interfaces:

Serializable

public class BusinessArchive
extends Object
implements Serializable

Represents the content of a BusinessArchive file (*.bar). It contains the DesignProcessDefinition and all resources necessary to the process execution.

Author:

Baptiste Mesta, Matthieu Chaffotte

See Also:

DesignProcessDefinition, Serialized Form

Constructor Summary

Constructors

Constructor and Description
BusinessArchive() Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addResource(String resourcePath, byte[] resourceData) Adds a resource to this BusinessArchive
ActorMapping	getActorMapping()
FormMappingModel	getFormMappingModel() Retrieves the form mapping model for this BusinessArchive.
Map<String,String>	getParameters() Retrieves the BusinessArchive parameters
DesignProcessDefinition	getProcessDefinition() Retrieves the related DesignProcessDefinition
byte[]	getResource(String resourcePath) Retrieves a byte array representing the content of the resource identified by the given path.
Map<String,byte[]>	getResources() Retrieves a Map containing all resources of this BusinessArchive.
Map<String,byte[]>	getResources(String regex) Retrieves a Map representing the resources having paths matching with the given regular expression.
void	setActorMapping(ActorMapping actorMapping)
void	setFormMappings(FormMappingModel formMappingModel) Sets the task-to-form (or process-to-form) mapping in this BusinessArchive.
void	setParameters(Map<String,String> parameters) Defines the BusinessArchive parameters
void	setProcessDefinition(DesignProcessDefinition processDefinition) Defines the related DesignProcessDefinition

Methods inherited from class java.lang.Object

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

Constructor Detail

BusinessArchive

public BusinessArchive()

Default constructor. Creates an instance of BusinessArchive

Method Detail

getActorMapping

public ActorMapping getActorMapping()

setActorMapping

public void setActorMapping(ActorMapping actorMapping)

getProcessDefinition

public DesignProcessDefinition getProcessDefinition()

Retrieves the related DesignProcessDefinition

Returns:

the related DesignProcessDefinition

See Also:

DesignProcessDefinition

setProcessDefinition

public void setProcessDefinition(DesignProcessDefinition processDefinition)

Defines the related DesignProcessDefinition

Parameters:

processDefinition - the related DesignProcessDefinition

See Also:

DesignProcessDefinition

getParameters

public Map<String,String> getParameters()

Retrieves the BusinessArchive parameters

Returns:

the BusinessArchive parameters

setParameters

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

Defines the BusinessArchive parameters

Parameters:

parameters - the BusinessArchive parameters

getResource

public byte[] getResource(String resourcePath)

Retrieves a byte array representing the content of the resource identified by the given path.

Example:

 businessArchive.getResource("actorMapping.xml")
 

Parameters:

resourcePath - the complete resource path

Returns:

a byte array representing the content of the resource identified by the given path.

getResources

public Map<String,byte[]> getResources(String regex)

Retrieves a Map representing the resources having paths matching with the given regular expression. The Map keys store the resource paths and the Map values store the resource content.

Example:

 businessArchive.getResources("^classpath/.*$")
 

Parameters:

regex - the regular expression used to match the resource path

Returns:

a Map representing the resources having paths matching with the given regular expression

addResource

protected void addResource(String resourcePath,
               byte[] resourceData)

Adds a resource to this BusinessArchive

Parameters:

resourcePath - the complete resource path. It must contain the full path and filename

resourceData - the byte array representing the resource content

getResources

public Map<String,byte[]> getResources()

Retrieves a Map containing all resources of this BusinessArchive. The Map keys store the resource full paths and the Map values store the resource content.

Returns:

a Map containing all resources of this BusinessArchive

setFormMappings

public void setFormMappings(FormMappingModel formMappingModel)

Sets the task-to-form (or process-to-form) mapping in this BusinessArchive.

Parameters:

formMappingModel - the model to store.

getFormMappingModel

public FormMappingModel getFormMappingModel()

Retrieves the form mapping model for this BusinessArchive.

Returns:

the form mapping model for this BusinessArchive.