blob: cf126ae25ba26b5495ba668591efc41f81ea3014 [file] [log] [blame]
<?xml version="1.0"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<document>
<properties>
<title>Runtime dependencies</title>
<author email="ebourg@apache.org">Emmanuel Bourg</author>
</properties>
<body>
<section name="Runtime dependencies">
<p>
In the maven POM a lot of dependencies are declared. These are all
needed during compile time. On runtime however you only need to
add the dependencies to your classpath that are required by the
parts of the Commons Configuration package you are using. The
following table helps you to determine which dependencies you
have to include based on the components you intend to use:
</p>
<table>
<thead>
<tr>
<th width="30%">Component</th>
<th>Dependencies</th>
</tr>
</thead>
<tbody>
<tr>
<td>Core</td>
<td>
Java 1.3<br/>
commons-collections<br/>
commons-lang<br/>
commons-logging
</td>
</tr>
<tr>
<td>ConfigurationFactory</td>
<td>
commons-digester<br/>
commons-beanutils<br/>
JDK 1.4 or xml-apis
</td>
</tr>
<tr>
<td>DefaultConfigurationBuilder</td>
<td>
commons-beanutils<br/>
JDK 1.4 or (xml-apis + xerces + xalan)
</td>
</tr>
<tr>
<td>DatabaseConfiguration</td>
<td>JDBC 3.0 (Java 1.4 or jdbc2_0-stdext.jar)</td>
</tr>
<tr>
<td>XMLConfiguration</td>
<td>Java 1.4 or (xml-apis + xerces + xalan)</td>
</tr>
<tr>
<td>XMLPropertiesConfiguration</td>
<td>Java 1.4 or (xml-apis + xerces)</td>
</tr>
<tr>
<td>PropertyListConfiguration</td>
<td>commons-codec</td>
</tr>
<tr>
<td>XMLPropertyListConfiguration</td>
<td>
commons-digester<br/>
commons-beanutils<br/>
commons-codec<br/>
JDK 1.4 or xml-apis
</td>
</tr>
<tr>
<td>ConfigurationDynaBean</td>
<td>commons-beanutils</td>
</tr>
<tr>
<td>XPathExpressionEngine</td>
<td>commons-jxpath</td>
</tr>
</tbody>
</table>
<p>
<strong>Notes</strong>
</p>
<p>
<ul>
<li>Commons Configuration makes use of other
Commons components. You should be able to use the current
versions of these components together with Commons Configuration.
In some cases, when no specific features are used, older
versions will work, too. Below is a table with the version
numbers that have been tested:
<table>
<thead>
<tr>
<th>Component</th>
<th>Version</th>
</tr>
</thead>
<tbody>
<tr>
<td>commons-lang</td>
<td>2.2, 2.3</td>
</tr>
<tr>
<td>commons-collections</td>
<td>3.1, 3.2</td>
</tr>
<tr>
<td>commons-logging</td>
<td>1.0.4</td>
</tr>
<tr>
<td>commons-digester</td>
<td>1.6, 1.7, 1.8</td>
</tr>
<tr>
<td>commons-beanutils</td>
<td>1.7.0</td>
</tr>
<tr>
<td>commons-codec</td>
<td>1.3</td>
</tr>
<tr>
<td>commons-jxpath</td>
<td>1.2</td>
</tr>
</tbody>
</table>
</li>
<li>
In JDK versions before 1.4 XML support is not integrated. To
make use of components that require XML processing you need
to add a suitable replacement. We used
<a href="http://xml.apache.org/xerces2-j/">Xerces 2.2.1</a>,
<a href="http://xml.apache.org/xalan-j/">Xalan 2.7.0</a>, and
<a href="http://xml.apache.org/commons/">XML APIs 2.0.2</a>.
Version 2.7.0 of Xalan seems to cause some problems in a few
of our JUnit tests (a <code>java.lang.NoSuchMethodError</code>
is thrown when a SAX data source is to be transformed into a
DOM result). With version 2.6.0 these problems do not occur.
In both cases the error happened only in test code; the actual
code was not affected. But if you face a similar problem with
Xalan 2.7.0 it is worth trying the older version.
</li>
</ul>
</p>
</section>
</body>
</document>