com.communote.server.api.core.installer

Interface CommunoteInstaller

All Known Implementing Classes:

CommunoteInstallerImpl

public interface CommunoteInstaller

Helper to install Communote. The methods should be called in the following order

• updateDatabaseSettings(DatabaseType, Map)
• initializeDatabase(DatabaseInitializationStatusCallback)
• createCommunoteAccount(String, String)
• initializeCommunoteAccount(UserVO, Map)
• initializeApplicationAfterInstallation()

Author:

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

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 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 type, Map<CoreConfigurationPropertyConstant,String> settings) Update the database settings and return the resulting configuration.

Method Detail

canConnectToDatabase

boolean canConnectToDatabase()

Returns:

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

createCommunoteAccount

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

Create the Communote account (aka the global client).

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

User getAdminAccount()

Returns:

an existing administrator user or null if there is none yet

getCommunoteAccount

ClientTO getCommunoteAccount()

Returns:

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

getDatabaseSettings

StartupProperties getDatabaseSettings()

Returns:

the current database connection settings

getDatabaseType

DatabaseType getDatabaseType()

Returns:

the database type of the current database connection settings

getSupportedDatabaseType

DatabaseType getSupportedDatabaseType(String identifier)

Get the database type for the given identifier

Parameters:

identifier - the identifier of the type

Returns:

the database type or null if there is no matching type

getSupportedDatabaseTypes

List<DatabaseType> getSupportedDatabaseTypes()

Returns:

get a list of supported database types

initializeApplicationAfterInstallation

void initializeApplicationAfterInstallation()
                                     throws BootstrapException

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

Throws:

BootstrapException - in case not all steps of the installation were completed

initializeCommunoteAccount

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

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

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

boolean initializeDatabase(DatabaseInitializationStatusCallback statusCallback)

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

Parameters:

statusCallback - the callback to receive status updates

Returns:

true if the initialization succeeded, false otherwise

isDatabaseInitialized

boolean isDatabaseInitialized()

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

Returns:

true if the database is initialized

updateDatabaseSettings

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

Update the database settings and return the resulting configuration.

Parameters:

type - 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