Skip to content

Commit

Permalink
Port site from Doxia 1 to 2
Browse files Browse the repository at this point in the history
  • Loading branch information
garydgregory committed Feb 1, 2025
1 parent 2f3b046 commit c4ef211
Show file tree
Hide file tree
Showing 7 changed files with 36 additions and 47 deletions.
1 change: 1 addition & 0 deletions src/changes/changes.xml
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ The <action> type attribute can be add,update,fix,remove.
<!-- UPDATE -->
<action type="update" dev="ggregory" due-to="Gary Gregory">Bump org.apache.commons:commons-parent from 78 to 81.</action>
<action type="update" dev="ggregory" due-to="Gary Gregory">Bump org.apache.commons:commons-pool2 from 2.12.0 to 2.12.1 #474.</action>
<action type="update" dev="ggregory" due-to="Gary Gregory">Port site from Doxia 1 to 2.</action>
<!-- REMOVE -->
<action type="remove" dev="ggregory" due-to="Gary Gregory">Removed internal constructors and methods from the package-private class CPDSConnectionFactory; this is binary compatible.</action>
<action type="remove" dev="ggregory" due-to="Gary Gregory">Removed an internal constructor and methods from the package-private class KeyedCPDSConnectionFactory; this is binary compatible.</action>
Expand Down
4 changes: 3 additions & 1 deletion src/site/xdoc/building.xml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,9 @@ 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>
<document xmlns="http://maven.apache.org/XDOC/2.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 https://maven.apache.org/xsd/xdoc-2.0.xsd">
<properties>
<title>Building</title>
<author email="[email protected]">Commons Documentation Team</author>
Expand Down
37 changes: 18 additions & 19 deletions src/site/xdoc/configuration.xml
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,9 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
<document>

<document xmlns="http://maven.apache.org/XDOC/2.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 https://maven.apache.org/xsd/xdoc-2.0.xsd">
<properties>
<title>BasicDataSource Configuration</title>
<author email="[email protected]">Commons Documentation Team</author>
Expand Down Expand Up @@ -49,7 +50,7 @@ testWhileIdle
<section name="BasicDataSource Configuration Parameters">

<table>
<hr><th>Parameter</th><th>Description</th></hr>
<tr><th>Parameter</th><th>Description</th></tr>
<tr>
<td>username</td>
<td>The connection user name to be passed to our JDBC driver to establish a connection.</td>
Expand Down Expand Up @@ -78,7 +79,7 @@ testWhileIdle


<table>
<hr><th>Parameter</th><th>Default</th><th>Description</th></hr>
<tr><th>Parameter</th><th>Default</th><th>Description</th></tr>
<tr>
<td>defaultAutoCommit</td>
<td>driver default</td>
Expand Down Expand Up @@ -150,7 +151,7 @@ testWhileIdle


<table>
<hr><th>Parameter</th><th>Default</th><th>Description</th></hr>
<tr><th>Parameter</th><th>Default</th><th>Description</th></tr>
<tr>
<td>initialSize</td>
<td>0</td>
Expand Down Expand Up @@ -195,7 +196,7 @@ testWhileIdle
</tr>
</table>
<p>
<img src="images/icon_warning_sml.gif"/>
<img src="images/icon_warning_sml.gif" alt="Warning"/>
<strong>NOTE</strong>: If maxIdle is set too low on heavily loaded systems it is
possible you will see connections being closed and almost immediately new
connections being opened. This is a result of the active threads momentarily
Expand All @@ -206,7 +207,7 @@ loaded system will vary but the default is a good starting point.


<table>
<hr><th>Parameter</th><th>Default</th><th>Description</th></hr>
<tr><th>Parameter</th><th>Default</th><th>Description</th></tr>
<tr>
<td>validationQuery</td>
<td></td>
Expand Down Expand Up @@ -342,7 +343,7 @@ isValid() method.
</table>

<table>
<hr><th>Parameter</th><th>Default</th><th>Description</th></hr><tr>
<tr><th>Parameter</th><th>Default</th><th>Description</th></tr><tr>
<td>poolPreparedStatements</td>
<td>false</td>
<td>Enable prepared statement pooling for this pool.</td>
Expand All @@ -357,27 +358,26 @@ isValid() method.
</tr>
</table>
<p>
<img src="images/icon_info_sml.gif"/>
<img src="images/icon_info_sml.gif" alt="Info"/>
This component has also the ability to pool PreparedStatements.
When enabled a statement pool will be created for each Connection
and PreparedStatements created by one of the following methods will be pooled:
</p>
<ul>
<li>public PreparedStatement prepareStatement(String sql)</li>
<li>public PreparedStatement prepareStatement(String sql, int resultSetType, int resultSetConcurrency)</li>
</ul>
</p>
<p>
<img src="images/icon_warning_sml.gif"/>
<img src="images/icon_warning_sml.gif" alt="Warning"/>
<strong>NOTE</strong> - Make sure your connection has some resources left for the other statements.
Pooling PreparedStatements may keep their cursors open in the database, causing a connection to run out of cursors,
especially if maxOpenPreparedStatements is left at the default (unlimited) and an application opens a large number
of different PreparedStatements per connection. To avoid this problem, maxOpenPreparedStatements should be set to a
value less than the maximum number of cursors that can be open on a Connection.
</p>


<table>
<hr><th>Parameter</th><th>Default</th><th>Description</th></hr><tr>
<tr><th>Parameter</th><th>Default</th><th>Description</th></tr><tr>
<td>accessToUnderlyingConnectionAllowed</td>
<td>false</td>
<td>Controls if the PoolGuard allows access to the underlying connection.</td>
Expand All @@ -391,18 +391,17 @@ value less than the maximum number of cursors that can be open on a Connection.
conn.close()
</source>
<p>
<img src="images/icon_info_sml.gif"/>
<img src="images/icon_info_sml.gif" alt="Info"/>
Default is false, it is a potential dangerous operation and misbehaving programs can do harmful things. (closing the underlying or continue using it when the guarded connection is already closed)
Be careful and only use when you need direct access to driver specific extensions.
</p>
<p>
<img src="images/icon_warning_sml.gif"/>
<img src="images/icon_warning_sml.gif" alt="Warning"/>
<b>NOTE:</b> Do not close the underlying connection, only the original one.
</p>


<table>
<hr><th>Parameter</th><th>Default</th><th>Description</th></hr>
<tr><th>Parameter</th><th>Default</th><th>Description</th></tr>
<tr>
<td>removeAbandonedOnMaintenance <br/>
removeAbandonedOnBorrow
Expand Down Expand Up @@ -455,7 +454,7 @@ Be careful and only use when you need direct access to driver specific extension
</tr>
</table>
<p>
<img src="images/icon_info_sml.gif"/>
<img src="images/icon_info_sml.gif" alt="Info"/>
If you have enabled removeAbandonedOnMaintenance or removeAbandonedOnBorrow then it is possible that
a connection is reclaimed by the pool because it is considered to be abandoned. This mechanism is triggered
when (getNumIdle() &lt; 2) and (getNumActive() &gt; getMaxTotal() - 3) and removeAbandonedOnBorrow is true;
Expand All @@ -467,7 +466,7 @@ using one of these to execute a query (using one of the execute methods) resets
the parent connection.
</p>
<table>
<hr><th>Parameter</th><th>Default</th><th>Description</th></hr>
<tr><th>Parameter</th><th>Default</th><th>Description</th></tr>
<tr>
<td>fastFailValidation</td>
<td>false</td>
Expand Down
5 changes: 3 additions & 2 deletions src/site/xdoc/index.xml
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,9 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
<document>

<document xmlns="http://maven.apache.org/XDOC/2.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 https://maven.apache.org/xsd/xdoc-2.0.xsd">
<properties>
<title>Overview</title>
<author email="[email protected]">Commons Documentation Team</author>
Expand Down
17 changes: 4 additions & 13 deletions src/site/xdoc/release-notes-1.1.xml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,9 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
<document>
<document xmlns="http://maven.apache.org/XDOC/2.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 https://maven.apache.org/xsd/xdoc-2.0.xsd">
<properties>
<title>Release notes for Commons-DBCP 1.1</title>
<author email="[email protected]">Commons Documentation Team</author>
Expand All @@ -25,30 +27,22 @@
<section name="Release notes for Commons-DBCP 1.1">
<p>
There were a lot changes since the 1.0 release on 12 Aug 2002.
</p>
<ul>
<li>All existing features can now be configured by JNDI Context providers (Tomcat)</li>
<br/>
<li>The double close() of a pooled connection is more effectively blocked
(you may experience more "Already closed" SQLExceptions)</li>
<br/>
<li>Prepared statement pooling is now implemented in BasicDataSource
(set poolPreparedStatements=true, maxOpenPreparedStatements=xxx)</li>
<br/>
<li>Access to the underlying connection is blocked by default
You can access the underlying connection by setting
accessToUnderlyingConnectionAllowed=true and by using the following construct:
Connection dconn = ((DelegatingConnection) conn).getInnermostDelegate();</li>
<br/>
<li>New minIdle parameter for a minimum number of idle connections ready for use</li>
<br/>
<li>New connection default properties: defaultCatalog and defaultTransactionIsolation</li>
<br/>
<li>Missing driverClassName will now give the following error "No suitable driver"</li>
<br/>
<li>Bad validationQuery will produce a meaningful SQLException</li>
<br/>
<li>UML Class and sequence diagrams, configuration documentation</li>
<br/>
<li>The following issues were resolved since v1.0: (see Bugzilla for complete description)
<table>
<tr><th>ID</th><th>Date</th><th>Sev</th><th>State</th><th>Summary</th></tr>
Expand Down Expand Up @@ -132,23 +126,20 @@ There were a lot changes since the 1.0 release on 12 Aug 2002.
<tr><td><a href="https://issues.apache.org/bugzilla/show_bug.cgi?id=23304">23304</a></td><td>2003-09-21</td><td>Nor</td><td>FIXE</td><td>NullpointerException when no driverClassName is specified</td></tr>
</table>
</li>
<br/>
<li>The following issues were resolved since v1.1RC1:
<table>
<tr><th>ID</th><th>Date</th><th>Sev</th><th>State</th><th>Summary</th></tr>
<tr><td><a href="https://issues.apache.org/bugzilla/show_bug.cgi?id=22776">22776</a></td><td>2003-09-30</td><td>Nor</td><td>FIXE</td><td>DBCP should not be writing messages to stderr or stdout (removed unneeded logging in AbandonedObjectPool)</td></tr>
<tr><td><a href="https://issues.apache.org/bugzilla/show_bug.cgi?id=23491">23491</a></td><td>2003-10-13</td><td>Cri</td><td>FIXE</td><td>Can't configure PerUserPoolDataSource for use with tomcat, <a href="https://commons.apache.org/dbcp/apidocs/org/apache/commons/dbcp/datasources/package-summary.html">more...</a></td></tr>
</table>
</li>
<br/>
<li>The following issues were resolved since v1.1RC2:
<table>
<tr><th>ID</th><th>Date</th><th>Sev</th><th>State</th><th>Summary</th></tr>
<tr><td><a href="https://issues.apache.org/bugzilla/show_bug.cgi?id=23843">23843</a></td><td>2003-10-20</td><td>Blo</td><td>FIXE</td><td>PerUserPoolDataSource.getConnection(username, pw) may return connection under wrong username</td></tr>
</table>
</li>
</ul>
</p>
</section>
</body>
</document>
Expand Down
4 changes: 3 additions & 1 deletion src/site/xdoc/release-notes-1.2.1.xml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,9 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
<document>
<document xmlns="http://maven.apache.org/XDOC/2.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 https://maven.apache.org/xsd/xdoc-2.0.xsd">
<properties>
<title>Release notes for Commons-DBCP 1.2.1</title>
<author email="[email protected]">Commons Documentation Team</author>
Expand Down
15 changes: 4 additions & 11 deletions src/site/xdoc/release-notes-1.2.xml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,9 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
<document>
<document xmlns="http://maven.apache.org/XDOC/2.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 https://maven.apache.org/xsd/xdoc-2.0.xsd">
<properties>
<title>Release notes for Commons-DBCP 1.2</title>
<author email="[email protected]">Commons Documentation Team</author>
Expand All @@ -29,26 +31,18 @@

<p>
There were some new features were added since the 1.1 release on 20 October 2003.
</p>
<ul>
<li>Performance optimizations for the PoolableConnectionFactory of BasicDataSource.</li>
<br/>
<li>Add BasicDataSourceFactory.createDataSource(Properties properties) for creating a BasicDataSource.</li>
<br/>
<li>Add initialSize parameter to do pre-loading of the connection.</li>
<br/>
<li>Refactoring of the DelegatingStatement classes.</li>
<br/>
<li>Make some properties dynamic (changeable at runtime), this will be completed in next release.</li>
<br/>
<li>Improvements to the prepared statement pooling.</li>
<br/>
<li>Driver specific changes/optimizations for: Oracle, Informix, DaffodilDB.</li>
<br/>
<li>Several fixes for PerUserPoolDataSource</li>
<br/>
<li>PoolingDriver uses now a PoolGuardConnectionWrapper by default. If access to the
underlying connection is needed, you have to enable it: PoolingDriver.setAccessToUnderlyingConnectionAllowed(true)</li>
<br/>

<li>The following issues were resolved since v1.1: (see Bugzilla for complete description)
<table>
Expand Down Expand Up @@ -86,7 +80,6 @@ underlying connection is needed, you have to enable it: PoolingDriver.setAccessT
</table>
</li>
</ul>
</p>
</section>
</body>
</document>
Expand Down

0 comments on commit c4ef211

Please sign in to comment.