com.communote.server.api.core.config

Class ClientConfigurationProperties

java.lang.Object

com.communote.server.api.core.config.AbstractConfigurationProperties<ClientConfigurationPropertyConstant>

com.communote.server.api.core.config.ClientConfigurationProperties

All Implemented Interfaces:

Serializable

public class ClientConfigurationProperties
extends AbstractConfigurationProperties<ClientConfigurationPropertyConstant>
implements Serializable

Object holding client specific configuration properties.

Author:

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ClientConfigurationProperties(Configuration configuration) Constructs a new instance.

Method Summary

Modifier and Type	Method and Description
String	getClientTimeZoneId() Returns the time zone id of this client or null.
ConfluenceConfiguration	getConfluenceConfiguration() Returns the confluence authentication configuration.
Long	getDefaultBlogId()
Locale	getDefaultLanguage() Get default locale if default language is null or not a valid language code return english
Collection<ExternalSystemConfiguration>	getExternalSystemConfigurations()
LdapConfiguration	getLdapConfiguration() Deprecated. use UserService.getExternalSystemConfiguration(String)
String	getPrimaryExternalAuthentication()
String	getProperty(ClientConfigurationPropertyConstant key) Returns the property value for the key as String.
Date	getPropertyLastModification(ClientConfigurationPropertyConstant key) Return the time of the last modification of the property.
ClientProperty.REPOSITORY_MODE	getRepositoryMode()
boolean	isConfluenceAuthenticationActivated() Deprecated. use UserService.getExternalSystemConfiguration(String)
boolean	isDBAuthenticationAllowed()
boolean	isDefaultBlogEnabled() Checks if the default blog is configured.
boolean	isExternalAuthenticationActivated() Checks if an external authentication e.g.
boolean	isLdapAuthenticationActivated() Deprecated. use getExternalSystemConfigurations()
boolean	isRegistrationAllowed()

Methods inherited from class com.communote.server.api.core.config.AbstractConfigurationProperties

getAssertProperty, getProperty, getProperty, getProperty, getProperty

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientConfigurationProperties

public ClientConfigurationProperties(Configuration configuration)

Constructs a new instance.

Parameters:

configuration - the client configuration for initializing the properties

Method Detail

getClientTimeZoneId

public String getClientTimeZoneId()

Returns the time zone id of this client or null.

Returns:

the time zone id or null

getConfluenceConfiguration

public ConfluenceConfiguration getConfluenceConfiguration()

Returns the confluence authentication configuration. The configuration is returned as a copy to avoid direct manipulation. To modify the configuration use ConfigurationManagement.

Returns:

the confluence authentication configuration

getDefaultBlogId

public Long getDefaultBlogId()

Returns:

The ID of the default blog or null if there is no default blog

getDefaultLanguage

public Locale getDefaultLanguage()

Get default locale if default language is null or not a valid language code return english

Returns:

Locale

getExternalSystemConfigurations

public Collection<ExternalSystemConfiguration> getExternalSystemConfigurations()

Returns:

all available external system configurations

getLdapConfiguration

@Deprecated
public LdapConfiguration getLdapConfiguration()

Deprecated. use UserService.getExternalSystemConfiguration(String)

Returns the LDAP configuration. The configuration is returned as a copy to avoid direct manipulation. To modify the configuration use ConfigurationManagement.updateLdapConfiguration(LdapConfiguration)

Returns:

the LDAP configuration

getPrimaryExternalAuthentication

public String getPrimaryExternalAuthentication()

getProperty

public String getProperty(ClientConfigurationPropertyConstant key)

Returns the property value for the key as String.

Specified by:

getProperty in class AbstractConfigurationProperties<ClientConfigurationPropertyConstant>

Parameters:

key - the key

Returns:

the property value or null if there is no property for the key

getPropertyLastModification

public Date getPropertyLastModification(ClientConfigurationPropertyConstant key)

Return the time of the last modification of the property.

Note: for properties which were added before the modification time was stored this will return the date of epoch

Parameters:

key - the key of the property to retrieve

Returns:

the date of the last modification or null if there is no property for the given key

getRepositoryMode

public ClientProperty.REPOSITORY_MODE getRepositoryMode()

Returns:

The configured Repository mode or the default if not set. Never returns null.

isConfluenceAuthenticationActivated

@Deprecated
public boolean isConfluenceAuthenticationActivated()

Deprecated. use UserService.getExternalSystemConfiguration(String)

Checks if a Confluence authentication is configured and activated.

Returns:

true, if Confluence authentication is configured and activated

isDBAuthenticationAllowed

public boolean isDBAuthenticationAllowed()

Returns:

True, when it is allowed to register users via the internal database.

isDefaultBlogEnabled

public boolean isDefaultBlogEnabled()

Checks if the default blog is configured.

Returns:

true, if there is a configured default blog

isExternalAuthenticationActivated

public boolean isExternalAuthenticationActivated()

Checks if an external authentication e.g. via LDAP is activated.

Returns:

true, if there is a configured and activated external authentication

isLdapAuthenticationActivated

@Deprecated
public boolean isLdapAuthenticationActivated()

Deprecated. use getExternalSystemConfigurations()

Checks if an LDAP authentication is configured and activated.

Returns:

true, if LDAP authentication is configured and activated

isRegistrationAllowed

public boolean isRegistrationAllowed()

Returns:

True, if is allowed for users to register themselves.