com.communote.server.api.core.config

Class ApplicationConfigurationProperties

java.lang.Object

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

com.communote.server.api.core.config.ApplicationConfigurationProperties

All Implemented Interfaces:

Serializable

public class ApplicationConfigurationProperties
extends AbstractConfigurationProperties<ApplicationConfigurationPropertyConstant>
implements Serializable

Object holding application wide configuration properties.

Author:

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ApplicationConfigurationProperties(Collection<ApplicationConfigurationSetting> settings) Constructs a new application properties container and initializes it with the provided settings.

Method Summary

Modifier and Type	Method and Description
String	getProperty(ApplicationConfigurationPropertyConstant key) Returns the property value for the key as String.
String	getPropertyDecrypted(ApplicationConfigurationPropertyConstant key) Get the decrypted value of an encrypted property.
String	getUrlPrefix() Returns the configured URL prefix for rendering absolute URLs with HTTP protocol.
String	getUrlPrefixSecured() Returns the configured URL prefix for rendering absolute URLs with HTTPS protocol.
Properties	getVirusScanningProperties() Returns the virus scanning properties.

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

ApplicationConfigurationProperties

public ApplicationConfigurationProperties(Collection<ApplicationConfigurationSetting> settings)

Constructs a new application properties container and initializes it with the provided settings.

Parameters:

settings - the application configuration settings

Method Detail

getProperty

public String getProperty(ApplicationConfigurationPropertyConstant key)

Returns the property value for the key as String.

Specified by:

getProperty in class AbstractConfigurationProperties<ApplicationConfigurationPropertyConstant>

Parameters:

key - the key

Returns:

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

getPropertyDecrypted

public String getPropertyDecrypted(ApplicationConfigurationPropertyConstant key)
                            throws EncryptionException

Get the decrypted value of an encrypted property.

Parameters:

key - the key of the property to return

Returns:

the decrypted value or null if the property was not set

Throws:

EncryptionException - in case decryption failed

Since:

3.5

getUrlPrefix

public String getUrlPrefix()

Returns the configured URL prefix for rendering absolute URLs with HTTP protocol.

Returns:

the configured URL prefix, or an empty string if it is not configured

getUrlPrefixSecured

public String getUrlPrefixSecured()

Returns the configured URL prefix for rendering absolute URLs with HTTPS protocol. The return value will be the same as getUrlPrefix() if the configuration states that HTTPS is not supported.

Returns:

the configured URL prefix for HTTPs connections

getVirusScanningProperties

public Properties getVirusScanningProperties()

Returns the virus scanning properties. The returned value is a copy of the properties, thus modifications will not be persisted.

Returns:

the virus scanning properties