com.communote.server.core

Interface ConfigurationManagement

All Known Implementing Classes:

ConfigurationManagementBase, ConfigurationManagementImpl

public interface ConfigurationManagement

Handling configurations

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CONFLUENCE_SYSTEM_ID DEFAULT_CONFLUENCE_SYSTEM_ID.
static String	DEFAULT_DATABASE_ID DEFAULT_DATABASE_ID.
static String	DEFAULT_LDAP_SYSTEM_ID Deprecated. Use LdapUserRepository#EXTERNAL_SYSTEM_ID_DEFAULT_LDAP where possible. All LDAP specifics should be moved to the ldap plugin.

Method Summary

Modifier and Type	Method and Description
Collection<ApplicationConfigurationSetting>	getApplicationConfigurationSettings()
ImageVO	getClientLogo()
Configuration	getConfiguration()
Blog	getDefaultBlog() Gets the default blog.
void	removeClientLogo()
void	setPrimaryAuthentication(String externalSystemId, boolean allowDBAuth, String currentPrimaryAuthentication)
void	updateApplicationSettings(Map<ApplicationConfigurationPropertyConstant,String> settings) Updates or creates the provided application settings.
void	updateClientLogo(byte[] image) Updates the client logo.
void	updateClientSetting(ClientConfigurationPropertyConstant key, String value) Update the given setting using the key and value.
void	updateClientSettings(Map<ClientConfigurationPropertyConstant,String> settings) Updates or creates the provided client configuration settings.
void	updateClientTimeZoneId(String timeZoneId)
void	updateConfluenceAuthConfig(ConfluenceConfiguration confluenceAuthConf) Updates or creates the confluence authentication configuration
void	updateDefaultBlog(Blog blog) Updates the default blog.
void	updateLdapConfiguration(LdapConfiguration ldapConfig)

Field Detail

DEFAULT_CONFLUENCE_SYSTEM_ID

static final String DEFAULT_CONFLUENCE_SYSTEM_ID

DEFAULT_CONFLUENCE_SYSTEM_ID.

See Also:

Constant Field Values

DEFAULT_LDAP_SYSTEM_ID

@Deprecated
static final String DEFAULT_LDAP_SYSTEM_ID

Deprecated. Use LdapUserRepository#EXTERNAL_SYSTEM_ID_DEFAULT_LDAP where possible. All LDAP specifics should be moved to the ldap plugin.

DEFAULT_LDAP_SYSTEM_ID.

See Also:

Constant Field Values

DEFAULT_DATABASE_ID

static final String DEFAULT_DATABASE_ID

DEFAULT_DATABASE_ID.

See Also:

Constant Field Values

Method Detail

getApplicationConfigurationSettings

Collection<ApplicationConfigurationSetting> getApplicationConfigurationSettings()

Returns:

the current application configuration settings.

getClientLogo

ImageVO getClientLogo()

Returns:

the client logo

getConfiguration

Configuration getConfiguration()

Returns:

The current configuration.

getDefaultBlog

Blog getDefaultBlog()

Gets the default blog.

Returns:

The default blog.

removeClientLogo

void removeClientLogo()

setPrimaryAuthentication

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

Parameters:

externalSystemId - The ID of the external system which should be made the primary authentication system. If this is null, the current primary authentication system will be removed.

allowDBAuth - True, if authentication against the internal database should be allowed.

currentPrimaryAuthentication - The ID of the external system which is the current primary authentication system. Can be null if there is currently no primary authentication.

Throws:

PrimaryAuthenticationException - Thrown if there is no active configuration for the externalSystemId or no configuration for the currentPrimaryAuthentication. This Exception is also thrown if allowDBAuth is false and there are no client managers that can authenticate against the new primary system.

updateApplicationSettings

void updateApplicationSettings(Map<ApplicationConfigurationPropertyConstant,String> settings)
                        throws AuthorizationException

Updates or creates the provided application settings.

Parameters:

settings - The updated settings.

Throws:

AuthorizationException - Exception.

updateClientLogo

void updateClientLogo(byte[] image)

Updates the client logo.

Parameters:

image - The logo as byte array.

updateClientSetting

void updateClientSetting(ClientConfigurationPropertyConstant key,
                         String value)

Update the given setting using the key and value. If the key already exists it will be updated.

Parameters:

key - The key of the setting.

value - The updated value.

updateClientSettings

void updateClientSettings(Map<ClientConfigurationPropertyConstant,String> settings)

Updates or creates the provided client configuration settings.

Parameters:

settings - The updated settings.

updateClientTimeZoneId

void updateClientTimeZoneId(String timeZoneId)

Parameters:

timeZoneId - The clients new timezone.

updateConfluenceAuthConfig

void updateConfluenceAuthConfig(ConfluenceConfiguration confluenceAuthConf)
                         throws AuthorizationException,
                                PrimaryAuthenticationException

Updates or creates the confluence authentication configuration

Parameters:

confluenceAuthConf - The updated Confluence authentication configuration.

Throws:

AuthorizationException - Exception.

PrimaryAuthenticationException - Exception.

updateDefaultBlog

void updateDefaultBlog(Blog blog)

Updates the default blog.

Parameters:

blog - The new default blog.

updateLdapConfiguration

void updateLdapConfiguration(LdapConfiguration ldapConfig)
                      throws AuthorizationException,
                             PrimaryAuthenticationException

Parameters:

ldapConfig - The updated LDAP authentication configuration.

Throws:

AuthorizationException - Exception.

PrimaryAuthenticationException - Exception.