public class BusinessArchiveBuilder extends Object
BusinessArchive
A typical use of this class is to build programatically 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();
Constructor and Description |
---|
BusinessArchiveBuilder() |
public static BusinessArchiveBuilder aBusinessArchive()
public BusinessArchiveBuilder createNewBusinessArchive()
public BusinessArchiveBuilder setProcessDefinition(DesignProcessDefinition processDefinition)
BusinessArchive
that is currently build
DesignProcessDefinition
can be constructed using ProcessDefinitionBuilder
processDefinition
- BusinessArchiveBuilder
in order to chain callsProcessDefinitionBuilder
public BusinessArchiveBuilder setParameters(Map<String,String> parameters)
Parameters must also be defined in the ProcessDefinition
using
ProcessDefinitionBuilder
DesignProcessDefinition
can be
constructed using ProcessDefinitionBuilder
parameters
- the parameters value to useBusinessArchiveBuilder
in order to chain callsProcessDefinitionBuilder
public BusinessArchiveBuilder addClasspathResource(BarResource resource)
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
resource
- the BarResource
the represent a JAR fileBusinessArchiveBuilder
in order to chain callspublic BusinessArchiveBuilder addConnectorImplementation(BarResource resource)
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
resource
- the BarResource
the represent a connector implementation descriptor fileBusinessArchiveBuilder
in order to chain callspublic BusinessArchiveBuilder addUserFilters(BarResource resource)
addConnectorImplementation(BarResource)
but for UserFilter
resource
- BusinessArchiveBuilder
in order to chain callsaddConnectorImplementation(BarResource)
@Deprecated public BusinessArchiveBuilder setActorMapping(byte[] xmlContent) throws IOException
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)
xmlContent
- the xml file content that describe the actor mappingBusinessArchiveBuilder
in order to chain callsIOException
public BusinessArchiveBuilder setFormMappings(FormMappingModel formMappingModel)
BusinessArchive
.
This allows to map tasks and process to internal forms or external pages, so that .
formMappingModel
- The model containing the form mappings for this process definition.BusinessArchiveBuilder
in order to chain callspublic BusinessArchiveBuilder addExternalResource(BarResource resource)
BusinessArchive
used by extensionsresource
- the resource to be added in the business archiveBusinessArchiveBuilder
in order to chain callspublic BusinessArchiveBuilder addDocumentResource(BarResource resource)
BusinessArchive
resource
- ProcessDefinitionBuilder.addDocumentDefinition(String)
protected void addBarResourceInPath(BarResource resource, String path)
public BusinessArchive done() throws InvalidBusinessArchiveFormatException
InvalidBusinessArchiveFormatException
- when the business archive is inconsistent in the current statepublic ActorMapping getActorMapping()
public BusinessArchiveBuilder setActorMapping(ActorMapping actorMapping)
Copyright © 2018 Bonitasoft S.A.. All rights reserved.