co.luminositylabs.config

Class Configuration

java.lang.Object

co.luminositylabs.config.Configuration

All Implemented Interfaces:

Serializable

@ApplicationScoped
public class Configuration
extends Object
implements Serializable

An application-scoped CDI managed bean named which serves as an injectable component for managing configuration parameters.

Author:

Phillip Ross

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CONFIG_FILE_PATH_PROPERTY_NAME The default name of the system property referencing to the location of the configuration file.

Constructor Summary

Constructors

Constructor and Description
Configuration() Instantiates a new configuration object.

Method Summary

Modifier and Type	Method and Description
Object	get(Object key) Delegates to Hashtable.get(Object).
Object	getOrDefault(Object key, Object defaultValue) Delegates to Hashtable.getOrDefault(Object, Object).
Properties	getProperties() Gets the properties.
Properties	getPropertiesWithPrefix(String prefix) Gets the properties that begin with a specified prefix.
String	getProperty(String propertyName) Gets the property value with the specified name.
String	getProperty(String propertyName, String defaultValue) Gets the property value with the specified name.
Object	put(Object key, Object value) Delegates to Hashtable.put(Object, Object).
void	putAll(Map<?,?> map) Delegates to Hashtable.putAll(Map).
Object	putIfAbsent(Object key, Object value) Delegates to Hashtable.putIfAbsent(Object, Object).
void	readProperties() Reads in the configuration properties.
void	setProperties(Properties properties) Clears existing configuration properties replaces with the specified properties.
void	setProperty(String propertyName, String propertyValue) Sets the specified property to the specified value.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CONFIG_FILE_PATH_PROPERTY_NAME

public static final String DEFAULT_CONFIG_FILE_PATH_PROPERTY_NAME

The default name of the system property referencing to the location of the configuration file.

See Also:

Constant Field Values

Constructor Detail

Configuration

public Configuration()

Instantiates a new configuration object.

Method Detail

getProperties

public Properties getProperties()

Gets the properties.

Returns:

the properties

getPropertiesWithPrefix

public Properties getPropertiesWithPrefix(String prefix)

Gets the properties that begin with a specified prefix.

Parameters:

prefix - the prefix

Returns:

the properties

setProperties

public void setProperties(Properties properties)

Clears existing configuration properties replaces with the specified properties.

Parameters:

properties - the properties

setProperty

public void setProperty(String propertyName,
                        String propertyValue)

Sets the specified property to the specified value.

Parameters:

propertyName - the property name to be set

propertyValue - the property value to set the property to

getProperty

public String getProperty(String propertyName)

Gets the property value with the specified name.

Parameters:

propertyName - the name of the property to get

Returns:

the value of the property retrieved

getProperty

public String getProperty(String propertyName,
                          String defaultValue)

Gets the property value with the specified name. If the property does not exist, the specified default value is returned.

Parameters:

propertyName - the name of the property to get

defaultValue - the value returned if the property does not exist

Returns:

the value of the property retrieved

get

public Object get(Object key)

Delegates to Hashtable.get(Object).

Parameters:

key - the key whose associated value is to be returned

Returns:

the value to which the specified key is mapped, or null if this map contains no mapping for the key

Throws:

NullPointerException - if the specified key is null

getOrDefault

public Object getOrDefault(Object key,
                           Object defaultValue)

Delegates to Hashtable.getOrDefault(Object, Object).

Parameters:

key - the key whose associated value is to be returned

defaultValue - the value to be returned if the associated property value is null

Returns:

the value to which the specified key is mapped, or defaultValue if this map contains no mapping for the key

put

public Object put(Object key,
                  Object value)

Delegates to Hashtable.put(Object, Object).

Parameters:

key - the hashtable key

value - the value

Returns:

the previous value of the specified key in this hashtable, or null if it did not have one

Throws:

NullPointerException - if the key or value is null

putAll

public void putAll(Map<?,?> map)

Delegates to Hashtable.putAll(Map).

Parameters:

map - mappings to be stored in this map

Throws:

NullPointerException - if the specified map is null

putIfAbsent

public Object putIfAbsent(Object key,
                          Object value)

Delegates to Hashtable.putIfAbsent(Object, Object).

Parameters:

key - the hashtable key

value - the value

Returns:

the previous value of the specified key in this hashtable, or null if it did not have one

Throws:

NullPointerException - if the key or value is null

readProperties

@PostConstruct
public void readProperties()

Reads in the configuration properties. If the co.luminositylabs.configFile system property exists, the value of this property is used as the path to read the configuration from. If the property does not exist, a path named co.luminositylabs.config.properties is used.

If the configuration pathname does NOT represent an absolute path, the pathname will be treated as a relative path, and the file will be searched for in a series of relative locations:

1. First, the file will be searched for at the path relative to the current working directory.
2. Second, the file will be searched for at the path relative to the home directory.
3. Lastly, the file will be searched for at the path relative to the classpath.

If the configuration file is not found, an IOException is thrown.