com.communote.server.api.core.config

Interface ConfigurationManager

All Known Implementing Classes:

ConfigurationPropertiesManager

public interface ConfigurationManager

Manager for accessing and updating configuration

Author:

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

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

Method Detail

deactivateDefaultBlog

void deactivateDefaultBlog()

Deactivates the default blog of the current client.

getApplicationConfigurationProperties

ApplicationConfigurationProperties getApplicationConfigurationProperties()

Returns the current application properties.

Returns:

the application properties

getApplicationConfigurationProperties

ApplicationConfigurationProperties getApplicationConfigurationProperties(boolean forceCacheInvalidation)

Returns the current application properties.

Parameters:

forceCacheInvalidation - true if the cache should be invalidated before fetching

Returns:

the application properties

getClientConfigurationProperties

ClientConfigurationProperties getClientConfigurationProperties()

Returns the client configuration properties of the current client.

Returns:

the client configuration properties

getDatabaseConfiguration

DatabaseConfiguration getDatabaseConfiguration()

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

Returns:

the DatabaseConfiguration to use

getDevelopmentProperties

DevelopmentProperties getDevelopmentProperties()

Returns the development properties of the running instance.

Returns:

the development properties

getStartupProperties

StartupProperties getStartupProperties()

Returns the startup properties.

Returns:

the startup properties

setDatabaseConfigurationFactory

void setDatabaseConfigurationFactory(DatabaseConfigurationFactory databaseConfigurationFactory)

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

Parameters:

databaseConfigurationFactory - the database configuration factory to use

setDefaultBlog

void setDefaultBlog(Blog blog)

Activates the default blog of the current client.

Parameters:

blog - The default blog.

setPrimaryAuthentication

void setPrimaryAuthentication(String externalSystemId,
                              boolean allowDBAuth)
                       throws PrimaryAuthenticationException

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

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

Updates a collection of application configuration properties.

Parameters:

settings - a mapping of the properties to their new value

Throws:

ConfigurationUpdateException - exception.

updateClientConfigurationProperties

void updateClientConfigurationProperties(Map<ClientConfigurationPropertyConstant,String> settings)

Updates a collection of client configuration properties.

Parameters:

settings - a mapping of the properties to their new value

updateClientConfigurationProperty

void updateClientConfigurationProperty(ClientConfigurationPropertyConstant key,
                                       String value)

Updates a client configuration properties.

Parameters:

key - the property to update

value - the new value

updateClientTimeZone

void updateClientTimeZone(String timeZoneId)

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

Parameters:

timeZoneId - the new timezoneId

updateConfluenceConfig

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

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

Parameters:

confluenceAuthConfig - the config

Throws:

AuthorizationException - in case the current user is not client manager

EncryptionException - in case of an encryption exception

PrimaryAuthenticationException - Exception.

updateLdapConfiguration

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

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

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

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

Update the startup properties.

Parameters:

settings - mapping with the new values to be set.

Throws:

ConfigurationUpdateException - in case the update failed

updateStartupProperty

void updateStartupProperty(CoreConfigurationPropertyConstant property,
                           String value)
                    throws ConfigurationUpdateException

Updates a startup property.

Parameters:

property - the property to update

value - the new value

Throws:

ConfigurationUpdateException - in case the update failed