org.bonitasoft.engine.bpm.bar

Class ProcessDefinitionBARContribution

java.lang.Object

org.bonitasoft.engine.bpm.bar.ProcessDefinitionBARContribution

All Implemented Interfaces:

BusinessArchiveContribution

Direct Known Subclasses:

ProcessDefinitionBARContributionExt

public class ProcessDefinitionBARContribution
extends Object
implements BusinessArchiveContribution

Author:

Baptiste Mesta, Matthieu Chaffotte

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROCESS_DEFINITION_XML
static String	PROCESS_INFOS_FILE

Constructor Summary

Constructors

Constructor and Description
ProcessDefinitionBARContribution()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	checkProcessInfos(File barFolder, DesignProcessDefinition processDefinition)
String	convertProcessToXml(DesignProcessDefinition processDefinition)
DesignProcessDefinition	convertXmlToProcess(String content)
DesignProcessDefinition	deserializeProcessDefinition(File file)
protected String	generateInfosFromDefinition(DesignProcessDefinition processDefinition)
protected Marshaller	getMarshaller()
String	getName() Retrieves the BusinessArchiveContribution name
protected String	getProcessInfos(String infos)
boolean	isMandatory() Checks if this BusinessArchiveContribution is mandatory
boolean	readFromBarFolder(BusinessArchive businessArchive, File barFolder) Updates the BusinessArchive with information read from the file system and returns true if the information was successfully read or false otherwise.
void	saveToBarFolder(BusinessArchive businessArchive, File barFolder) Writes the content of the BusinessArchive to the file system
void	serializeProcessDefinition(File barFolder, DesignProcessDefinition processDefinition)

Methods inherited from class java.lang.Object

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

Field Detail

PROCESS_DEFINITION_XML

public static final String PROCESS_DEFINITION_XML

See Also:

Constant Field Values

PROCESS_INFOS_FILE

public static final String PROCESS_INFOS_FILE

See Also:

Constant Field Values

Constructor Detail

ProcessDefinitionBARContribution

public ProcessDefinitionBARContribution()

Method Detail

isMandatory

public boolean isMandatory()

Description copied from interface: BusinessArchiveContribution

Checks if this BusinessArchiveContribution is mandatory

Specified by:

isMandatory in interface BusinessArchiveContribution

Returns:

true if this BusinessArchiveContribution is mandatory; false otherwise

readFromBarFolder

public boolean readFromBarFolder(BusinessArchive businessArchive,
                        File barFolder)
                          throws IOException,
                                 InvalidBusinessArchiveFormatException

Description copied from interface: BusinessArchiveContribution

Updates the BusinessArchive with information read from the file system and returns true if the information was successfully read or false otherwise.

Specified by:

readFromBarFolder in interface BusinessArchiveContribution

Parameters:

businessArchive - the BusinessArchive to be filled with information read from the file system

barFolder - the folder storing the information to be filled in the BusinessArchive

Returns:

true if the information was successfully read from file system; false otherwise.

Throws:

IOException - if a problem occurs when reading information from file system.

InvalidBusinessArchiveFormatException - when the folder from which the information is being read has an invalid format.

See Also:

BusinessArchive

checkProcessInfos

protected void checkProcessInfos(File barFolder,
                     DesignProcessDefinition processDefinition)
                          throws InvalidBusinessArchiveFormatException

Throws:

InvalidBusinessArchiveFormatException

deserializeProcessDefinition

public DesignProcessDefinition deserializeProcessDefinition(File file)
                                                     throws IOException,
                                                            InvalidBusinessArchiveFormatException

Throws:

IOException

InvalidBusinessArchiveFormatException

saveToBarFolder

public void saveToBarFolder(BusinessArchive businessArchive,
                   File barFolder)
                     throws IOException

Description copied from interface: BusinessArchiveContribution

Writes the content of the BusinessArchive to the file system

Specified by:

saveToBarFolder in interface BusinessArchiveContribution

Parameters:

businessArchive - the BusinessArchive containing the information to be stored in the file system

barFolder - the folder where the BusinessArchive information will be stored.

Throws:

IOException - when a problem occurs when the information is being stored in the file system.

serializeProcessDefinition

public void serializeProcessDefinition(File barFolder,
                              DesignProcessDefinition processDefinition)
                                throws IOException

Throws:

IOException

convertProcessToXml

public String convertProcessToXml(DesignProcessDefinition processDefinition)
                           throws IOException

Throws:

IOException

getMarshaller

protected Marshaller getMarshaller()
                            throws JAXBException

Throws:

JAXBException

convertXmlToProcess

public DesignProcessDefinition convertXmlToProcess(String content)
                                            throws IOException

Throws:

IOException

generateInfosFromDefinition

protected String generateInfosFromDefinition(DesignProcessDefinition processDefinition)

getProcessInfos

protected String getProcessInfos(String infos)

getName

public String getName()

Description copied from interface: BusinessArchiveContribution

Retrieves the BusinessArchiveContribution name

Specified by:

getName in interface BusinessArchiveContribution

Returns:

the BusinessArchiveContribution name