org.openmrs.util

Class ConfigUtil

java.lang.Object

org.openmrs.util.ConfigUtil

All Implemented Interfaces:

GlobalPropertyListener

public class ConfigUtil
extends Object
implements GlobalPropertyListener

A utility class for working with configuration properties

Constructor Summary

Constructors

Constructor and Description
ConfigUtil()

Method Summary

Modifier and Type	Method and Description
static String	getGlobalProperty(String propertyName) Gets the value of the given OpenMRS global property
static String	getProperty(String propertyName) Returns the value of the given configuration property.
static String	getProperty(String propertyName, String defaultValue) Returns the value of the given configuration property.
static String	getRuntimeProperty(String propertyName) Returns the value of the given OpenMRS runtime property
static String	getSystemProperty(String propertyName) Returns the value of the given OpenMRS system property
void	globalPropertyChanged(GlobalProperty newValue) Called after a global property is created or updated
void	globalPropertyDeleted(String propertyName) Called after a global property is deleted
static boolean	hasRuntimeProperty(String propertyName) Returns true if a runtime property with the given name has been defined, even if the value is empty
static boolean	hasSystemProperty(String propertyName) Returns true if a system property with the given name has been defined, even if the value is empty
boolean	supportsPropertyName(String propertyName) Asks this listener whether it wants to be notified about the given property name

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigUtil

public ConfigUtil()

Method Detail

getGlobalProperty

public static String getGlobalProperty(String propertyName)

Gets the value of the given OpenMRS global property

getRuntimeProperty

public static String getRuntimeProperty(String propertyName)

Returns the value of the given OpenMRS runtime property

hasRuntimeProperty

public static boolean hasRuntimeProperty(String propertyName)

Returns true if a runtime property with the given name has been defined, even if the value is empty

getSystemProperty

public static String getSystemProperty(String propertyName)

Returns the value of the given OpenMRS system property

hasSystemProperty

public static boolean hasSystemProperty(String propertyName)

Returns true if a system property with the given name has been defined, even if the value is empty

getProperty

public static String getProperty(String propertyName)

Returns the value of the given configuration property. This will check the OpenMRS global properties, OpenMRS runtime properties, and any defined system properties. In the event that a property is defined in multiple places, the order of precedence is system properties, then runtime properties, then global properties

getProperty

public static String getProperty(String propertyName,
                                 String defaultValue)

Returns the value of the given configuration property. This will check the OpenMRS global properties, OpenMRS runtime properties, and any defined system properties. In the event that a property is defined in multiple places, the order of precedence is system properties, then runtime properties, then global properties If the value found is null, empty, or only whitespace, then the default value is returned

globalPropertyChanged

public void globalPropertyChanged(GlobalProperty newValue)

Description copied from interface: GlobalPropertyListener

Called after a global property is created or updated

Specified by:

globalPropertyChanged in interface GlobalPropertyListener

Parameters:

newValue - the new value of the property that was just saved

globalPropertyDeleted

public void globalPropertyDeleted(String propertyName)

Description copied from interface: GlobalPropertyListener

Called after a global property is deleted

Specified by:

globalPropertyDeleted in interface GlobalPropertyListener

Parameters:

propertyName - the name of the property that was just deleted

supportsPropertyName

public boolean supportsPropertyName(String propertyName)

Description copied from interface: GlobalPropertyListener

Asks this listener whether it wants to be notified about the given property name

Specified by:

supportsPropertyName in interface GlobalPropertyListener

Returns:

whether this listener wants its action methods to be notified of properties with the given name