| java.lang.Object
 org.apache.commons.configuration.ConfigurationFactory
| ConfigurationFactory | | public class ConfigurationFactory (Code) | |
Factory class to create a CompositeConfiguration from a .xml file using
Digester. By default it can handle the Configurations from commons-
configuration. If you need to add your own, then you can pass in your own
digester rules to use. It is also namespace aware, by providing a
digesterRuleNamespaceURI.
Note: Almost all of the features provided by this class and many
more are also available for the
DefaultConfigurationBuilder
class. DefaultConfigurationBuilder also has a more robust
merge algorithm for constructing combined configurations. So it is
recommended to use this class instead of ConfigurationFactory.
author:
Eric Pugh
author:
Henning P. Schmiedehausen
author:
Oliver Heger
version:
$Id: ConfigurationFactory.java 524006 2007-03-30 09:33:17Z oheger $ |
| Inner Class :public class DigesterConfigurationFactory extends AbstractObjectCreationFactory | |
| Inner Class :public class FileConfigurationFactory extends DigesterConfigurationFactory | |
| Inner Class :public class PropertiesConfigurationFactory extends FileConfigurationFactory | |
| Inner Class :public class PropertyListConfigurationFactory extends FileConfigurationFactory | |
| Inner Class :public static class AdditionalConfigurationData | |
| Inner Class :public static class ConfigurationBuilder | |
| ConfigurationFactory | | public ConfigurationFactory()(Code) | | Constructor
|
| ConfigurationFactory | | public ConfigurationFactory(String configurationFileName)(Code) | | Constructor with ConfigurationFile Name passed
Parameters:
configurationFileName - The path to the configuration file |
| enableDigesterSubstitutor | | protected void enableDigesterSubstitutor(Digester digester)(Code) | | Adds a substitutor to interpolate system properties
Parameters:
digester - The digester to which we add the substitutor |
| getBasePath | | public String getBasePath()(Code) | | Returns the Base path from which this Configuration Factory operates.
This is never null. If you set the BasePath to null, then a base path
according to the configuration to load is returned.
The base Path of this configuration factory. |
| getConfiguration | | public Configuration getConfiguration() throws ConfigurationException(Code) | | Return the configuration provided by this factory. It loads the
configuration file which is a XML description of the actual
configurations to load. It can contain various different types of
configuration, e.g. Properties, XML and JNDI.
A Configuration object
throws:
ConfigurationException - A generic exception that we had trouble during theloading of the configuration data. |
| getConfigurationFileName | | public String getConfigurationFileName()(Code) | | Returns the configurationFile.
The name of the configuration file. Can be null. |
| getConfigurationURL | | public URL getConfigurationURL()(Code) | | Returns the URL of the configuration file to be loaded.
the URL of the configuration to load |
| getDigesterRuleNamespaceURI | | public String getDigesterRuleNamespaceURI()(Code) | | Returns the digesterRuleNamespaceURI.
A String with the digesterRuleNamespaceURI. |
| getDigesterRules | | public URL getDigesterRules()(Code) | | Returns the digesterRules.
URL |
| initDefaultDigesterRules | | protected void initDefaultDigesterRules(Digester digester)(Code) | | Initializes the parsing rules for the default digester
This allows the Configuration Factory to understand the default types:
Properties, XML and JNDI. Two special sections are introduced:
<override> and <additional>.
Parameters:
digester - The digester to configure |
| initDigesterSectionRules | | protected void initDigesterSectionRules(Digester digester, String matchString, boolean additional)(Code) | | Sets up digester rules for a specified section of the configuration
info file.
Parameters:
digester - the current digester instance
Parameters:
matchString - specifies the section
Parameters:
additional - a flag if rules for the additional section are to beadded |
| setBasePath | | public void setBasePath(String basePath)(Code) | | Sets the basePath for all file references from this Configuration Factory.
Normally a base path need not to be set because it is determined by
the location of the configuration file to load. All relative pathes in
this file are resolved relative to this file. Setting a base path makes
sense if such relative pathes should be otherwise resolved, e.g. if
the configuration file is loaded from the class path and all sub
configurations it refers to are stored in a special config directory.
Parameters:
basePath - The new basePath to set. |
| setConfigurationFileName | | public void setConfigurationFileName(String configurationFileName)(Code) | | Sets the configurationFile.
Parameters:
configurationFileName - The name of the configurationFile to use. |
| setConfigurationURL | | public void setConfigurationURL(URL url)(Code) | | Sets the URL of the configuration to load. This configuration can be
either specified by a file name or by a URL.
Parameters:
url - the URL of the configuration to load |
| setDigesterRuleNamespaceURI | | public void setDigesterRuleNamespaceURI(String digesterRuleNamespaceURI)(Code) | | Sets the digesterRuleNamespaceURI.
Parameters:
digesterRuleNamespaceURI - The new digesterRuleNamespaceURI to use |
| setDigesterRules | | public void setDigesterRules(URL digesterRules)(Code) | | Sets the digesterRules.
Parameters:
digesterRules - The digesterRules to set |
| setupDigesterInstance | | protected void setupDigesterInstance(Digester digester, String matchString, ObjectCreationFactory factory, String method, boolean additional)(Code) | | Sets up digester rules for a configuration to be loaded.
Parameters:
digester - the current digester
Parameters:
matchString - the pattern to match with this rule
Parameters:
factory - an ObjectCreationFactory instance to use for creating newobjects
Parameters:
method - the name of a method to be called or null for none
Parameters:
additional - a flag if rules for the additional section are to beadded |
| setupUnionRules | | protected void setupUnionRules(Digester digester, String matchString)(Code) | | Sets up rules for configurations in the additional section.
Parameters:
digester - the current digester
Parameters:
matchString - the pattern to match with this rule |
|
|