com.communote.server.core.config

Class ConfigurationPropertiesManager

java.lang.Object

com.communote.server.core.config.ConfigurationPropertiesManager

All Implemented Interfaces:

ConfigurationManager

public class ConfigurationPropertiesManager
extends Object
implements ConfigurationManager

Manages the different configuration properties.

Author:

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

Constructor Summary

Constructors

Constructor and Description
ConfigurationPropertiesManager(String applicationRealPath) Creates and initializes a new instance of the configuration properties manager.

Method Summary

Modifier and Type	Method and Description
void	deactivateDefaultBlog() Deactivates the default blog of the current client.
ApplicationConfigurationProperties	getApplicationConfigurationProperties() Returns the current application properties.
ApplicationConfigurationProperties	getApplicationConfigurationProperties(boolean forceCacheInvalidation) Returns the current application properties.
ClientConfigurationProperties	getClientConfigurationProperties() Returns the client configuration properties of the current client.
DatabaseConfiguration	getDatabaseConfiguration() Return the DatabaseConfiguration that is created by a DatabaseConfigurationFactory.
DevelopmentProperties	getDevelopmentProperties() Returns the development properties of the running instance.
StartupProperties	getStartupProperties() Returns the startup properties.
void	setDatabaseConfigurationFactory(DatabaseConfigurationFactory databaseConfigurationFactory) Set the factory for creating the database configuration when ConfigurationManager.getDatabaseConfiguration() is called.
void	setDefaultBlog(Blog blog) Activates the default blog of the current client.
void	setPrimaryAuthentication(String externalSystemId, boolean allowDBAuth)
void	updateApplicationConfigurationProperties(Map<ApplicationConfigurationPropertyConstant,String> settings) Updates a collection of application configuration properties.
void	updateClientConfigurationProperties(Map<ClientConfigurationPropertyConstant,String> settings) Updates a collection of client configuration properties.
void	updateClientConfigurationProperty(ClientConfigurationPropertyConstant key, String value) Updates a client configuration properties.
void	updateClientTimeZone(String timeZoneId) Update the client timezone and reload the cache.
void	updateConfluenceConfig(ConfluenceConfiguration confluenceAuthConfig) Update the Confluence authentication and reload the cache.
void	updateLdapConfiguration(LdapConfiguration ldapConfig) Update the LDAP authentication and reload the cache.
void	updateStartupProperties(Map<CoreConfigurationPropertyConstant,String> settings) Update the startup properties.
void	updateStartupProperty(CoreConfigurationPropertyConstant property, String value) Updates a startup property.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurationPropertiesManager

public ConfigurationPropertiesManager(String applicationRealPath)

Creates and initializes a new instance of the configuration properties manager. A ConfigurationInitializationException will be thrown if the initialization of the manager failed.

Parameters:

applicationRealPath - the file system path to the web application which will be used to load some configuration files

Method Detail

deactivateDefaultBlog

public void deactivateDefaultBlog()

Description copied from interface: ConfigurationManager

Deactivates the default blog of the current client.

Specified by:

deactivateDefaultBlog in interface ConfigurationManager

getApplicationConfigurationProperties

public ApplicationConfigurationProperties getApplicationConfigurationProperties()

Description copied from interface: ConfigurationManager

Returns the current application properties.

Specified by:

getApplicationConfigurationProperties in interface ConfigurationManager

Returns:

the application properties

getApplicationConfigurationProperties

public ApplicationConfigurationProperties getApplicationConfigurationProperties(boolean forceCacheInvalidation)

Description copied from interface: ConfigurationManager

Returns the current application properties.

Specified by:

getApplicationConfigurationProperties in interface ConfigurationManager

Parameters:

forceCacheInvalidation - true if the cache should be invalidated before fetching

Returns:

the application properties

getClientConfigurationProperties

public ClientConfigurationProperties getClientConfigurationProperties()

Description copied from interface: ConfigurationManager

Returns the client configuration properties of the current client.

Specified by:

getClientConfigurationProperties in interface ConfigurationManager

Returns:

the client configuration properties

getDatabaseConfiguration

public DatabaseConfiguration getDatabaseConfiguration()

Description copied from interface: ConfigurationManager

Return the DatabaseConfiguration that is created by a DatabaseConfigurationFactory. If no factory was set with ConfigurationManager.setDatabaseConfigurationFactory(DatabaseConfigurationFactory) null will be returned. The configuration will only created once if this method is called after the installation has been completed.

Specified by:

getDatabaseConfiguration in interface ConfigurationManager

Returns:

the DatabaseConfiguration to use

getDevelopmentProperties

public DevelopmentProperties getDevelopmentProperties()

Description copied from interface: ConfigurationManager

Returns the development properties of the running instance.

Specified by:

getDevelopmentProperties in interface ConfigurationManager

Returns:

the development properties

getStartupProperties

public StartupProperties getStartupProperties()

Description copied from interface: ConfigurationManager

Returns the startup properties.

Specified by:

getStartupProperties in interface ConfigurationManager

Returns:

the startup properties

setDatabaseConfigurationFactory

public void setDatabaseConfigurationFactory(DatabaseConfigurationFactory databaseConfigurationFactory)

Description copied from interface: ConfigurationManager

Set the factory for creating the database configuration when ConfigurationManager.getDatabaseConfiguration() is called.

Specified by:

setDatabaseConfigurationFactory in interface ConfigurationManager

Parameters:

databaseConfigurationFactory - the database configuration factory to use

setDefaultBlog

public void setDefaultBlog(Blog blog)

Description copied from interface: ConfigurationManager

Activates the default blog of the current client.

Specified by:

setDefaultBlog in interface ConfigurationManager

Parameters:

blog - The default blog.

setPrimaryAuthentication

public void setPrimaryAuthentication(String externalSystemId,
                                     boolean allowDBAuth)
                              throws PrimaryAuthenticationException

Specified by:

setPrimaryAuthentication in interface ConfigurationManager

Parameters:

externalSystemId - The id of the external system. If this is null, the current authentication method will be removed.

allowDBAuth - True, if internal database authentication is allowed.

Throws:

PrimaryAuthenticationException - Exception.

updateApplicationConfigurationProperties

public void updateApplicationConfigurationProperties(Map<ApplicationConfigurationPropertyConstant,String> settings)
                                              throws ConfigurationUpdateException

Description copied from interface: ConfigurationManager

Updates a collection of application configuration properties.

Specified by:

updateApplicationConfigurationProperties in interface ConfigurationManager

Parameters:

settings - a mapping of the properties to their new value

Throws:

ConfigurationUpdateException - exception.

updateClientConfigurationProperties

public void updateClientConfigurationProperties(Map<ClientConfigurationPropertyConstant,String> settings)

Description copied from interface: ConfigurationManager

Updates a collection of client configuration properties.

Specified by:

updateClientConfigurationProperties in interface ConfigurationManager

Parameters:

settings - a mapping of the properties to their new value

updateClientConfigurationProperty

public void updateClientConfigurationProperty(ClientConfigurationPropertyConstant key,
                                              String value)

Description copied from interface: ConfigurationManager

Updates a client configuration properties.

Specified by:

updateClientConfigurationProperty in interface ConfigurationManager

Parameters:

key - the property to update

value - the new value

updateClientTimeZone

public void updateClientTimeZone(String timeZoneId)

Description copied from interface: ConfigurationManager

Update the client timezone and reload the cache.
Forwards to ConfigurationManagement.updateClientTimeZoneId(String)

Specified by:

updateClientTimeZone in interface ConfigurationManager

Parameters:

timeZoneId - the new timezoneId

updateConfluenceConfig

public void updateConfluenceConfig(ConfluenceConfiguration confluenceAuthConfig)
                            throws EncryptionException,
                                   AuthorizationException,
                                   PrimaryAuthenticationException

Description copied from interface: ConfigurationManager

Update the Confluence authentication and reload the cache. Forwards to ConfigurationManagement.updateConfluenceAuthConfig(ConfluenceConfiguration)

Specified by:

updateConfluenceConfig in interface ConfigurationManager

Parameters:

confluenceAuthConfig - the config

Throws:

EncryptionException - in case of an encryption exception

AuthorizationException - in case the current user is not client manager

PrimaryAuthenticationException - Exception.

updateLdapConfiguration

public void updateLdapConfiguration(LdapConfiguration ldapConfig)
                             throws AuthorizationException,
                                    EncryptionException,
                                    PrimaryAuthenticationException

Description copied from interface: ConfigurationManager

Update the LDAP authentication and reload the cache.
Forwards to ConfigurationManagement.updateLdapConfiguration(LdapConfiguration)

Specified by:

updateLdapConfiguration in interface ConfigurationManager

Parameters:

ldapConfig - the config

Throws:

AuthorizationException - in case the current user is not client manager

EncryptionException - in case of an encryption exception

PrimaryAuthenticationException - Exception.

updateStartupProperties

public void updateStartupProperties(Map<CoreConfigurationPropertyConstant,String> settings)
                             throws ConfigurationUpdateException

Description copied from interface: ConfigurationManager

Update the startup properties.

Specified by:

updateStartupProperties in interface ConfigurationManager

Parameters:

settings - mapping with the new values to be set.

Throws:

ConfigurationUpdateException - in case the update failed

updateStartupProperty

public void updateStartupProperty(CoreConfigurationPropertyConstant property,
                                  String value)
                           throws ConfigurationUpdateException

Description copied from interface: ConfigurationManager

Updates a startup property.

Specified by:

updateStartupProperty in interface ConfigurationManager

Parameters:

property - the property to update

value - the new value

Throws:

ConfigurationUpdateException - in case the update failed