com.communote.server.core

Class ConfigurationManagementBase

java.lang.Object

com.communote.server.core.ConfigurationManagementBase

All Implemented Interfaces:

ConfigurationManagement

Direct Known Subclasses:

ConfigurationManagementImpl

@Transactional(propagation=REQUIRED)
public abstract class ConfigurationManagementBase
extends Object
implements ConfigurationManagement

Spring Service base class for com.communote.server.service.ConfigurationManagement, provides access to all services and entities referenced by this service.

Author:

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

See Also:

ConfigurationManagement

Field Summary

Fields inherited from interface com.communote.server.core.ConfigurationManagement

DEFAULT_CONFLUENCE_SYSTEM_ID, DEFAULT_DATABASE_ID, DEFAULT_LDAP_SYSTEM_ID

Constructor Summary

Constructors

Constructor and Description
ConfigurationManagementBase()

Method Summary

Modifier and Type	Method and Description
ApplicationConfigurationSettingDao	getApplicationConfigurationSettingDao()
Collection<ApplicationConfigurationSetting>	getApplicationConfigurationSettings()
ClientConfigurationDao	getClientConfigurationDao()
ImageVO	getClientLogo()
Configuration	getConfiguration()
ConfigurationDao	getConfigurationDao()
ConfluenceConfigurationDao	getConfluenceConfigurationDao()
ExternalSystemConfigurationDao	getExternalSystemConfigurationDao()
LdapConfigurationDao	getLdapConfigurationDao()
protected Principal	getPrincipal() Gets the current principal if one has been set, otherwise returns null.
SettingDao	getSettingDao()
protected abstract void	handleDefaultBlog(Blog blog) Performs the core logic for #updateDefaultBlog(com.communote.server.model.config.ConfluenceConfiguration)
protected abstract Collection<ApplicationConfigurationSetting>	handleGetApplicationConfigurationSettings() Performs the core logic for getApplicationConfigurationSettings()
protected abstract ImageVO	handleGetClientLogo() Performs the core logic for getClientLogo()
protected abstract Configuration	handleGetConfiguration() Performs the core logic for getConfiguration()
protected abstract void	handleRemoveClientLogo() Performs the core logic for removeClientLogo()
protected abstract void	handleUpdateApplicationSettings(Map<ApplicationConfigurationPropertyConstant,String> settings) Performs the core logic for #updateApplicationSettings(java.util.Map< ApplicationConfigurationPropertyConstant, String>)
protected abstract void	handleUpdateClientLogo(byte[] image) Performs the core logic for updateClientLogo(byte[])
protected abstract void	handleUpdateClientSetting(ClientConfigurationPropertyConstant key, String value) Performs the core logic for updateClientSetting(com.communote.server.api.core.config.ClientConfigurationPropertyConstant, String)
protected abstract void	handleUpdateClientSettings(Map<ClientConfigurationPropertyConstant,String> settings) Performs the core logic for #updateClientSettings(java.util.Map< ClientConfigurationPropertyConstant,String>)
protected abstract void	handleUpdateClientTimeZoneId(String timeZoneId) Performs the core logic for updateClientTimeZoneId(String)
protected abstract void	handleUpdateConfluenceAuthConfig(ConfluenceConfiguration confluenceAuthConf) Performs the core logic for updateConfluenceAuthConfig(com.communote.server.model.config.ConfluenceConfiguration)
protected abstract void	handleUpdateLdapConfiguration(LdapConfiguration ldapConfig) Performs the core logic for updateLdapConfiguration(com.communote.server.model.config.LdapConfiguration)
void	removeClientLogo()
void	setApplicationConfigurationSettingDao(ApplicationConfigurationSettingDao applicationConfigurationSettingDao)
void	setClientConfigurationDao(ClientConfigurationDao clientConfigurationDao)
void	setConfigurationDao(ConfigurationDao configurationDao)
void	setConfluenceConfigurationDao(ConfluenceConfigurationDao confluenceConfigurationDao)
void	setExternalSystemConfigurationDao(ExternalSystemConfigurationDao externalSystemConfigurationDao)
void	setLdapConfigurationDao(LdapConfigurationDao ldapConfigurationDao)
void	setSettingDao(SettingDao settingDao)
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)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.communote.server.core.ConfigurationManagement

getDefaultBlog, setPrimaryAuthentication

Constructor Detail

ConfigurationManagementBase

public ConfigurationManagementBase()

Method Detail

getApplicationConfigurationSettingDao

public ApplicationConfigurationSettingDao getApplicationConfigurationSettingDao()

Returns:

the applicationConfigurationSettingDao

getApplicationConfigurationSettings

@Transactional(readOnly=true,
               propagation=REQUIRES_NEW)
public Collection<ApplicationConfigurationSetting> getApplicationConfigurationSettings()

Specified by:

getApplicationConfigurationSettings in interface ConfigurationManagement

Returns:

A collection of all settings for the application.

getClientConfigurationDao

public ClientConfigurationDao getClientConfigurationDao()

Returns:

the clientConfigurationDao

getClientLogo

@Transactional(readOnly=true)
public ImageVO getClientLogo()

Specified by:

getClientLogo in interface ConfigurationManagement

Returns:

the client logo

getConfiguration

public Configuration getConfiguration()

Specified by:

getConfiguration in interface ConfigurationManagement

Returns:

The current configuration.

getConfigurationDao

public ConfigurationDao getConfigurationDao()

Returns:

the configurationDao

getConfluenceConfigurationDao

public ConfluenceConfigurationDao getConfluenceConfigurationDao()

Returns:

the confluenceConfigurationDao

getExternalSystemConfigurationDao

public ExternalSystemConfigurationDao getExternalSystemConfigurationDao()

Returns:

the externalSystemConfigurationDao

getLdapConfigurationDao

public LdapConfigurationDao getLdapConfigurationDao()

Returns:

the ldapConfigurationDao

getPrincipal

protected Principal getPrincipal()

Gets the current principal if one has been set, otherwise returns null.

Returns:

the current principal

getSettingDao

public SettingDao getSettingDao()

Returns:

the settingDao

handleDefaultBlog

protected abstract void handleDefaultBlog(Blog blog)

Performs the core logic for #updateDefaultBlog(com.communote.server.model.config.ConfluenceConfiguration)

handleGetApplicationConfigurationSettings

protected abstract Collection<ApplicationConfigurationSetting> handleGetApplicationConfigurationSettings()

Performs the core logic for getApplicationConfigurationSettings()

handleGetClientLogo

protected abstract ImageVO handleGetClientLogo()

Performs the core logic for getClientLogo()

handleGetConfiguration

protected abstract Configuration handleGetConfiguration()

Performs the core logic for getConfiguration()

handleRemoveClientLogo

protected abstract void handleRemoveClientLogo()

Performs the core logic for removeClientLogo()

handleUpdateApplicationSettings

protected abstract void handleUpdateApplicationSettings(Map<ApplicationConfigurationPropertyConstant,String> settings)
                                                 throws AuthorizationException

Performs the core logic for #updateApplicationSettings(java.util.Map< ApplicationConfigurationPropertyConstant, String>)

Throws:

AuthorizationException

handleUpdateClientLogo

protected abstract void handleUpdateClientLogo(byte[] image)

Performs the core logic for updateClientLogo(byte[])

handleUpdateClientSetting

protected abstract void handleUpdateClientSetting(ClientConfigurationPropertyConstant key,
                                                  String value)

Performs the core logic for updateClientSetting(com.communote.server.api.core.config.ClientConfigurationPropertyConstant, String)

handleUpdateClientSettings

protected abstract void handleUpdateClientSettings(Map<ClientConfigurationPropertyConstant,String> settings)

Performs the core logic for #updateClientSettings(java.util.Map< ClientConfigurationPropertyConstant,String>)

handleUpdateClientTimeZoneId

protected abstract void handleUpdateClientTimeZoneId(String timeZoneId)

Performs the core logic for updateClientTimeZoneId(String)

handleUpdateConfluenceAuthConfig

protected abstract void handleUpdateConfluenceAuthConfig(ConfluenceConfiguration confluenceAuthConf)
                                                  throws AuthorizationException,
                                                         PrimaryAuthenticationException

Performs the core logic for updateConfluenceAuthConfig(com.communote.server.model.config.ConfluenceConfiguration)

Throws:

PrimaryAuthenticationException

AuthorizationException

handleUpdateLdapConfiguration

protected abstract void handleUpdateLdapConfiguration(LdapConfiguration ldapConfig)
                                               throws AuthorizationException,
                                                      PrimaryAuthenticationException

Performs the core logic for updateLdapConfiguration(com.communote.server.model.config.LdapConfiguration)

Throws:

PrimaryAuthenticationException

AuthorizationException

removeClientLogo

public void removeClientLogo()

Specified by:

removeClientLogo in interface ConfigurationManagement

See Also:

ConfigurationManagement.removeClientLogo()

setApplicationConfigurationSettingDao

public void setApplicationConfigurationSettingDao(ApplicationConfigurationSettingDao applicationConfigurationSettingDao)

Parameters:

applicationConfigurationSettingDao - the applicationConfigurationSettingDao to set

setClientConfigurationDao

public void setClientConfigurationDao(ClientConfigurationDao clientConfigurationDao)

Parameters:

clientConfigurationDao - the clientConfigurationDao to set

setConfigurationDao

public void setConfigurationDao(ConfigurationDao configurationDao)

Parameters:

configurationDao - the configurationDao to set

setConfluenceConfigurationDao

public void setConfluenceConfigurationDao(ConfluenceConfigurationDao confluenceConfigurationDao)

Parameters:

confluenceConfigurationDao - the confluenceConfigurationDao to set

setExternalSystemConfigurationDao

public void setExternalSystemConfigurationDao(ExternalSystemConfigurationDao externalSystemConfigurationDao)

Parameters:

externalSystemConfigurationDao - the externalSystemConfigurationDao to set

setLdapConfigurationDao

public void setLdapConfigurationDao(LdapConfigurationDao ldapConfigurationDao)

Parameters:

ldapConfigurationDao - the ldapConfigurationDao to set

setSettingDao

public void setSettingDao(SettingDao settingDao)

Parameters:

settingDao - the settingDao to set

updateApplicationSettings

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

Updates or creates the provided application settings.

Specified by:

updateApplicationSettings in interface ConfigurationManagement

Parameters:

settings - The updated settings.

Throws:

AuthorizationException - Exception.

updateClientLogo

public void updateClientLogo(byte[] image)

Updates the client logo.

Specified by:

updateClientLogo in interface ConfigurationManagement

Parameters:

image - The logo as byte array.

updateClientSetting

public void updateClientSetting(ClientConfigurationPropertyConstant key,
                                String value)

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

Specified by:

updateClientSetting in interface ConfigurationManagement

Parameters:

key - The key of the setting.

value - The updated value.

updateClientSettings

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

Updates or creates the provided client configuration settings.

Specified by:

updateClientSettings in interface ConfigurationManagement

Parameters:

settings - The updated settings.

updateClientTimeZoneId

public void updateClientTimeZoneId(String timeZoneId)

Specified by:

updateClientTimeZoneId in interface ConfigurationManagement

Parameters:

timeZoneId - The clients new timezone.

updateConfluenceAuthConfig

public void updateConfluenceAuthConfig(ConfluenceConfiguration confluenceAuthConf)
                                throws AuthorizationException,
                                       PrimaryAuthenticationException

Updates or creates the confluence authentication configuration

Specified by:

updateConfluenceAuthConfig in interface ConfigurationManagement

Parameters:

confluenceAuthConf - The updated Confluence authentication configuration.

Throws:

AuthorizationException - Exception.

PrimaryAuthenticationException - Exception.

updateDefaultBlog

public void updateDefaultBlog(Blog blog)

Updates the default blog.

Specified by:

updateDefaultBlog in interface ConfigurationManagement

Parameters:

blog - The new default blog.

updateLdapConfiguration

public void updateLdapConfiguration(LdapConfiguration ldapConfig)
                             throws AuthorizationException,
                                    PrimaryAuthenticationException

Specified by:

updateLdapConfiguration in interface ConfigurationManagement

Parameters:

ldapConfig - The updated LDAP authentication configuration.

Throws:

AuthorizationException - Exception.

PrimaryAuthenticationException - Exception.