com.communote.server.api.core.config

Class DevelopmentProperties

java.lang.Object

com.communote.server.api.core.config.DevelopmentProperties

public class DevelopmentProperties
extends Object

Object holding some special properties when running a development system.

Author:

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

Constructor Summary

Constructors

Constructor and Description
DevelopmentProperties(File configPath) Creates and initializes the development properties.

Method Summary

Modifier and Type	Method and Description
String	getMailingTestAddress() Returns the test email address.
String	getProperty(String key) Returns the property value for the key as String.
boolean	getProperty(String key, boolean fallback) Returns the property for the key as boolean.
int	getProperty(String key, int fallback) Returns the property for the key as integer.
long	getProperty(String key, long fallback) Returns the property for the key as long.
String	getProperty(String key, String fallback) Returns the property for the key as string.
boolean	isDebugRestApi()
boolean	isDevelopement()
boolean	isMailingTestMode() Returns whether the mailing test mode is enabled.

Methods inherited from class java.lang.Object

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

Constructor Detail

DevelopmentProperties

public DevelopmentProperties(File configPath)

Creates and initializes the development properties. A ConfigurationInitializationException will be thrown if the initialization failed.

Parameters:

configPath - path to the configuration directory

Method Detail

getMailingTestAddress

public String getMailingTestAddress()

Returns the test email address. This will only return a useful value if isMailingTestMode() returns true.

Returns:

the test email address

getProperty

public String getProperty(String key)

Returns the property value for the key as String.

Parameters:

key - the key

Returns:

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

Since:

3.5

getProperty

public boolean getProperty(String key,
                           boolean fallback)

Returns the property for the key as boolean. 'true', 'on' or 'yes' (case insensitive) will return true. 'false', 'off' or 'no' (case insensitive) will return false. If none of these values is set the fallback will be returned.

Parameters:

key - the key

fallback - the fallback to return if there is no property for the key

Returns:

the property value or the fallback if there is no property for the key or it cannot be converted into a boolean

Since:

3.5

getProperty

public int getProperty(String key,
                       int fallback)

Returns the property for the key as integer.

Parameters:

key - the key

fallback - the fallback to return if there is no property for the key

Returns:

the property value or the fallback if there is no property for the key or it cannot be converted into an integer

Since:

3.5

getProperty

public long getProperty(String key,
                        long fallback)

Returns the property for the key as long.

Parameters:

key - the key

fallback - the fallback to return if there is no property for the key

Returns:

the property value or the fallback if there is no property for the key or it cannot be converted into a long

Since:

3.5

getProperty

public String getProperty(String key,
                          String fallback)

Returns the property for the key as string.

Parameters:

key - the key

fallback - the fallback to return if there is no property for the key

Returns:

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

Since:

3.5

isDebugRestApi

public boolean isDebugRestApi()

Returns:

the debugRestApi

isDevelopement

public boolean isDevelopement()

Returns:

the isDevelopemnt

isMailingTestMode

public boolean isMailingTestMode()

Returns whether the mailing test mode is enabled.

Returns:

true if the mailing test mode is enabled