org.kepler.configuration

Class ConfigurationManager

java.lang.Object

org.kepler.configuration.ConfigurationManager

public class ConfigurationManager
extends java.lang.Object

A class to manage configuration options in Kepler. For more information see https://kepler-project.org/developers/teams/framework/kepler-configuration/ proposed-future-kepler-configuration-system and https://kepler-project.org/developers/teams/framework/configuration-system- documentation

Author:

Chad Berkley

Created:

October 2009

Field Summary

Fields

Modifier and Type	Field and Description
protected ConfigurationReader	configReader
protected ConfigurationWriter	configWriter
static java.lang.String	dotKeplerConfigurationsDir

Method Summary

Modifier and Type	Method and Description
void	addConfigurationListener(ConfigurationEventListener listener) add a configuration listener
void	addProperties(java.util.List<RootConfigurationProperty> propertyList) set a list of properties all at once
void	addProperty(RootConfigurationProperty property) add a property to the manager
protected void	clearConfigurations() remove all configurations currently listed and reset the configuration manager back to its un-initialized state.
static ConfigurationManager	getInstance() singleton accessor
protected static ConfigurationManager	getInstance(boolean loadConfiguration) singleton accessor. set loadConfiguration to true if you want to load the configuration automatically.
static org.kepler.build.modules.Module	getModule(java.lang.String name) get a module by name. return null if not found
static java.io.File	getOverwriteFile(org.kepler.build.modules.Module m, java.io.File f) returns the file from the .kepler directory if it exists, returns f if it doesn't.
java.util.List<ConfigurationProperty>	getProperties() return all properties handled by the manager
java.util.List<ConfigurationProperty>	getProperties(org.kepler.build.modules.Module module) get a list of properties that belong to a module
java.util.List<ConfigurationProperty>	getProperties(org.kepler.build.modules.Module module, ConfigurationNamespace namespace) get a list of properties that belong to a certain module within a specific namespace
java.util.List<ConfigurationProperty>	getProperties(org.kepler.build.modules.Module module, ConfigurationNamespace namespace, java.lang.String name) get a list of properties that belong to a certain module with a specific name within a namespace
java.util.List<ConfigurationProperty>	getProperties(org.kepler.build.modules.Module module, java.lang.String name) get a list of properties that belong to a certain module with a specific name.
ConfigurationProperty	getProperty(org.kepler.build.modules.Module module) Returns the root property of the default configuration for a module.
ConfigurationProperty	getProperty(org.kepler.build.modules.Module module, ConfigurationNamespace namespace) return the root ConfigurationProperty of the namespace.
ConfigurationProperty	getProperty(org.kepler.build.modules.Module module, ConfigurationNamespace namespace, java.lang.String name) return a single property from a module with a specific name in a specific namespace.
ConfigurationProperty	getProperty(org.kepler.build.modules.Module module, java.lang.String name) get a property from the module's default namespace configuration with a given name
protected void	loadConfiguration() deserialize the configuration
protected void	notifyListeners(ConfigurationProperty property) notify any listeners that a configuration event has occured
void	removeConfigurationListener(ConfigurationEventListener listener) remove a listener
protected static java.lang.String	removeFileExtension(java.lang.String filename) utility method to remove the file extension from the filename
protected static java.lang.String	removeLocaleDesignator(java.lang.String filename) remove the locale designator from a filename. this works with or without a file extension (i.e. .xml).
void	saveConfiguration() serialize the entire configuration

Methods inherited from class java.lang.Object

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

Field Detail

configWriter

protected ConfigurationWriter configWriter

configReader

protected ConfigurationReader configReader

dotKeplerConfigurationsDir

public static final java.lang.String dotKeplerConfigurationsDir

Method Detail

getInstance

public static ConfigurationManager getInstance()

singleton accessor

getInstance

protected static ConfigurationManager getInstance(boolean loadConfiguration)

singleton accessor. set loadConfiguration to true if you want to load the configuration automatically. This singleton accessor should really only be used for testing.

addProperty

public void addProperty(RootConfigurationProperty property)
                 throws NamespaceException

add a property to the manager

Parameters:

property - the property to add

Throws:

NamespaceException

addProperties

public void addProperties(java.util.List<RootConfigurationProperty> propertyList)
                   throws NamespaceException

set a list of properties all at once

Parameters:

propertyList - the list of properties to add

Throws:

NamespaceException

getProperties

public java.util.List<ConfigurationProperty> getProperties()

return all properties handled by the manager

getProperties

public java.util.List<ConfigurationProperty> getProperties(org.kepler.build.modules.Module module)

get a list of properties that belong to a module

Parameters:

module - the module to get the property list for

getProperties

public java.util.List<ConfigurationProperty> getProperties(org.kepler.build.modules.Module module,
                                                           ConfigurationNamespace namespace)

get a list of properties that belong to a certain module within a specific namespace

Parameters:

module -

namespace - namespace within the module to get a property list for

getProperties

public java.util.List<ConfigurationProperty> getProperties(org.kepler.build.modules.Module module,
                                                           ConfigurationNamespace namespace,
                                                           java.lang.String name)

get a list of properties that belong to a certain module with a specific name within a namespace

Parameters:

module -

namespace - namespace within the module

name - name of the property to get

getProperties

public java.util.List<ConfigurationProperty> getProperties(org.kepler.build.modules.Module module,
                                                           java.lang.String name)

get a list of properties that belong to a certain module with a specific name. this assumes the default namespace.

Parameters:

module -

name - the name of the property to get

getProperty

public ConfigurationProperty getProperty(org.kepler.build.modules.Module module)

Returns the root property of the default configuration for a module. This should be stored in a file named "configuration.xml" in the <module>/resources/configurations directory. If no such file exists, this will return null.

Parameters:

module - the module to get the default configuration for.

getProperty

public ConfigurationProperty getProperty(org.kepler.build.modules.Module module,
                                         ConfigurationNamespace namespace)

return the root ConfigurationProperty of the namespace.

Parameters:

module - the module to get the property from

namespace - the namespace to get the property from

getProperty

public ConfigurationProperty getProperty(org.kepler.build.modules.Module module,
                                         java.lang.String name)

get a property from the module's default namespace configuration with a given name

Parameters:

module - the module to get the property from

name - the name of the property to get.

getProperty

public ConfigurationProperty getProperty(org.kepler.build.modules.Module module,
                                         ConfigurationNamespace namespace,
                                         java.lang.String name)

return a single property from a module with a specific name in a specific namespace. If more than one property shares a name, the first is returned. Return null if the property is not found.

Parameters:

module - the module to get the property from

namespace - the namespace to get the property from

name - the name of the property to get

saveConfiguration

public void saveConfiguration()
                       throws ConfigurationManagerException

serialize the entire configuration

Throws:

ConfigurationManagerException

addConfigurationListener

public void addConfigurationListener(ConfigurationEventListener listener)

add a configuration listener

Parameters:

listener - the listener to add

removeConfigurationListener

public void removeConfigurationListener(ConfigurationEventListener listener)

remove a listener

Parameters:

listener - the listener to remove

getOverwriteFile

public static java.io.File getOverwriteFile(org.kepler.build.modules.Module m,
                                            java.io.File f)

returns the file from the .kepler directory if it exists, returns f if it doesn't. This method should be used to get configuration files because if the file has changed it will be written back to .kepler, not back to the resources/configurations directory of the module.

Parameters:

m - the module to get the overwrite file from

f - the file to get

getModule

public static org.kepler.build.modules.Module getModule(java.lang.String name)

get a module by name. return null if not found

Parameters:

name - the name of the module to get

notifyListeners

protected void notifyListeners(ConfigurationProperty property)

notify any listeners that a configuration event has occured

Parameters:

property - the property that changed to send to the listeners

loadConfiguration

protected void loadConfiguration()
                          throws ConfigurationManagerException

deserialize the configuration

Throws:

ConfigurationManagerException

clearConfigurations

protected void clearConfigurations()

remove all configurations currently listed and reset the configuration manager back to its un-initialized state. This should really only be used for testing.

removeFileExtension

protected static java.lang.String removeFileExtension(java.lang.String filename)

utility method to remove the file extension from the filename

Parameters:

filename - the filename to remove the extension from

removeLocaleDesignator

protected static java.lang.String removeLocaleDesignator(java.lang.String filename)

remove the locale designator from a filename. this works with or without a file extension (i.e. .xml). This method assumes a locale with both a country and language code (i.e. _en_US).