com.communote.server.core.installer

Class CommunoteInstallerImpl

java.lang.Object

com.communote.server.core.installer.CommunoteInstallerImpl

All Implemented Interfaces:

CommunoteInstaller

public class CommunoteInstallerImpl
extends Object
implements CommunoteInstaller

Implementation of the installer.

Author:

Communote GmbH - http://www.communote.com/

Constructor Summary

Constructors

Constructor and Description
CommunoteInstallerImpl(ApplicationInitializer initializer) Create an installer

Method Summary

Modifier and Type	Method and Description
boolean	canConnectToDatabase()
void	createCommunoteAccount(String accountName, String timezoneId) Create the Communote account (aka the global client).
User	getAdminAccount()
ClientTO	getCommunoteAccount()
StartupProperties	getDatabaseSettings()
DatabaseType	getDatabaseType()
DatabaseType	getSupportedDatabaseType(String identifier) Get the database type for the given identifier
List<DatabaseType>	getSupportedDatabaseTypes()
void	initializeApplicationAfterInstallation() Initialize the application if all steps of the installation were completed.
void	initializeCommunoteAccount(UserVO adminAccount, Map<ApplicationProperty,String> params) Initialize the Communote account (aka global client) that was previously created with CommunoteInstaller.createCommunoteAccount(String, String)
boolean	initializeDatabase(DatabaseInitializationStatusCallback statusCallback) Initialize the application database and inform the provided callback about the current status.
boolean	isDatabaseInitialized() Returns whether the global database is initialized, which is the schema exists.
StartupProperties	updateDatabaseSettings(DatabaseType dbType, Map<CoreConfigurationPropertyConstant,String> settings) Update the database settings and return the resulting configuration.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommunoteInstallerImpl

public CommunoteInstallerImpl(ApplicationInitializer initializer)

Create an installer

Parameters:

initializer - the initializer that should be called after successfully initializing the Communote database

Method Detail

canConnectToDatabase

public boolean canConnectToDatabase()

Specified by:

canConnectToDatabase in interface CommunoteInstaller

Returns:

whether it is possible to connect to the database with the current database configuration settings as returned by CommunoteInstaller.getDatabaseSettings()

createCommunoteAccount

public void createCommunoteAccount(String accountName,
                                   String timezoneId)
                            throws InvalidClientIdException,
                                   CommunoteInstallerException

Description copied from interface: CommunoteInstaller

Create the Communote account (aka the global client).

Specified by:

createCommunoteAccount in interface CommunoteInstaller

Parameters:

accountName - the name of the account

timezoneId - the ID of the timezone

Throws:

InvalidClientIdException - in case the configured ID of the global client is not valid

CommunoteInstallerException - in case creating the client failed

getAdminAccount

public User getAdminAccount()

Specified by:

getAdminAccount in interface CommunoteInstaller

Returns:

an existing administrator user or null if there is none yet

getCommunoteAccount

public ClientTO getCommunoteAccount()

Specified by:

getCommunoteAccount in interface CommunoteInstaller

Returns:

the details of the Communote account (aka global client) or null if the account has not been created yet

getDatabaseSettings

public StartupProperties getDatabaseSettings()

Specified by:

getDatabaseSettings in interface CommunoteInstaller

Returns:

the current database connection settings

getDatabaseType

public DatabaseType getDatabaseType()

Specified by:

getDatabaseType in interface CommunoteInstaller

Returns:

the database type of the current database connection settings

getSupportedDatabaseType

public DatabaseType getSupportedDatabaseType(String identifier)

Description copied from interface: CommunoteInstaller

Get the database type for the given identifier

Specified by:

getSupportedDatabaseType in interface CommunoteInstaller

Parameters:

identifier - the identifier of the type

Returns:

the database type or null if there is no matching type

getSupportedDatabaseTypes

public List<DatabaseType> getSupportedDatabaseTypes()

Specified by:

getSupportedDatabaseTypes in interface CommunoteInstaller

Returns:

get a list of supported database types

initializeApplicationAfterInstallation

public void initializeApplicationAfterInstallation()
                                            throws ApplicationInitializationException

Description copied from interface: CommunoteInstaller

Initialize the application if all steps of the installation were completed.

Specified by:

initializeApplicationAfterInstallation in interface CommunoteInstaller

Throws:

ApplicationInitializationException

initializeCommunoteAccount

public void initializeCommunoteAccount(UserVO adminAccount,
                                       Map<ApplicationProperty,String> params)
                                throws EmailValidationException,
                                       ConfigurationInitializationException,
                                       CommunoteInstallerException

Description copied from interface: CommunoteInstaller

Initialize the Communote account (aka global client) that was previously created with CommunoteInstaller.createCommunoteAccount(String, String)

Specified by:

initializeCommunoteAccount in interface CommunoteInstaller

Parameters:

adminAccount - VO with details of the first Communote user with administrative privileges

params - application parameters to initialize the Communote account with

Throws:

EmailValidationException - in case the email address of the administrator user is invalid

ConfigurationInitializationException - in case the provided application parameters caused an error

CommunoteInstallerException - in case the initialization failed

initializeDatabase

public boolean initializeDatabase(DatabaseInitializationStatusCallback statusCallback)

Description copied from interface: CommunoteInstaller

Initialize the application database and inform the provided callback about the current status.

Specified by:

initializeDatabase in interface CommunoteInstaller

Parameters:

statusCallback - the callback to receive status updates

Returns:

true if the initialization succeeded, false otherwise

isDatabaseInitialized

public boolean isDatabaseInitialized()

Description copied from interface: CommunoteInstaller

Returns whether the global database is initialized, which is the schema exists.

Specified by:

isDatabaseInitialized in interface CommunoteInstaller

Returns:

true if the database is initialized

updateDatabaseSettings

public StartupProperties updateDatabaseSettings(DatabaseType dbType,
                                                Map<CoreConfigurationPropertyConstant,String> settings)
                                         throws ConfigurationUpdateException

Description copied from interface: CommunoteInstaller

Update the database settings and return the resulting configuration.

Specified by:

updateDatabaseSettings in interface CommunoteInstaller

Parameters:

dbType - the database type

settings - the settings like host and username for connecting to the database of the given type

Returns:

the new configuration

Throws:

ConfigurationUpdateException - in case the configuration cannot be saved