public interface PlatformAPI
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.
Modifier and Type | Method and Description |
---|---|
void |
cleanAndDeletePlaftorm()
Deprecated.
since 6.5.0 (typo in method name). Use
cleanPlatform() instead. |
void |
cleanAndDeletePlatform()
Deprecated.
since 7.3.0. Use
cleanPlatform() instead. |
void |
cleanPlatform()
Clean the platform.
|
void |
createAndInitializePlatform()
Deprecated.
since 7.3.0. Use
initializePlatform() instead. |
void |
createPlatform()
Deprecated.
since 7.3.0. Use
initializePlatform() instead. |
void |
deletePlatform()
Deprecated.
since 7.3.0. Use
cleanPlatform() instead. |
Map<String,byte[]> |
getClientPlatformConfigurations()
INTERNAL USE ONLY
get client configuration files of the platform
|
byte[] |
getClientTenantConfiguration(long tenantId,
String file)
INTERNAL USE ONLY
get client auto login configuration file for tenant
|
Map<Long,Map<String,byte[]>> |
getClientTenantConfigurations()
INTERNAL USE ONLY
get client configuration files of the tenants
|
Platform |
getPlatform()
Get the platform.
|
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 |
boolean |
isNodeStarted()
Is the current node started?
|
boolean |
isPlatformCreated()
Check if the platform created or not.
|
boolean |
isPlatformInitialized()
Check if the default tenant is created or not.
|
void |
rescheduleErroneousTriggers()
Reschedules triggers which are in error state.
|
void |
startNode()
Starts the node.
|
void |
stopNode()
Stops the node.
|
void |
updateClientTenantConfigurationFile(long tenantId,
String file,
byte[] content)
INTERNAL USE ONLY
update a single client configuration file of the tenant
|
@Deprecated void createPlatform() throws CreationException
initializePlatform()
instead.The platform creation is done in 3 steps:
InvalidSessionException
- occurs if the API session is invalid, e.g session has expired.CreationException
- occurs when an exception is thrown during platform creationvoid initializePlatform() throws CreationException
InvalidSessionException
- occurs if the API session is invalid, e.g session has expired.CreationException
- occurs when an exception is thrown during platform creation@Deprecated void createAndInitializePlatform() throws CreationException
initializePlatform()
instead.createPlatform()
and initializePlatform()
InvalidSessionException
- occurs if the API session is invalid, e.g session has expired.CreationException
- occurs when an exception is thrown during platform creationcreatePlatform()
,
initializePlatform()
void startNode() throws StartNodeException
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.
InvalidSessionException
- occurs if API Session is invalid, e.g session has expired.StartNodeException
- occurs when an exception is thrown during the activation of the nodevoid stopNode() throws StopNodeException
The node is the currently Java Virtual Machine on which Bonita Engine is running
Stopping the node make the Scheduler service to stop.
InvalidSessionException
- occurs if API Session is invalid, e.g session has expired.StopNodeException
- occurs when an exception is thrown during the stop of the nodevoid cleanPlatform() throws DeletionException
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()
InvalidSessionException
- Generic exception thrown if API Session is invalid, e.g session has expired.DeletionException
- occurs when an exception is thrown during platform deletioninitializePlatform()
@Deprecated void deletePlatform() throws DeletionException
cleanPlatform()
instead.This method delete the platform, i.e. all the database tables.
InvalidSessionException
- Generic exception thrown if API Session is invalid, e.g session has expired.DeletionException
- occurs when an exception is thrown during platform deletioncreatePlatform()
@Deprecated void cleanAndDeletePlaftorm() throws DeletionException
cleanPlatform()
instead.InvalidSessionException
- Generic exception thrown if API Session is invalid, e.g session has expired.DeletionException
- occurs when an exception is thrown during platform deletioncleanPlatform()
,
deletePlatform()
@Deprecated void cleanAndDeletePlatform() throws DeletionException
cleanPlatform()
instead.InvalidSessionException
- Generic exception thrown if API Session is invalid, e.g session has expired.DeletionException
- occurs when an exception is thrown during platform deletioncleanPlatform()
,
deletePlatform()
Platform getPlatform() throws PlatformNotFoundException
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 platformboolean isPlatformInitialized() throws PlatformNotFoundException
PlatformNotFoundException
- when the default tenant existence cannot be determinedboolean isPlatformCreated() throws PlatformNotFoundException
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 platformPlatformState getPlatformState() throws PlatformNotFoundException
PlatformState.STARTED
or PlatformState.STOPPED
depending on the scheduler stateInvalidSessionException
- Generic exception thrown if API Session is invalid, e.g session has expired.PlatformNotFoundException
- occurs when the identifier does not refer to an existing platformboolean isNodeStarted()
void rescheduleErroneousTriggers() throws UpdateException
UpdateException
- If an exception occurs during the schedulingMap<String,byte[]> getClientPlatformConfigurations()
Map<Long,Map<String,byte[]>> getClientTenantConfigurations()
byte[] getClientTenantConfiguration(long tenantId, String file)
void updateClientTenantConfigurationFile(long tenantId, String file, byte[] content) throws UpdateException
tenantId
- tenant to updatefile
- file name to updatecontent
- the new content of the fileUpdateException
Copyright © 2018 Bonitasoft S.A.. All rights reserved.