* * The class uses Apache * Commons Configuration - the method {@link #get} gives back * directly an Apache's CompositeConfiguration instance * allowing to fine-tune your configuration (if needed, at all).
*
* @author Martin Senger
* @version $Id: DashboardConfig.java,v 1.2 2008/11/18 06:40:11 senger Exp $
*/
public abstract class DashboardConfig {
private static org.apache.commons.logging.Log log =
org.apache.commons.logging.LogFactory.getLog (DashboardConfig.class);
private static CompositeConfiguration config;
private static Set
*
* The configuration object contains all Java system properties
* and properties read from a Dashboard configuration file. This
* file name is given by the system property {@link
* #PROP_DASHBOARD_CONFIGURATION}, or using a default name {@link
* #DASHBOARD_CONFIG_FILENAME}. If the filename does not specify
* an absolute path, the file will be searched automatically in
* the following locations:
*
*
*
* The System properties take precedence over properties read from
* the Dashboard property file.
*
* The configuration object can be anytime extended by properties
* from other sources by using either methods defined in the
* CompositeConfiguration's API, or using a convenient
* method {@link #addConfigPropertyFile} defined here. Properties
* from these additional files have higher priority than
* properties added earlier - except System properties, they are
* always the most prioritized.
*
* @return a configuration object
**************************************************************************/
public static synchronized CompositeConfiguration get() {
if (config == null) {
// set the Dashboard global configuration
CompositeConfiguration cfg = new CompositeConfiguration();
// first, add System properties
cfg.addConfiguration (new SystemConfiguration());
// second, add properties from the 'build.properties' file
addPropertiesConfiguration (cfg, "build.properties", false);
// third, add Dashboard properties file(s)
String[] configFilenames = cfg.getStringArray (PROP_DASHBOARD_CONFIGURATION);
if (configFilenames == null || configFilenames.length == 0)
configFilenames = new String[] { DASHBOARD_CONFIG_FILENAME };
for (int i = 0; i < configFilenames.length; i++) {
log.info ("Using configuration file: " + configFilenames[i]);
addPropertiesConfiguration (cfg, configFilenames[i], true);
}
// keep it for other calls
config = cfg;
}
return config;
}
/**************************************************************************
* It returns all existing configurations from the main composite
* configuration 'config', while removing them also from this
* 'config'. This is a step needed before inserting a new
* configuration,
**************************************************************************/
private static ArrayList
*
* The newly added properties have higher priority than properties
* added earlier - except System properties, they are always the
* most prioritized.
*
* @param configFilename is a filename indicating a file
* (formatted as a Java properties file) with new properties (see
* {@link #get} explaining where is this file looked for)
* @return true if 'configFilename' is successfully added, false
* otherwise (in which case the cause is recorded in the log)
**************************************************************************/
public static synchronized boolean addConfigPropertyFile (String configFilename) {
log.info ("Adding property configuration file: " + configFilename);
ArrayList
*
* It is a convenient way to say:
*
*
*
* By the way, the importance of a comma in a property value also
* means that any 'normal' (the one not meant as a value
* separator) commas in property values, must be escaped by
* backslashes.
*
* @return all values of the given property, or - if such property
* does not exist - return a one-element array with the
* 'defaultValue' unless the 'defaultValue' is also null in which
* case return an empty array
**************************************************************************/
public static String[] getStrings (String key,
String defaultValue) {
String[] values = get().getStringArray (key);
if (values.length > 0) return values;
if (defaultValue == null)
return ArrayUtils.EMPTY_STRING_ARRAY;
else
return new String[] { defaultValue };
}
/**************************************************************************
* Get an integer value associated with the given configuration
* key, or - if not found or not of integer value - get the given
* default value.
*
* @param key is a property name
* @param defaultValue used if the 'key' cannot be found, or if it
* is not an integer
*
* @return the property value, or 'defaultValue' if such property
* does not exist
**************************************************************************/
public static int getInt (String key, int defaultValue) {
String strValue = getString (key, ""+defaultValue);
try {
return Integer.decode (strValue).intValue();
} catch (NumberFormatException e) {
return defaultValue;
}
}
/**************************************************************************
* Get a boolean value associated with the given configuration
* key, or - if not found - get the given default value.
*
* @param key is a property name
* @param defaultValue used if the 'key' cannot be found, or if
* its value is empty
*
* @return true for the property values 'true', 'on', 'yes' (case
* insensitive), and for an existing property with an empty
* value. For other values, return false. If the property does not
* exist at all, the 'defaultValue' is returned.
**************************************************************************/
public static boolean isEnabled (String key, boolean defaultValue,
String serviceName, Object owner) {
String strValue = getString (key, null);
if (strValue == null)
return defaultValue;
if (StringUtils.isBlank (strValue))
return true;
return BooleanUtils.toBoolean (strValue);
}
// /**************************************************************************
// * Not needed, at the moment. Uncomment it if needed...
// **************************************************************************/
// public static File[] getConfigFiles() {
// get();
// ArrayList
*
* String value = Config.get().getString ("my.property", "yes");
*
*
* @param key is a property name
* @param defaultValue used if the 'key' cannot be found
*
* @return the property value, or 'defaultValue' if such property
* does not exist
**************************************************************************/
public static String getString (String key, String defaultValue) {
return get().getString (key, defaultValue);
}
/**************************************************************************
* Almost the same functionality as {@link #getString getString}
* method. The different is the return value: this method allows
* to return several values of the same property. In the
* configuration file, a property can be repeated, or can have
* several comma-separated values.