Release History

VersionDateDescription
1.2 2005-12-17
1.2-rc3 2005-12-07
1.2-rc2 2005-11-23
1.2-rc1 2005-11-11
1.1 2005-04-02
1.1-rc2 2005-03-06
1.1-rc1 2005-02-13
1.0 2004-10-11
1.0-rc2 2004-09-24
1.0-rc1 2004-08-14

Get the RSS feed of the last changes

Release 1.2-rc3 - 2005-12-07

TypeChangesBy
update Commons Configuration now declares a dependency to Xalan. As with Xerces this dependency is only needed for JDK 1.3. It was introduced in a process of making Configuration buildable on a JDK 1.3. Documentation about the build process was also added. oheger
update The dependency to Commons Beanutils Collections was unnecessary and thus removed. oheger
update Commons Configuration now depends on Commons Digester 1.6 instead of 1.5. (This was done only to pick up the latest available release of digester.) oheger

Release 1.2-rc2 - 2005-11-23

TypeChangesBy
update ConfigurationDynaBean now implements the java.util.Map interface (as was stated in the javadocs). This was done by deriving the class from ConfigurationMap. Fixes 37486. oheger

Release 1.2-rc1 - 2005-11-11

TypeChangesBy
update The reload() method in AbstractFileConfiguration was updated to prevent reentrant invocation, which may be caused by some methods when they are called during a reloading operation. Fixes 36665. oheger
update AbstractHierarchicalFileConfiguration, a new base class for file based hierarchical configurations, was introduced. XMLConfiguration now extends this class. ebourg, oheger
update XMLConfiguration now prints the used encoding in the xml declaration of generated files. In earlier versions always the default encoding was written. PropertiesConfiguration now always uses the platform specific line separator when saving files. Fixes 37293. Thanks to Kay Doebl . oheger
update PropertiesConfiguration now translates properly the escaped unicode characters (like \u1234) used in the property keys. This complies with the specification of java.util.Properties. Fixes 36991. ebourg
update ConfigurationConverter.getProperties() now uses the delimiter of the specified configuration to convert the list properties into strings. Fixes 36784. ebourg
update The interpolation of variables (${foo}) is now performed in all property getters of AbstractConfiguration and DataConfiguration. As a side effect the Properties object returned by ConfigurationConverter.getProperties() contains only interpolated values. Fixes 36784. ebourg
update PropertiesConfiguration now uses the ISO-8859-1 encoding by default instead of the system encoding to comply with the specification of java.util.Properties. Fixes 36699. ebourg
update JNDIConfiguration no longer logs an error when attem pting to get a property that doesn't exist in the configuration. Fixes 36664. ebourg
update Attempting to load a configuration from a directory instead of a file will now throw a ConfigurationException. Fixes 36488. ebourg
update If a multi-valued property was involved in an interpolation operation, AbstractConfiguration created a string representation of the list of all values. This was changed to only use the first value, which makes more sense in this context and is consistent with other getters for single valued properties. Fixes 36447. oheger
add If an include file with a relative path cannot be found in the base path, PropertiesConfiguration now also tries to resolve it based on its own location. Fixes 36383. oheger
update Fixed MapConfiguration to store the list of values added under a same key instead of the last value added. Fixes 35945. Thanks to Steve Bate . ebourg
update Fixed a bug in the handling of relative file names in ConfigurationFactory: In most cases relative file names were not resolved relative to the location of the configuration definition file as stated in the documentation. This behavior was now changed to always be in sync with the documentation. This may have an impact on existing code which uses workarounds for the erroneous resolving mechanism. Fixes 35316. oheger
update Empty elements or elements whose content consists only of comments or whitespace are now taken into account by XMLConfiguration. They are added to the configuration; their value is an empty string. Fixes 35963. oheger
add XMLConfiguration now sets a valid system id in the InputSource used for loading files. This enables XML parsers to correctly resolve relative files, e.g. DTDs. oheger
update getKeys() in HierarchicalConfiguration now returns the keys in the same order the properties were inserted. Fixes 35903. ebourg
update Commons Configuration now depends on Commons Collections 3.1 instead of 3.0 ebourg
add New configurations implementing the "property list" format used in NeXT/OpenStep and its XML variant used in Mac OS X. (PropertyListConfiguration and XMLPropertyListConfiguration) Fixes 32633. ebourg
update Resolved some issues with XMLConfiguration and properties containing the delimiter character. These properties are now correctly treated, escaping the delimiter will work, too. Fixes 35938. oheger
add Added support for XMLPropertiesConfiguration in ConfigurationFactory. A < properties> element will generate a XMLPropertiesConfiguration if the filename ends with ".xml". ebourg
add PropertiesConfiguration now supports escaped key/value separators in the keys (i.e foo\:key = bar). Fixes 29192. ebourg
add PropertiesConfiguration now supports all key/value separators supported by java.util.Properties ('=', ':' and white space characters). Fixes 29171. ebourg
update Commons Configuration now depends on Commons Lang 2.1 instead of 2.0 ebourg
update Comment lines for PropertiesConfiguration can start with the '!' char (compatibility with java.util.Properties) Fixes 35888. ebourg
update Because ConfigurationUtils.copy() does not fully support hierarchical configurations a clone() method was added to HierarchicalConfiguration that can be used instead. Fixes 35772. oheger
add XMLConfiguration now provides some support for validating XML documents. With the setValidating() method DTD validation can be enabled. It is also possible to set a custom DocumentBuilder allowing a caller to perform enhanced configuration of the XML loading process. Fixes 31616. oheger
update AbstractFileConfiguration now always sets a valid base path if the configuration file could be located. This allows PropertiesConfiguration to resolve include files even when loaded from class path. Fixes 35621. oheger
update Updated XMLConfiguration to correctly deal with properties containing dots in their names. Such properties could not be accessed before. Fixes 35509. oheger
update PropertiesConfiguration's handling of backslash characters at the end of line was incorrect when there was an even number of trailing backslashes. This is now fixed. Fixes 35119. oheger
update Fixed a problem related to file based configurations that are loaded from a URL which is application/x-www-form-urlencoded: the save() method would store such files at a wrong location. Fixes 35210. oheger
update Updated FileChangedReloadingStrategy to use the file based configuration's source URL to find the file to watch. Before that it was possible that the strategy checked the wrong file. For configuration files loaded from a jar FileChangedReloadingStrategy now checks the jar file itself for changes. Finally a bug was fixed which caused the strategy to check the watched file's last change date on every invocation of its reloadingRequired() method ignoring its refresh delay. Thanks to Jorge Ferrer. Fixes 34289. oheger
update Fixed a bug in the collaboration between XMLConfiguration and its reloading strategy: The configuration did not check its reloading strategy, so no reload was performed. Fixes 35118. oheger
update Disabled auto save mode during PropertiesConfiguration.load(). Prior it was possible that the properties file to be loaded was immideately overwritten. Fixes 34410. oheger
update Under certain circumstances it was possible that a reloading strategy set for PropertiesConfiguration interferred with the save() method causing the configuration file to be erased. This has now been fixed. Fixes 34441. oheger
update AbstractFileConfiguration now stores the URL of the config file in the load() methods. This URL is reused by the save() method to ensure that the same file is written. Fixes 34362. Thanks to Jamie M. Guillemette . oheger
update XMLPropertiesConfiguration no longer depends on Digester to parse the configuration file, it's now implemented with a pure SAX parser. Thanks to Alistair Young . ebourg
update Fixed a bug which causes XMLConfiguration.save to lose attribute values under some circumstances. The clear() method now also ensures that the associated DOM document is always cleared. Fixes 34442. Thanks to Mi Zhang . oheger
update XMLConfiguration now parse the configuration using the encoding declared in the XML header instead of the OS default encoding. Fixes 34204. Thanks to Kunihara Tetsuya . ebourg
update XMLConfiguration now uses the delimiter set by setDelimiter(char). Thanks to Zsolt Koppany . ebourg

Release 1.1 - 2005-04-02

TypeChangesBy
update Fixed a ConcurrentModificationException thrown when calling clear() on a SubsetConfiguration applied to a BaseConfiguration. Fixes 33925. ebourg
update The resolveContainerStore() method in AbstractConfiguration now works properly with arrays of objects and arrays of primitives. This means it is possible to store an array of value in the configuration and retrieve the first element with the getString(), getInt()... methods. Fixes 34104. ebourg

Release 1.1-rc2 - 2005-03-06

TypeChangesBy
update Updated documentation for FileConfiguration's load() methods. Fixed a problem in XMLConfiguration with the output of the save() method when multiple files were loaded. Fixes 33814. oheger
update Fixed a bug in FileChangedReloadingStrategy preventing the detection of a file change in some cases. ebourg
update Changed getXXXArray() and getXXXList() in DataConfiguration to return an empty array/list for empty values. ebourg
update Fixed getLongArray(), getFloatArray() and getDoubleArray() in DataConfiguration, the values were cast into integers. Fixes 33524. ebourg

Release 1.1-rc1 - 2005-02-13

TypeChangesBy
add ConfigurationFactory now always configures digester to use the context classloader. This avoids problem s in application server environments, which use their own version of digester. Thanks to Mike Colbert for the patch! Fixes 33475. oheger
add Added a new configuration, XMLPropertiesConfiguration, supporting the new XML format for java.util.Properties introduced in Java 1.5. A 1.5 runtime is not required to use this class. Fixes 32318. ebourg
add Added a comment header to PropertiesConfiguration. The header is not parsed when the file is loaded yet. Fixes 26092. ebourg
add Added the setEncoding(String) and the getEncoding() methods to the FileConfiguration interface to control the encoding of the configuration file. ebourg
add Access to the top level element of the XML document is now provided. For newly created configurations this element can be changed before the document is written. Fixes 31136. oheger
update Merged the two XML related configuration classes into one new class XMLConfiguration. This new class should provide the best of its ancestors. Fixes 31429. oheger
update Replaced the PropertyTokenizer inner class in AbstractConfiguration with the split method in PropertyConverter. Also moved the method building an iterator on the elements of a composite value in PropertyConverter as toIterator(). ebourg
fix Some cleanup of the handling of the base path in file based configurations. The base path is now always taken into account. Fixes 30858. oheger
fix Calling getProperties on a JNDIConfiguration no longer throws an UnsupportedOperationException. ebourg
remove Removed the getPropertyDirect method from AbstractConfiguration, concrete configurations now implement directly the getProperty method from the Configuration interface. ebourg
add Added implementation of a save() method for HierarchicalXMLConfiguration. Fixes 31130. oheger
update Constructing a file based configuration with a File no longer throws an exception when the file doesn't exist. ebourg
add Saving a configuration now creates the path to the file if it doesn't exist. ebourg
update AbstractFileConfiguration.save(File) no longer fails silently when an error occurs, a ConfigurationException is thrown instead. Fixes 32020. ebourg
fix ConfigurationUtils.locate() now checks if the URL based resources exist. This fixes a bug preventing configuration files from being found if the configuration descriptor is in a JAR file (reported by Grant Ingersoll). ebourg
fix Fixed NPE that were caused in the constructors of file based configurations if an invalid file name was specified. Fixes 32236. oheger
add Added support for optional configuration sources in definition files for ConfigurationFactory. A new optional attribute allows to specify whether a configuration source is mandatory or optional. Fixes 31797. oheger
fix JNDIConfiguration.getKeys() now returns an empty iterator instead of throwing a ConfigurationRuntimeException when a NamingException occurs. The NamingExceptions are now logged. ebourg
fix DatabaseConfiguration.i sEmpty() now returns true if an SQLException occurs. ebourg
add Added two methods copy(Configuration, Configuration) and append(Configuration, Configuration) in ConfigurationUtils to copy properties between configurations. ebourg
update Moved the constructors implementations from PropertiesConfiguration and XMLConfiguration to AbstractFileConfiguration. ebourg
remove Remove deprecated getVector() implementations. epugh
add File based configurations can now be automatically reloaded when the underlying file is modified. Fixes 25661. ebourg
add Added a clear() method to the Configuration interface to remove all properties. Fixes 26102. ebourg
add Added a SystemConfiguration wrapping the system properties. ConfigurationFactory recognizes the corresponding < system/ > element. Fixes 26066. ebourg
add Added a MapConfiguration to turn any Map into a Configuration. The getConfiguration() methods in ConfigurationConverter now use MapConfiguration, as a result the Configuration returned is always synchronized with the underlying Properties or ExtendedProperties, changes made to the Configuration are available in the Properties, and reciprocally. ebourg
add The "autoSave" feature of XMLConfiguration has been generalized to all file based configurations. Fixes 31532. ebourg
add Numeric properties can now be specified in hexadecimal format, for example "number = 0xC5F0". Fixes 28026. ebourg
fix Fixed HierarchicalConfiguration.getKeys(String), it returned an empty iterator if the prefix string contained indices. Fixes 31745. oheger
add Added a DataConfiguration decorator providing getters for all useful types found in a configuration (URL, Locale, Date, Calendar, Color, lists and arrays) ebourg
add Added 5 new configurations to be used in a web environment: AppletConfiguration, ServletConfiguration, ServletContextConfiguration, ServletRequestConfiguration, ServletFilterConfiguration. ebourg

Release 1.0 - 2004-10-11

TypeChangesBy
fix The getStringArray() method in CompositeConfiguration now interpolates the strings. Fixes 29616. ebourg
fix SubsetConfiguration now shares the "throwExceptionOnMissing" property with its parent. Fixes 31540. ebourg
fix Removed "file:" at the beginning of the base path when calling setFile() on a FileConfiguration. This prevented auto saving an XMLConfiguration loaded from a File (issue reported by Mark Roth). ebourg
update All NamingEnumerations in JNDIConfiguraiton are now properly closed (Suggested by Eric Jung). ebourg
fix Properties added to an XMLConfiguration are no longer duplicated in the resulting XML file. Fixes 30799. ebourg

Release 1.0-rc2 - 2004-09-24

TypeChangesBy
update Unified the mechanisms for loading and saving file based configurations. PropertiesConfiguration, XMLConfiguration and HierarchicalXMLConfiguration now implement the same FileConfiguration interface. BasePathLoader, Bas ePathConfiguration, ClassPropertiesConfiguration and BasePropertiesConfiguration have been removed. ebourg
fix Replaced the calls to Boolean.booleanValue(boolean) in AbstractConfiguration and ConfigurationDynaBean to be Java 1.3 compatible. Fixes 31346. ebourg
fix Changing the prefix of a JNDIConfiguration will now reset the base context used. Fixes 31345. ebourg
add The context used by JNDIConfiguration can be specified in its constructor or through the setContext() method. The context can be accessed with the getContext() method which is now public. Thanks to Eric Jung . ebourg
add Make the behaviour on missing properties for the get methods that return objects configurable. A property throwExceptionOnMissingcan be set and then the getters throw an NoSuchElementException. The old default behaviour of returning a nullvalue has been restored. henning
add Allow configurations extending AbstractConfiguration to change the delimiter used from "," to something else. Fixes 29714. epugh
fix PropertiesConfiguration.save() method has issues with preserving the filename epugh
fix Test cases for HierarchicalConfigurationXMLReader stores comments as text nodes Fixes 30597. Thanks to Mark Woodman . epugh
fix Clarify for ConfigurationDynaBean that the get method should throw an illegalArgumentException if there is no property specified. Fixes 30545. Thanks to Ricardo Gladwell . epugh
fix Fixed a ClassCastException when adding a no n String property to an XMLConfiguration. Fixes 30839. ebourg
fix Fixed the handling of attribute properties by HierarchicalConfigurationConverter. Fixes 30655. Thanks to Oliver Heger . ebourg
fix Fixed a ClassCastException thrown on adding a non string property in a DatabaseConfiguration. Fixes 30676. ebourg
add Bring back the getVector() methods in the Configuration interface. These methods are needed for " drop-on " replacement of the various pre-1.0 commons-configuration snapshots and are already deprecated. These methods will be removed for 1.1. henning

Release 1.0-rc1 - 2004-08-14

TypeChangesBy
add HierarchicalConfigurationXMLReader stores comments as text nodes Fixes 30597. Thanks to Oliver Heger . epugh
add project.xml contains bad dependencies Fixes 30648. Thanks to Ricardo Gladwell . epugh
add clearXmlProperty doesn't remove list properties completely Fixes 30234. Thanks to Brent Worden . epugh
add new ConfigurationDynaBean Fixes 30545. Thanks to Ricardo Gladwell . epugh
add new ConfigurationMap and ConfigurationSet Fixes 29611. Thanks to Ricardo Gladwell . epugh
fix Problem adding property XMLConfiguration Fixes 30598. Thanks to Ricardo Gladwell . epugh
remove ConfigurationXMLDocument removed until post 1.0. epugh
fix DatabaseConfiguration doesn't support List properties. Fixes 29734. epugh
fix Fixed several bugs related to XMLConfiguration:
  • 30074 - Can't add a new property as an attribute in XMLConfiguration
  • 30205 - XMLConfiguration doesn't support attribute names with a dot
  • 30209 - XMLConfiguration doesn't ignore comments
  • 30212 - XMLConfiguration.save() doesn't escape reserved characters
ebourg
add Added save methods in XMLConfiguration similar to PropertiesConfiguration to save the configuration to another file (bug 29721). ebourg
update Removed the DOM4J implementations in favor of the DOM ones. DOMConfiguration has been renamed to XMLConfiguration, and HierarchicalDOMConfiguration to HierarchicalXMLConfiguration. The elements parsed by the ConfigurationFactory have been changed accordingly. ebourg
add Added a save() method to PropertiesConfiguration and save(Writer out), save(OutputStream out), save(OutputStream out, String encoding) to BasePropertiesConfiguration. ebourg
fix List values are now properly stored as comma separated values in the Properties object returned by ConfigurationConverter.getProperties() (Bug 29607) ebourg
update Introduced a ConversionException thrown when the value of a property is not compatible the type requested. It replaces the ClassCastException and the NumberFormatException thrown previously. ebourg
fix Tokens like ${ref} in a PropertyConfiguration are now properly saved (Bug 29366). ebourg
fix The getList() method of a CompositeConfiguration now returns the list composed of the elements in the first matching configuration and the additional elements foun d in the in memory configuration (Bug 28660). ebourg
fix SubsetConfiguration returns a List on getList(). AbstractConfiguration wouldn't properly deal with a List, only with a Container for getList()! Thanks to jschaible for the unit test. epugh
add Direct support of XML via DOM. New classes DOMConfiguration and HierarchicalDOMConfiguration. jschaible
update Update build to not include test configuration files in resulting jar. jschaible
update Refactored JNDIConfiguration to use AbstractConfiguration. ebourg
update Fixed bug 27427 by refactoring out the subset logic into a SubsetConfiguration. ebourg
fix Reapply the ConfigurationXMLDocument that went missing during migration out of sandbox. oheger
update Apply ASL 2.0 license. Thanks to Jeff Painter for scripting the conversion! epugh
add Changed CompositeConfiguration to extend from AbstractConfiuration. This means that the behavior of CompositeConfiguration is much similar to others like PropertiesConfiguration in handling of missing keys, interpolation, etc.. Previously CompositeConfiguration had quite a few differences. epugh
update Removed "defaults" from BaseConfiguration. Defaults are now done via using a CompositeConfiguration, either directly or via a ConfigurationFactory. if you want to save changes made to a Configuration, then you use a CompositeConfiguration and get back the inMemoryConfiguration that has the delta of changes. Added a bit of documentation on this. epugh
update Bugzill a 16504 Enhancement: Configuration Comparator epugh
update Bugzilla 26694 (BaseConfiguration: containsKey ignores default properties). I have changed it so that now the defaults are paid attention to. epugh
add The Configuration interface now supports BigDecimal and BigInteger numbers. ebourg
add ConfigurationException is now thrown by public methods instead of Exception or IOException or whatnot. epugh
add For configuration based on properties files, allow characters like \n etc to be escaped and unescaped. ebourg
add New DatabaseConfiguration that uses a database to store the properties. It supports 2 table structures :
  • one table per configuration (2 colums key/value)
  • one table for multiple configurations (2 columns key/value + 1 column for the name of the configuration)
ebourg
add ConfigurationFactory now supports the hierarchicalDom4j element in configuration definition file oheger
update Change all Vector objects to List objects. ebourg
add ConfigurationFactory now supports two types of properties files, additional and override. Additional properties add each other together. Override override each other. This allows you to have a single property that is either aggregated from a number of sources, or have a property that is overridden according to a specific order of sources. oheger
update AbstractConfiguration addProperty now delegates to an abstract addPropertyDirect implemented by BaseCo nfiguration. oheger
update Changed getString() method to throw a NoSuchElementException instead of "" if the configuration property doesn't exist. kshaposhnikov
add Added AbstractConfiguration to make it easier to create subclasses by only having to implement the methods required. kshaposhnikov
fix ClassPropertiesConfiguration Additions
  • Use the classloader of class that is provided by the constructor.
  • Add a constructor that indicates whether to use relative or absolute.
  • Change getPropertyStream to utilize the relative or absolute flag.
  • Add a test case that checks that absolute paths work.
bdunbar
fix JNDIConfiguration.getKeys() AdditionThe JNDIConfiguration.getKeys() method was returning an unsupported operation error. However, this is an important method to have supported. epugh
fix CompositeConfiguration.getKeys() FixThe CompositeConfiguration.getKeys() method was returning an unordered list of configuration values. However, many apps expect the order that keys are returned to be the order they are added into the properties file. epugh