org.exoplatform.commons.utils

Class PropertyManager

java.lang.Object

org.exoplatform.commons.utils.PropertyManager

public class PropertyManager
extends Object

A property manager that acts as a facade of the system properties. The manager has a cache that is only disabled if the property exo.product.developing is set to the false string. The cache usage is read once during the static initialization of the cache and it can be programmatically triggered by calling the refresh() method. TODO add security privileged blocks used when eXo is executed under a security manager

Version:

$Revision$

Author:

Julien Viet

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEVELOPING .
static String	PROPERTIES_URL .
static String	RUNTIME_PROFILES .

Constructor Summary

Constructors

Constructor and Description
PropertyManager()

Method Summary

Modifier and Type	Method and Description
static Properties	getProperties() Returns all system properties.
static Properties	getPropertiesByPattern(String propertyPattern) Returns the system properties from the provided property name pattern.
static String	getProperty(String propertyName) Returns a property from the provided property name.
static boolean	getUseCache() Returns true if the cache is enabled.
static boolean	isDevelopping() Returns true if the product developing mode is enabled.
static void	refresh() Refresh the property manager.
static void	setProperty(String propertyName, String propertyValue) Update a property in the system properties and in the cache.

Methods inherited from class java.lang.Object

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

Field Detail

DEVELOPING

public static final String DEVELOPING

.

See Also:

Constant Field Values

RUNTIME_PROFILES

public static final String RUNTIME_PROFILES

.

See Also:

Constant Field Values

PROPERTIES_URL

public static final String PROPERTIES_URL

.

See Also:

Constant Field Values

Constructor Detail

PropertyManager

public PropertyManager()

Method Detail

getProperty

public static String getProperty(String propertyName)

Returns a property from the provided property name. If the property value is not found it returns null.

Parameters:

propertyName - the property name

Returns:

the property value

getPropertiesByPattern

public static Properties getPropertiesByPattern(String propertyPattern)

Returns the system properties from the provided property name pattern.

Parameters:

propertyPattern - the property name pattern

Returns:

the list of property keys

getProperties

public static Properties getProperties()

Returns all system properties.

Returns:

the list of property keys

isDevelopping

public static boolean isDevelopping()

Returns true if the product developing mode is enabled.

Returns:

the product developing mode

setProperty

public static void setProperty(String propertyName,
                               String propertyValue)

Update a property in the system properties and in the cache.

Parameters:

propertyName - the property name

propertyValue - the property value

getUseCache

public static boolean getUseCache()

Returns true if the cache is enabled.

Returns:

the use cache value

refresh

public static void refresh()

Refresh the property manager. The cache is cleared and the cache usage is read from the system properties.