org.bonitasoft.engine.api

Interface PlatformAPI

public interface PlatformAPI

Manage the platform.

The platform is the base on which runs the engine.
It mainly handles the creation of tables in database and also allow to start/stop a Node which is the current Virtual machine on which runs the engine. There is only one platform for a running Bonita Engine.

Author:

Elias Ricken de Medeiros, Lu Kai, Zhang Bole, Matthieu Chaffotte

Method Summary

Methods

Modifier and Type	Method and Description
void	cleanAndDeletePlaftorm() Clean and delete a platform.
void	cleanPlatform() Clean the platform.
void	createAndInitializePlatform() Utilitary method that call createPlatform() and initializePlatform()
void	createPlatform() Create the platform.
void	deletePlatform() Delete the platform
Platform	getPlatform() Deprecated.
PlatformState	getPlatformState() Get the state of the platform of the current node
void	initializePlatform() Initialize the platform. The running environment of Bonita Engine is initialized and marked as activated. Business elements linked to the execution are initialized, after this step the technical user will be able to connect to the engine and to import the organization.
boolean	isPlatformCreated() Check if the platform created or not.
void	startNode() Starts the node.
void	stopNode() Stops the node.

Method Detail

createPlatform

void createPlatform()
                    throws CreationException

Create the platform.

The platform creation is done in 3 steps:

• Creation of the persistence structure: tables are created
• Initialization of persistence structure: index are added, default values and so on
• The platform state is persisted

Throws:

InvalidSessionException - occurs if the API session is invalid, e.g session has expired.

CreationException - occurs when an exception is thrown during platform creation

initializePlatform

void initializePlatform()
                        throws CreationException

Initialize the platform. The running environment of Bonita Engine is initialized and marked as activated.
Business elements linked to the execution are initialized, after this step the technical user will be able to connect to the engine and to import the organization. No user are created by default and the default username/password to connect to the Bonita Engine are stored in the file bonita-server.xml that is in the Bonita home.

Throws:

InvalidSessionException - occurs if the API session is invalid, e.g session has expired.

CreationException - occurs when an exception is thrown during platform creation

createAndInitializePlatform

void createAndInitializePlatform()
                                 throws CreationException

Utilitary method that call createPlatform() and initializePlatform()

Throws:

InvalidSessionException - occurs if the API session is invalid, e.g session has expired.

CreationException - occurs when an exception is thrown during platform creation

See Also:

createPlatform(), initializePlatform()

startNode

void startNode()
               throws StartNodeException

Starts the node.

The node is the currently Java Virtual Machine on which Bonita Engine is running

Starting the node make the Scheduler service to start and restart elements that were not finished by the Work service on the previous shutdown.

Throws:

InvalidSessionException - occurs if API Session is invalid, e.g session has expired.

StartNodeException - occurs when an exception is thrown during the activation of the node

stopNode

void stopNode()
              throws StopNodeException

Stops the node.

The node is the currently Java Virtual Machine on which Bonita Engine is running

Stopping the node make the Scheduler service to stop.

Throws:

InvalidSessionException - occurs if API Session is invalid, e.g session has expired.

StopNodeException - occurs when an exception is thrown during the stop of the node

cleanPlatform

void cleanPlatform()
                   throws DeletionException

Clean the platform.

Empty all execution informations, i.e. database tables are cleaned and a new execution environment can be initialized.

/!\Please remember that all data will be DELETED/!\

This method does the opposite of initializePlatform()

Throws:

InvalidSessionException - Generic exception thrown if API Session is invalid, e.g session has expired.

DeletionException - occurs when an exception is thrown during platform deletion

See Also:

initializePlatform()

deletePlatform

void deletePlatform()
                    throws DeletionException

Delete the platform

This method delete the platform, i.e. all the database tables.

Throws:

InvalidSessionException - Generic exception thrown if API Session is invalid, e.g session has expired.

DeletionException - occurs when an exception is thrown during platform deletion

See Also:

createPlatform()

cleanAndDeletePlaftorm

void cleanAndDeletePlaftorm()
                            throws DeletionException

Clean and delete a platform.

Throws:

InvalidSessionException - Generic exception thrown if API Session is invalid, e.g session has expired.

DeletionException - occurs when an exception is thrown during platform deletion

See Also:

cleanPlatform(), deletePlatform()

getPlatform

@Deprecated
Platform getPlatform()
                     throws PlatformNotFoundException

Deprecated.

Get the platform.

Returns:

the Platform object

Throws:

InvalidSessionException - Generic exception thrown if API Session is invalid, e.g session has expired.

PlatformNotFoundException - occurs when the identifier does not refer to an existing platform

isPlatformCreated

boolean isPlatformCreated()
                          throws PlatformNotFoundException

Check if the platform created or not.

Returns:

true if the platform existed

Throws:

InvalidSessionException - Generic exception thrown if API Session is invalid, e.g session has expired.

PlatformNotFoundException - occurs when the identifier does not refer to an existing platform

getPlatformState

PlatformState getPlatformState()
                               throws PlatformNotFoundException

Get the state of the platform of the current node

Returns:

PlatformState.STARTED or PlatformState.STOPPED depending on the scheduler state

Throws:

InvalidSessionException - Generic exception thrown if API Session is invalid, e.g session has expired.

PlatformNotFoundException - occurs when the identifier does not refer to an existing platform