org.bonitasoft.engine.platform.impl

Class PlatformServiceImpl

java.lang.Object

org.bonitasoft.engine.platform.impl.PlatformServiceImpl

All Implemented Interfaces:

PlatformService

public class PlatformServiceImpl
extends java.lang.Object
implements PlatformService

Author:

Charles Souillard, Celine Souchet

Constructor Summary

Constructors

Constructor and Description
PlatformServiceImpl(PersistenceService platformPersistenceService, PlatformRetriever platformRetriever, Recorder recorder, TechnicalLoggerService logger, PlatformCacheService platformCacheService, SPlatformProperties sPlatformProperties, javax.sql.DataSource datasource, java.util.List<java.lang.String> sqlFolders)

Method Summary

Modifier and Type	Method and Description
boolean	activateTenant(long tenantId) Set status of the tenant into activated
long	createTenant(STenant tenant) insert a new row in the Tenant table case 1 - create tenants tables if not already exists + insert rows where necessary (sequences for example) + insert default users (defined in configuration) case 2 - create tenants tables + insert rows where necessary (sequences for example) + insert default users (defined in configuration)
void	deactiveTenant(long tenantId) Set status of the tenant into deactivated
void	deleteTenant(long tenantId) case 1 - Remove tenant specific tenant tables if no mor etenant in the db case 2 - Remove tenant specific tables
void	deleteTenantObjects(long tenantId) Remove all rows from all tables where the tenantId matches
protected void	executeSQLResource(java.lang.String sqlFile, java.util.Map<java.lang.String,java.lang.String> replacements)
protected void	executeSQLResources(java.util.List<java.lang.String> sqlFiles)
protected void	executeSQLResources(java.util.List<java.lang.String> sqlFiles, java.util.Map<java.lang.String,java.lang.String> replacements)
STenant	getDefaultTenant() Get default tenant
int	getNumberOfTenants() Get the total number of sTenants
long	getNumberOfTenants(QueryOptions options) Return a number of tenants by the given conditions, as one part of SearchResult that is search method's return value in platformApi
SPlatform	getPlatform() Retrieve the platform from the cache No need to be in a transaction
SPlatformProperties	getSPlatformProperties() Return the platform properties
STenant	getTenant(long id) Get tenant by its id
STenant	getTenantByName(java.lang.String name) Get tenant by its name
java.util.List<STenant>	getTenants(java.util.Collection<java.lang.Long> ids, QueryOptions queryOptions) Get tenants which ids belong to given collection
java.util.List<STenant>	getTenants(QueryOptions queryOptions) Get all tenants
boolean	isDefaultTenantCreated() Is the default tenant already created?
boolean	isPlatformCreated() Return true if the platform is created, else return false.
java.util.List<STenant>	searchTenants(QueryOptions options) Return a list of tenants by the given conditions, as one part of SearchResult that is search method's return value in platformApi
void	updateTenant(STenant tenant, EntityUpdateDescriptor descriptor) Update a sTenant from given sTenant and new content.

Methods inherited from class java.lang.Object

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

Constructor Detail

PlatformServiceImpl

public PlatformServiceImpl(PersistenceService platformPersistenceService,
                           PlatformRetriever platformRetriever,
                           Recorder recorder,
                           TechnicalLoggerService logger,
                           PlatformCacheService platformCacheService,
                           SPlatformProperties sPlatformProperties,
                           javax.sql.DataSource datasource,
                           java.util.List<java.lang.String> sqlFolders)

Method Detail

executeSQLResources

protected void executeSQLResources(java.util.List<java.lang.String> sqlFiles)
                            throws java.io.IOException,
                                   java.sql.SQLException

Parameters:

sqlFiles - the sql files to execute

Throws:

java.sql.SQLException

java.io.IOException

executeSQLResources

protected void executeSQLResources(java.util.List<java.lang.String> sqlFiles,
                                   java.util.Map<java.lang.String,java.lang.String> replacements)
                            throws java.io.IOException,
                                   java.sql.SQLException

Parameters:

sqlFiles - the sql files to execute

Throws:

java.sql.SQLException

java.io.IOException

executeSQLResource

protected void executeSQLResource(java.lang.String sqlFile,
                                  java.util.Map<java.lang.String,java.lang.String> replacements)
                           throws java.io.IOException,
                                  java.sql.SQLException

Parameters:

sqlFile - the sql file to execute

Throws:

java.io.IOException

java.sql.SQLException

createTenant

public long createTenant(STenant tenant)
                  throws STenantCreationException,
                         STenantAlreadyExistException

Description copied from interface: PlatformService

insert a new row in the Tenant table case 1 - create tenants tables if not already exists + insert rows where necessary (sequences for example) + insert default users (defined in configuration) case 2 - create tenants tables + insert rows where necessary (sequences for example) + insert default users (defined in configuration)

Specified by:

createTenant in interface PlatformService

Parameters:

tenant - sTenant

Returns:

id of new created tenant

Throws:

STenantCreationException - occurs when an exception is thrown during sTenant creation

STenantAlreadyExistException - occurs when the sTenant has already been taken

deleteTenant

public void deleteTenant(long tenantId)
                  throws STenantDeletionException,
                         STenantNotFoundException,
                         SDeletingActivatedTenantException

Description copied from interface: PlatformService

case 1 - Remove tenant specific tenant tables if no mor etenant in the db case 2 - Remove tenant specific tables

Specified by:

deleteTenant in interface PlatformService

Throws:

STenantDeletionException - occurs when an exception is thrown during sTenant deletion

STenantNotFoundException - occurs when the identifier does not refer to an existing sTenant

SDeletingActivatedTenantException - occurs when an exception is thrown during deleting an activated sTenant

deleteTenantObjects

public void deleteTenantObjects(long tenantId)
                         throws STenantDeletionException,
                                STenantNotFoundException,
                                SDeletingActivatedTenantException

Description copied from interface: PlatformService

Remove all rows from all tables where the tenantId matches

Specified by:

deleteTenantObjects in interface PlatformService

Throws:

STenantDeletionException

STenantNotFoundException

SDeletingActivatedTenantException

getPlatform

public SPlatform getPlatform()
                      throws SPlatformNotFoundException

Description copied from interface: PlatformService

Retrieve the platform from the cache No need to be in a transaction

Specified by:

getPlatform in interface PlatformService

Returns:

sPlatform

Throws:

SPlatformNotFoundException - occurs when the identifier does not refer to an existing sPlatform

getTenant

public STenant getTenant(long id)
                  throws STenantNotFoundException

Description copied from interface: PlatformService

Get tenant by its id

Specified by:

getTenant in interface PlatformService

Parameters:

id - tenant id

Returns:

sTenant

Throws:

STenantNotFoundException - occurs when the identifier does not refer to an existing sTenant

isPlatformCreated

public boolean isPlatformCreated()

Description copied from interface: PlatformService

Return true if the platform is created, else return false.

Specified by:

isPlatformCreated in interface PlatformService

Returns:

true or false

getTenantByName

public STenant getTenantByName(java.lang.String name)
                        throws STenantNotFoundException

Description copied from interface: PlatformService

Get tenant by its name

Specified by:

getTenantByName in interface PlatformService

Parameters:

name - tenant's name

Returns:

sTenant

Throws:

STenantNotFoundException - occurs when the identifier does not refer to an existing sTenant

getDefaultTenant

public STenant getDefaultTenant()
                         throws STenantNotFoundException

Description copied from interface: PlatformService

Get default tenant

Specified by:

getDefaultTenant in interface PlatformService

Returns:

sTenant

Throws:

STenantNotFoundException - occurs when the identifier does not refer to an existing sTenant

isDefaultTenantCreated

public boolean isDefaultTenantCreated()
                               throws SBonitaReadException

Description copied from interface: PlatformService

Is the default tenant already created?

Specified by:

isDefaultTenantCreated in interface PlatformService

Returns:

true if the default tenant exists, false otherwise.

Throws:

SBonitaReadException - when we cannot determine if default tenant is created

getTenants

public java.util.List<STenant> getTenants(java.util.Collection<java.lang.Long> ids,
                                          QueryOptions queryOptions)
                                   throws STenantNotFoundException,
                                          STenantException

Description copied from interface: PlatformService

Get tenants which ids belong to given collection

Specified by:

getTenants in interface PlatformService

Parameters:

ids - a collection of ids

queryOptions - The criterion used to search tenants

Returns:

a list of sTenant

Throws:

STenantNotFoundException - occurs when the identifier does not refer to an existing sTenant

STenantException

updateTenant

public void updateTenant(STenant tenant,
                         EntityUpdateDescriptor descriptor)
                  throws STenantUpdateException

Description copied from interface: PlatformService

Update a sTenant from given sTenant and new content.

Specified by:

updateTenant in interface PlatformService

Parameters:

tenant - sTenant

descriptor - new content

Throws:

STenantUpdateException - occurs when an exception is thrown during sTenant update

activateTenant

public boolean activateTenant(long tenantId)
                       throws STenantNotFoundException,
                              STenantActivationException

Description copied from interface: PlatformService

Set status of the tenant into activated

Specified by:

activateTenant in interface PlatformService

Throws:

STenantNotFoundException - occurs when the identifier does not refer to an existing sTenant

STenantActivationException - occurs when an exception is thrown during activating sTenant

deactiveTenant

public void deactiveTenant(long tenantId)
                    throws STenantNotFoundException,
                           STenantDeactivationException

Description copied from interface: PlatformService

Set status of the tenant into deactivated

Specified by:

deactiveTenant in interface PlatformService

Throws:

STenantNotFoundException - occurs when the identifier does not refer to an existing sTenant

STenantDeactivationException - occurs when an exception is thrown during deactivating sTenant

getTenants

public java.util.List<STenant> getTenants(QueryOptions queryOptions)
                                   throws STenantException

Description copied from interface: PlatformService

Get all tenants

Specified by:

getTenants in interface PlatformService

Parameters:

queryOptions - The criterion used to search tenants

Returns:

a list of sTenant

Throws:

STenantException

getNumberOfTenants

public int getNumberOfTenants()
                       throws STenantException

Description copied from interface: PlatformService

Get the total number of sTenants

Specified by:

getNumberOfTenants in interface PlatformService

Returns:

the total number of sTenants

Throws:

STenantException

searchTenants

public java.util.List<STenant> searchTenants(QueryOptions options)
                                      throws SBonitaReadException

Description copied from interface: PlatformService

Return a list of tenants by the given conditions, as one part of SearchResult that is search method's return value in platformApi

Specified by:

searchTenants in interface PlatformService

Returns:

a list of tenants by the given conditions

Throws:

SBonitaReadException

getNumberOfTenants

public long getNumberOfTenants(QueryOptions options)
                        throws SBonitaReadException

Description copied from interface: PlatformService

Return a number of tenants by the given conditions, as one part of SearchResult that is search method's return value in platformApi

Specified by:

getNumberOfTenants in interface PlatformService

Returns:

a number of tenants by the given conditions

Throws:

SBonitaReadException

getSPlatformProperties

public SPlatformProperties getSPlatformProperties()

Description copied from interface: PlatformService

Return the platform properties

Specified by:

getSPlatformProperties in interface PlatformService

Returns:

The platform properties