org.bonitasoft.platform.configuration

Interface ConfigurationService

All Known Implementing Classes:

ConfigurationServiceImpl

public interface ConfigurationService

Give access to Bonita BPM Platform configuration. Is used by setup mechanism to retrieve configuration before running the Engine + Portal, on a system that does give access to a persistent filesystem.

Author:

Emmanuel Duchastenier

Method Summary

Methods

Modifier and Type	Method and Description
void	deleteAllConfiguration() Delete all configuration and license files
void	deleteTenantConfiguration(long tenantId) Delete all configuration files for a tenant
List<BonitaConfiguration>	getLicenses() Retrieves all license files stored in database.
List<BonitaConfiguration>	getPlatformEngineConf() Retrieves the platform configuration at platform level.
List<BonitaConfiguration>	getPlatformInitEngineConf() Retrieves the platform configuration at platform-init level.
List<BonitaConfiguration>	getPlatformPortalConf() Retrieves the portal configuration at platform-level.
List<BonitaConfiguration>	getTenantEngineConf(long tenantId) Retrieves the engine tenant configuration for a tenant
List<BonitaConfiguration>	getTenantPortalConf(long tenantId) Retrieves the portal configuration for a tenant
BonitaConfiguration	getTenantPortalConfiguration(long tenantId, String file) Retrieves a portal configuration file for a tenant
List<BonitaConfiguration>	getTenantSecurityScripts(long tenantId) Retrieves the security scripts for a tenant
List<BonitaConfiguration>	getTenantTemplateEngineConf() Retrieves the platform configuration for tenant template
List<BonitaConfiguration>	getTenantTemplatePortalConf() Retrieves the portal template configuration for a tenant
List<BonitaConfiguration>	getTenantTemplateSecurityScripts() Retrieves the security script configuration for tenant template
void	storeAllConfiguration(File configurationRootFolder) store whole configuration files for engine and portal, excluding licenses files
void	storeLicenses(File licensesFolder) read licensesFolder for license files sub-folders are ignored each *.lic file is stored in database
void	storePlatformConfiguration(File configurationRootFolder) store platform configuration files for engine
void	storePlatformEngineConf(List<BonitaConfiguration> bonitaConfigurations) store platform configuration file in database
void	storePlatformInitEngineConf(List<BonitaConfiguration> bonitaConfigurations) store platform init configuration file in database
void	storePlatformPortalConf(List<BonitaConfiguration> bonitaConfigurations) store platform configuration files for portal
void	storeTenantConfiguration(File configurationRootFolder, long tenantId) Read configuration files located under configuration root folder each file is stored in database
void	storeTenantEngineConf(List<BonitaConfiguration> bonitaConfigurations, long tenantId) store tenant configuration file in database
void	storeTenantPortalConf(List<BonitaConfiguration> bonitaConfigurations, long tenantId) store tenant configuration files for portal
void	storeTenantSecurityScripts(List<BonitaConfiguration> bonitaConfigurations, long tenantId) store security script for a tenant
void	storeTenantTemplateEngineConf(List<BonitaConfiguration> bonitaConfigurations) store tenant template configuration file in database
void	storeTenantTemplatePortalConf(List<BonitaConfiguration> bonitaConfigurations) store tenant template configuration files for portal
void	storeTenantTemplateSecurityScripts(List<BonitaConfiguration> bonitaConfigurations) store tenant template security scripts
void	writeAllConfigurationToFolder(File configurationFolder, File licenseFolder) write all configuration files directory structure : .

Method Detail

getPlatformPortalConf

List<BonitaConfiguration> getPlatformPortalConf()

Retrieves the portal configuration at platform-level.

Returns:

a list of BonitaConfiguration that represents each file

getPlatformInitEngineConf

List<BonitaConfiguration> getPlatformInitEngineConf()

Retrieves the platform configuration at platform-init level.

Returns:

a list of BonitaConfiguration that represents each file

getPlatformEngineConf

List<BonitaConfiguration> getPlatformEngineConf()

Retrieves the platform configuration at platform level.

Returns:

a list of BonitaConfiguration that represents each file

getTenantTemplateEngineConf

List<BonitaConfiguration> getTenantTemplateEngineConf()

Retrieves the platform configuration for tenant template

Returns:

a list of BonitaConfiguration that represents each file

getTenantTemplateSecurityScripts

List<BonitaConfiguration> getTenantTemplateSecurityScripts()

Retrieves the security script configuration for tenant template

Returns:

a list of BonitaConfiguration that represents each file

getTenantEngineConf

List<BonitaConfiguration> getTenantEngineConf(long tenantId)

Retrieves the engine tenant configuration for a tenant

Parameters:

tenantId - tenant identifier

Returns:

a list of BonitaConfiguration that represents each file

getTenantSecurityScripts

List<BonitaConfiguration> getTenantSecurityScripts(long tenantId)

Retrieves the security scripts for a tenant

Parameters:

tenantId - tenant identifier

Returns:

a list of BonitaConfiguration that represents each file

storePlatformInitEngineConf

void storePlatformInitEngineConf(List<BonitaConfiguration> bonitaConfigurations)

store platform init configuration file in database

Parameters:

bonitaConfigurations - list of files

storePlatformEngineConf

void storePlatformEngineConf(List<BonitaConfiguration> bonitaConfigurations)

store platform configuration file in database

Parameters:

bonitaConfigurations - list of files

storeTenantTemplateEngineConf

void storeTenantTemplateEngineConf(List<BonitaConfiguration> bonitaConfigurations)

store tenant template configuration file in database

Parameters:

bonitaConfigurations - list of files

storeTenantTemplateSecurityScripts

void storeTenantTemplateSecurityScripts(List<BonitaConfiguration> bonitaConfigurations)

store tenant template security scripts

Parameters:

bonitaConfigurations - list of files

storeTenantEngineConf

void storeTenantEngineConf(List<BonitaConfiguration> bonitaConfigurations,
                         long tenantId)

store tenant configuration file in database

Parameters:

bonitaConfigurations - list of files

tenantId - tenant identifier

storeTenantSecurityScripts

void storeTenantSecurityScripts(List<BonitaConfiguration> bonitaConfigurations,
                              long tenantId)

store security script for a tenant

Parameters:

bonitaConfigurations - list of files

tenantId - tenant identifier

storeTenantTemplatePortalConf

void storeTenantTemplatePortalConf(List<BonitaConfiguration> bonitaConfigurations)

store tenant template configuration files for portal

Parameters:

bonitaConfigurations - list of files

storeTenantPortalConf

void storeTenantPortalConf(List<BonitaConfiguration> bonitaConfigurations,
                         long tenantId)

store tenant configuration files for portal

Parameters:

bonitaConfigurations - list of files

tenantId -

storePlatformPortalConf

void storePlatformPortalConf(List<BonitaConfiguration> bonitaConfigurations)

store platform configuration files for portal

Parameters:

bonitaConfigurations - list of files

getTenantTemplatePortalConf

List<BonitaConfiguration> getTenantTemplatePortalConf()

Retrieves the portal template configuration for a tenant

Returns:

list of files

getTenantPortalConf

List<BonitaConfiguration> getTenantPortalConf(long tenantId)

Retrieves the portal configuration for a tenant

Parameters:

tenantId -

Returns:

list of files

getTenantPortalConfiguration

BonitaConfiguration getTenantPortalConfiguration(long tenantId,
                                               String file)

Retrieves a portal configuration file for a tenant

Parameters:

tenantId -

file -

Returns:

file

storeTenantConfiguration

void storeTenantConfiguration(File configurationRootFolder,
                            long tenantId)
                              throws PlatformException

Read configuration files located under configuration root folder each file is stored in database

Parameters:

configurationRootFolder - root folder containing configuration files

tenantId - tenant key

Throws:

PlatformException

storePlatformConfiguration

void storePlatformConfiguration(File configurationRootFolder)
                                throws PlatformException

store platform configuration files for engine

Parameters:

configurationRootFolder - root folder containing configuration files

Throws:

PlatformException

storeAllConfiguration

void storeAllConfiguration(File configurationRootFolder)
                           throws PlatformException

store whole configuration files for engine and portal, excluding licenses files

Parameters:

configurationRootFolder - list of files

Throws:

PlatformException

writeAllConfigurationToFolder

void writeAllConfigurationToFolder(File configurationFolder,
                                 File licenseFolder)
                                   throws PlatformException

write all configuration files directory structure : . ├── platform_engine ├── platform_init_engine ├── platform_portal ├── tenant_template_engine ├── tenant_template_portal └── tenant_template_security_scripts

Parameters:

configurationFolder -

licenseFolder -

Throws:

PlatformException

storeLicenses

void storeLicenses(File licensesFolder)
                   throws PlatformException

read licensesFolder for license files sub-folders are ignored each *.lic file is stored in database

Parameters:

licensesFolder -

Throws:

PlatformException

getLicenses

List<BonitaConfiguration> getLicenses()
                                      throws PlatformException

Retrieves all license files stored in database.

Returns:

a list of BonitaConfiguration that represents each license file

Throws:

PlatformException

deleteTenantConfiguration

void deleteTenantConfiguration(long tenantId)

Delete all configuration files for a tenant

Parameters:

tenantId - the tenant id.

Throws:

IllegalArgumentException - when tenantId value is out of range (<= 0 )

deleteAllConfiguration

void deleteAllConfiguration()

Delete all configuration and license files