org.bonitasoft.engine.api

Interface TenantAdministrationAPI

public interface TenantAdministrationAPI

This API gives access to tenant administration tasks.

Author:

Matthieu Chaffotte, Baptiste Mesta

Method Summary

Modifier and Type	Method and Description
void	cleanAndUninstallBusinessDataModel() Deletes all business data and uninstalls the business data model.
TenantResource	getBusinessDataModelResource() Retrieves the BDM resource, as a tenant-level resource.
String	getBusinessDataModelVersion() Returns the current Business Data Model version, if any, or null if no Business Data Model is currently deployed.
byte[]	getClientBDMZip()
String	installBusinessDataModel(byte[] zip) Installs a new business data model.
boolean	isPaused()
void	pause() Pause the tenant so nothing is executed anymore.
void	resume() Resume the tenant to a normal state after a pause.
void	uninstallBusinessDataModel() Uninstalls the business data model.

Method Detail

isPaused

boolean isPaused()

Returns:

true if the tenant is paused.

pause

void pause()
    throws UpdateException

Pause the tenant so nothing is executed anymore. when the tenant is paused: Only technical user can login when the tenant is paused. All users connected are disconnected (apart from the technical user). Only IdentityAPI, ThemeAPI and ProfileAPI are accessible.

Throws:

UpdateException - if the tenant cannot be paused.

resume

void resume()
     throws UpdateException

Resume the tenant to a normal state after a pause.

Throws:

UpdateException - if the tenant cannot be resumed.

installBusinessDataModel

String installBusinessDataModel(byte[] zip)
                         throws InvalidBusinessDataModelException,
                                BusinessDataRepositoryDeploymentException

Installs a new business data model.

Parameters:

zip - the binary content of the business object model.

Returns:

the version of the Business Data Model just deployed.

Throws:

InvalidBusinessDataModelException - if the Business Data Model content passed as parameter is invalid.

BusinessDataRepositoryDeploymentException - if the deployment cannot be fulfilled completely.

uninstallBusinessDataModel

void uninstallBusinessDataModel()
                         throws BusinessDataRepositoryDeploymentException

Uninstalls the business data model.

Throws:

BusinessDataRepositoryDeploymentException - if the deployment cannot be fulfilled completely.

cleanAndUninstallBusinessDataModel

void cleanAndUninstallBusinessDataModel()
                                 throws BusinessDataRepositoryDeploymentException

Deletes all business data and uninstalls the business data model.

Throws:

BusinessDataRepositoryDeploymentException - if the deployment cannot be fulfilled completely.

getClientBDMZip

byte[] getClientBDMZip()
                throws BusinessDataRepositoryException

Returns:

zip content of the deployed client Business data model, null if no Business data model has been deployed

Throws:

BusinessDataRepositoryException - if the Business Data Model cannot be retrieved.

getBusinessDataModelVersion

String getBusinessDataModelVersion()
                            throws BusinessDataRepositoryException

Returns the current Business Data Model version, if any, or null if no Business Data Model is currently deployed.

Returns:

the current Business Data Model version, if any, or null if no Business Data Model is currently deployed

Throws:

BusinessDataRepositoryException - if the BDM version cannot be retrieved properly.

getBusinessDataModelResource

TenantResource getBusinessDataModelResource()

Retrieves the BDM resource, as a tenant-level resource. Or NONE if no BDM is installed.

Returns:

a TenantResource representing the current BDM on the current tenant, or TenantResource.NONE if no BDM is installed.

Since:

7.7