Skip to content

Commit

Permalink
Add description of validatorClassName attribute to testXXXX attribute…
Browse files Browse the repository at this point in the history
…s in jdbc-pool docs.

git-svn-id: https://svn.apache.org/repos/asf/tomcat/tc7.0.x/trunk@1688171 13f79535-47bb-0310-9956-ffa450edef68
  • Loading branch information
Keiichi Fujino committed Jun 29, 2015
1 parent 3da33fd commit 4800162
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 5 deletions.
13 changes: 8 additions & 5 deletions modules/jdbc-pool/doc/jdbc-pool.xml
Original file line number Diff line number Diff line change
Expand Up @@ -258,7 +258,8 @@
<attribute name="testOnBorrow" required="false">
<p>(boolean) The indication of whether objects will be validated before being borrowed from the pool.
If the object fails to validate, it will be dropped from the pool, and we will attempt to borrow another.
NOTE - for a true value to have any effect, the <code>validationQuery</code> parameter must be set to a non-null string.
NOTE - for a true value to have any effect, the <code>validationQuery</code>
or <code>validatorClassName</code> parameter must be set to a non-null string.
In order to have a more efficient validation, see <code>validationInterval</code>.
Default value is <code>false</code>
</p>
Expand All @@ -267,23 +268,25 @@
<attribute name="testOnConnect" required="false">
<p>(boolean) The indication of whether objects will be validated when a connection is first created.
If an object fails to validate, it will be throw <code>SQLException</code>.
NOTE - for a true value to have any effect, the <code>validationQuery</code> or <code>initSQL</code>
parameter must be set to a non-null string.
NOTE - for a true value to have any effect, the <code>validationQuery</code>, <code>initSQL</code>
or <code>validatorClassName</code> parameter must be set to a non-null string.
Default value is <code>false</code>
</p>
</attribute>

<attribute name="testOnReturn" required="false">
<p>(boolean) The indication of whether objects will be validated before being returned to the pool.
NOTE - for a true value to have any effect, the <code>validationQuery</code> parameter must be set to a non-null string.
NOTE - for a true value to have any effect, the <code>validationQuery</code>
or <code>validatorClassName</code> parameter must be set to a non-null string.
The default value is <code>false</code>.
</p>
</attribute>

<attribute name="testWhileIdle" required="false">
<p>(boolean) The indication of whether objects will be validated by the idle object evictor (if any).
If an object fails to validate, it will be dropped from the pool.
NOTE - for a true value to have any effect, the <code>validationQuery</code> parameter must be set to a non-null string.
NOTE - for a true value to have any effect, the <code>validationQuery</code>
or <code>validatorClassName</code> parameter must be set to a non-null string.
The default value is <code>false</code> and this property has to be set in order for the
pool cleaner/test thread is to run (also see <code>timeBetweenEvictionRunsMillis</code>)
</p>
Expand Down
4 changes: 4 additions & 0 deletions webapps/docs/changelog.xml
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,10 @@
<bug>57758</bug>: Add document of <code>testOnConnect</code> attribute
in jdbc-pool doc. (kfujino)
</add>
<add>
Add description of <code>validatorClassName</code> attribute to testXXXX
attributes in jdbc-pool docs. (kfujino)
</add>
</changelog>
</subsection>
<subsection name="Tribes">
Expand Down

0 comments on commit 4800162

Please sign in to comment.