Author: psteitz
Date: Sat Mar 21 19:43:46 2009
New Revision: 756999
URL: http://svn.apache.org/viewvc?rev=756999&view=rev
Log:
Javadoc only. Clarified contract of removeAbandoned.
Modified:
commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/BasicDataSource.java
Modified:
commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/BasicDataSource.java
URL:
http://svn.apache.org/viewvc/commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/BasicDataSource.java?rev=756999&r1=756998&r2=756999&view=diff
==============================================================================
---
commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/BasicDataSource.java
(original)
+++
commons/proper/dbcp/trunk/src/java/org/apache/commons/dbcp/BasicDataSource.java
Sat Mar 21 19:43:46 2009
@@ -1100,7 +1100,13 @@
* If set to true a connection is considered abandoned and eligible
* for removal if it has been idle longer than the removeAbandonedTimeout.
* Setting this to true can recover db connections from poorly written
- * applications which fail to close a connection.
+ * applications which fail to close a connection.
+ * <p>
+ * Abandonded connections are identified and removed when
+ * {...@link #getConnection()} is invoked and the following conditions hold
+ * <ul><li>{...@link #getRemoveAbandoned()} = true </li>
+ * <li>{...@link #getNumActive()} > {...@link #getMaxActive()} - 3
</li>
+ * <li>{...@link #getNumIdle()} < 2 </li></ul></p>
* @deprecated
*/
public boolean getRemoveAbandoned() {
@@ -1113,6 +1119,7 @@
/**
* @deprecated
* @param removeAbandoned new removeAbandoned property value
+ * @see #getRemoveAbandoned()
*/
public void setRemoveAbandoned(boolean removeAbandoned) {
if (abandonedConfig == null) {
