You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@commons.apache.org by ps...@apache.org on 2015/06/01 00:24:05 UTC
svn commit: r953350 [18/37] - in
/websites/production/commons/content/proper/commons-pool: api-2.4.1/
api-2.4.1/org/ api-2.4.1/org/apache/ api-2.4.1/org/apache/commons/
api-2.4.1/org/apache/commons/pool2/
api-2.4.1/org/apache/commons/pool2/class-use/ a...
Added: websites/production/commons/content/proper/commons-pool/api-2.4.1/org/apache/commons/pool2/impl/GenericObjectPool.html
==============================================================================
--- websites/production/commons/content/proper/commons-pool/api-2.4.1/org/apache/commons/pool2/impl/GenericObjectPool.html (added)
+++ websites/production/commons/content/proper/commons-pool/api-2.4.1/org/apache/commons/pool2/impl/GenericObjectPool.html Sun May 31 22:24:03 2015
@@ -0,0 +1,1224 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc -->
+<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+<title>GenericObjectPool (Apache Commons Pool 2.4.1 API)</title>
+<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
+<script type="text/javascript" src="../../../../../script.js"></script>
+</head>
+<body>
+<script type="text/javascript"><!--
+ try {
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="GenericObjectPool (Apache Commons Pool 2.4.1 API)";
+ }
+ }
+ catch(err) {
+ }
+//-->
+var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10};
+var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
+var altColor = "altColor";
+var rowColor = "rowColor";
+var tableTab = "tableTab";
+var activeTableTab = "activeTableTab";
+</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="topNav"><a name="navbar.top">
+<!-- -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.top.firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../../overview-summary.html">Overview</a></li>
+<li><a href="package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="class-use/GenericObjectPool.html">Use</a></li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../../index-all.html">Index</a></li>
+<li><a href="../../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../../../org/apache/commons/pool2/impl/GenericKeyedObjectPoolMXBean.html" title="interface in org.apache.commons.pool2.impl"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPoolConfig.html" title="class in org.apache.commons.pool2.impl"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../index.html?org/apache/commons/pool2/impl/GenericObjectPool.html" target="_top">Frames</a></li>
+<li><a href="GenericObjectPool.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_top">
+<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_top");
+ if(window==top) {
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
+ }
+ //-->
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary: </li>
+<li>Nested | </li>
+<li><a href="#fields.inherited.from.class.org.apache.commons.pool2.impl.BaseGenericObjectPool">Field</a> | </li>
+<li><a href="#constructor.summary">Constr</a> | </li>
+<li><a href="#method.summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li>Field | </li>
+<li><a href="#constructor.detail">Constr</a> | </li>
+<li><a href="#method.detail">Method</a></li>
+</ul>
+</div>
+<a name="skip.navbar.top">
+<!-- -->
+</a></div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<!-- ======== START OF CLASS DATA ======== -->
+<div class="header">
+<div class="subTitle">org.apache.commons.pool2.impl</div>
+<h2 title="Class GenericObjectPool" class="title">Class GenericObjectPool<T></h2>
+</div>
+<div class="contentContainer">
+<ul class="inheritance">
+<li><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
+<li>
+<ul class="inheritance">
+<li><a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html" title="class in org.apache.commons.pool2.impl">org.apache.commons.pool2.impl.BaseGenericObjectPool</a><T></li>
+<li>
+<ul class="inheritance">
+<li>org.apache.commons.pool2.impl.GenericObjectPool<T></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl>
+<dt><span class="paramLabel">Type Parameters:</span></dt>
+<dd><code>T</code> - Type of element pooled in this pool.</dd>
+</dl>
+<dl>
+<dt>All Implemented Interfaces:</dt>
+<dd><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html" title="interface in org.apache.commons.pool2.impl">GenericObjectPoolMXBean</a>, <a href="../../../../../org/apache/commons/pool2/ObjectPool.html" title="interface in org.apache.commons.pool2">ObjectPool</a><T>, <a href="../../../../../org/apache/commons/pool2/UsageTracking.html" title="interface in org.apache.commons.pool2">UsageTracking</a><T></dd>
+</dl>
+<hr>
+<br>
+<pre>public class <a href="../../../../../src-html/org/apache/commons/pool2/impl/GenericObjectPool.html#line.79">GenericObjectPool</a><T>
+extends <a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html" title="class in org.apache.commons.pool2.impl">BaseGenericObjectPool</a><T>
+implements <a href="../../../../../org/apache/commons/pool2/ObjectPool.html" title="interface in org.apache.commons.pool2">ObjectPool</a><T>, <a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html" title="interface in org.apache.commons.pool2.impl">GenericObjectPoolMXBean</a>, <a href="../../../../../org/apache/commons/pool2/UsageTracking.html" title="interface in org.apache.commons.pool2">UsageTracking</a><T></pre>
+<div class="block">A configurable <a href="../../../../../org/apache/commons/pool2/ObjectPool.html" title="interface in org.apache.commons.pool2"><code>ObjectPool</code></a> implementation.
+ <p>
+ When coupled with the appropriate <a href="../../../../../org/apache/commons/pool2/PooledObjectFactory.html" title="interface in org.apache.commons.pool2"><code>PooledObjectFactory</code></a>,
+ <code>GenericObjectPool</code> provides robust pooling functionality for
+ arbitrary objects.</p>
+ <p>
+ Optionally, one may configure the pool to examine and possibly evict objects
+ as they sit idle in the pool and to ensure that a minimum number of idle
+ objects are available. This is performed by an "idle object eviction" thread,
+ which runs asynchronously. Caution should be used when configuring this
+ optional feature. Eviction runs contend with client threads for access to
+ objects in the pool, so if they run too frequently performance issues may
+ result.</p>
+ <p>
+ The pool can also be configured to detect and remove "abandoned" objects,
+ i.e. objects that have been checked out of the pool but neither used nor
+ returned before the configured
+ <a href="../../../../../org/apache/commons/pool2/impl/AbandonedConfig.html#getRemoveAbandonedTimeout--"><code>removeAbandonedTimeout</code></a>.
+ Abandoned object removal can be configured to happen when
+ <code>borrowObject</code> is invoked and the pool is close to starvation, or
+ it can be executed by the idle object evictor, or both. If pooled objects
+ implement the <a href="../../../../../org/apache/commons/pool2/TrackedUse.html" title="interface in org.apache.commons.pool2"><code>TrackedUse</code></a> interface, their last use will be queried
+ using the <code>getLastUsed</code> method on that interface; otherwise
+ abandonment is determined by how long an object has been checked out from
+ the pool.</p>
+ <p>
+ Implementation note: To prevent possible deadlocks, care has been taken to
+ ensure that no call to a factory method will occur within a synchronization
+ block. See POOL-125 and DBCP-44 for more information.</p>
+ <p>
+ This class is intended to be thread-safe.</p></div>
+<dl>
+<dt><span class="simpleTagLabel">Since:</span></dt>
+<dd>2.0</dd>
+<dt><span class="simpleTagLabel">Version:</span></dt>
+<dd>$Revision: 1679560 $</dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="../../../../../org/apache/commons/pool2/impl/GenericKeyedObjectPool.html" title="class in org.apache.commons.pool2.impl"><code>GenericKeyedObjectPool</code></a></dd>
+</dl>
+</li>
+</ul>
+</div>
+<div class="summary">
+<ul class="blockList">
+<li class="blockList">
+<!-- =========== FIELD SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="field.summary">
+<!-- -->
+</a>
+<h3>Field Summary</h3>
+<ul class="blockList">
+<li class="blockList"><a name="fields.inherited.from.class.org.apache.commons.pool2.impl.BaseGenericObjectPool">
+<!-- -->
+</a>
+<h3>Fields inherited from class org.apache.commons.pool2.impl.<a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html" title="class in org.apache.commons.pool2.impl">BaseGenericObjectPool</a></h3>
+<code><a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html#MEAN_TIMING_STATS_CACHE_SIZE">MEAN_TIMING_STATS_CACHE_SIZE</a></code></li>
+</ul>
+</li>
+</ul>
+<!-- ======== CONSTRUCTOR SUMMARY ======== -->
+<ul class="blockList">
+<li class="blockList"><a name="constructor.summary">
+<!-- -->
+</a>
+<h3>Constructor Summary</h3>
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
+<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colOne" scope="col">Constructor and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html#GenericObjectPool-org.apache.commons.pool2.PooledObjectFactory-">GenericObjectPool</a></span>(<a href="../../../../../org/apache/commons/pool2/PooledObjectFactory.html" title="interface in org.apache.commons.pool2">PooledObjectFactory</a><<a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html" title="type parameter in GenericObjectPool">T</a>> factory)</code>
+<div class="block">Create a new <code>GenericObjectPool</code> using defaults from
+ <a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPoolConfig.html" title="class in org.apache.commons.pool2.impl"><code>GenericObjectPoolConfig</code></a>.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html#GenericObjectPool-org.apache.commons.pool2.PooledObjectFactory-org.apache.commons.pool2.impl.GenericObjectPoolConfig-">GenericObjectPool</a></span>(<a href="../../../../../org/apache/commons/pool2/PooledObjectFactory.html" title="interface in org.apache.commons.pool2">PooledObjectFactory</a><<a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html" title="type parameter in GenericObjectPool">T</a>> factory,
+ <a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPoolConfig.html" title="class in org.apache.commons.pool2.impl">GenericObjectPoolConfig</a> config)</code>
+<div class="block">Create a new <code>GenericObjectPool</code> using a specific
+ configuration.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html#GenericObjectPool-org.apache.commons.pool2.PooledObjectFactory-org.apache.commons.pool2.impl.GenericObjectPoolConfig-org.apache.commons.pool2.impl.AbandonedConfig-">GenericObjectPool</a></span>(<a href="../../../../../org/apache/commons/pool2/PooledObjectFactory.html" title="interface in org.apache.commons.pool2">PooledObjectFactory</a><<a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html" title="type parameter in GenericObjectPool">T</a>> factory,
+ <a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPoolConfig.html" title="class in org.apache.commons.pool2.impl">GenericObjectPoolConfig</a> config,
+ <a href="../../../../../org/apache/commons/pool2/impl/AbandonedConfig.html" title="class in org.apache.commons.pool2.impl">AbandonedConfig</a> abandonedConfig)</code>
+<div class="block">Create a new <code>GenericObjectPool</code> that tracks and destroys
+ objects that are checked out, but never returned to the pool.</div>
+</td>
+</tr>
+</table>
+</li>
+</ul>
+<!-- ========== METHOD SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method.summary">
+<!-- -->
+</a>
+<h3>Method Summary</h3>
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
+<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Method and Description</th>
+</tr>
+<tr id="i0" class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html#addObject--">addObject</a></span>()</code>
+<div class="block">Create an object, and place it into the pool.</div>
+</td>
+</tr>
+<tr id="i1" class="rowColor">
+<td class="colFirst"><code><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html" title="type parameter in GenericObjectPool">T</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html#borrowObject--">borrowObject</a></span>()</code>
+<div class="block">Equivalent to <code><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html#borrowObject-long-"><code>borrowObject</code></a>(<a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getMaxWaitMillis--"><code>BaseGenericObjectPool.getMaxWaitMillis()</code></a>)</code>.</div>
+</td>
+</tr>
+<tr id="i2" class="altColor">
+<td class="colFirst"><code><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html" title="type parameter in GenericObjectPool">T</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html#borrowObject-long-">borrowObject</a></span>(long borrowMaxWaitMillis)</code>
+<div class="block">Borrow an object from the pool using the specific waiting time which only
+ applies if <a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getBlockWhenExhausted--"><code>BaseGenericObjectPool.getBlockWhenExhausted()</code></a> is true.</div>
+</td>
+</tr>
+<tr id="i3" class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html#clear--">clear</a></span>()</code>
+<div class="block">Clears any objects sitting idle in the pool by removing them from the
+ idle instance pool and then invoking the configured
+ <a href="../../../../../org/apache/commons/pool2/PooledObjectFactory.html#destroyObject-org.apache.commons.pool2.PooledObject-"><code>PooledObjectFactory.destroyObject(PooledObject)</code></a> method on each
+ idle instance.</div>
+</td>
+</tr>
+<tr id="i4" class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html#close--">close</a></span>()</code>
+<div class="block">Closes the pool.</div>
+</td>
+</tr>
+<tr id="i5" class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html#evict--">evict</a></span>()</code>
+<div class="block">Perform <code>numTests</code> idle object eviction tests, evicting
+ examined objects that meet the criteria for eviction.</div>
+</td>
+</tr>
+<tr id="i6" class="altColor">
+<td class="colFirst"><code><a href="../../../../../org/apache/commons/pool2/PooledObjectFactory.html" title="interface in org.apache.commons.pool2">PooledObjectFactory</a><<a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html" title="type parameter in GenericObjectPool">T</a>></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html#getFactory--">getFactory</a></span>()</code>
+<div class="block">Obtain a reference to the factory used to create, destroy and validate
+ the objects used by this pool.</div>
+</td>
+</tr>
+<tr id="i7" class="rowColor">
+<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html#getFactoryType--">getFactoryType</a></span>()</code>
+<div class="block">Return the type - including the specific type rather than the generic -
+ of the factory.</div>
+</td>
+</tr>
+<tr id="i8" class="altColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html#getLogAbandoned--">getLogAbandoned</a></span>()</code>
+<div class="block">Will this pool identify and log any abandoned objects?</div>
+</td>
+</tr>
+<tr id="i9" class="rowColor">
+<td class="colFirst"><code>int</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html#getMaxIdle--">getMaxIdle</a></span>()</code>
+<div class="block">Returns the cap on the number of "idle" instances in the pool.</div>
+</td>
+</tr>
+<tr id="i10" class="altColor">
+<td class="colFirst"><code>int</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html#getMinIdle--">getMinIdle</a></span>()</code>
+<div class="block">Returns the target for the minimum number of idle objects to maintain in
+ the pool.</div>
+</td>
+</tr>
+<tr id="i11" class="rowColor">
+<td class="colFirst"><code>int</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html#getNumActive--">getNumActive</a></span>()</code>
+<div class="block">Return the number of instances currently borrowed from this pool.</div>
+</td>
+</tr>
+<tr id="i12" class="altColor">
+<td class="colFirst"><code>int</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html#getNumIdle--">getNumIdle</a></span>()</code>
+<div class="block">The number of instances currently idle in this pool.</div>
+</td>
+</tr>
+<tr id="i13" class="rowColor">
+<td class="colFirst"><code>int</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html#getNumWaiters--">getNumWaiters</a></span>()</code>
+<div class="block">Return an estimate of the number of threads currently blocked waiting for
+ an object from the pool.</div>
+</td>
+</tr>
+<tr id="i14" class="altColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html#getRemoveAbandonedOnBorrow--">getRemoveAbandonedOnBorrow</a></span>()</code>
+<div class="block">Will a check be made for abandoned objects when an object is borrowed
+ from this pool?</div>
+</td>
+</tr>
+<tr id="i15" class="rowColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html#getRemoveAbandonedOnMaintenance--">getRemoveAbandonedOnMaintenance</a></span>()</code>
+<div class="block">Will a check be made for abandoned objects when the evictor runs?</div>
+</td>
+</tr>
+<tr id="i16" class="altColor">
+<td class="colFirst"><code>int</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html#getRemoveAbandonedTimeout--">getRemoveAbandonedTimeout</a></span>()</code>
+<div class="block">Obtain the timeout before which an object will be considered to be
+ abandoned by this pool.</div>
+</td>
+</tr>
+<tr id="i17" class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html#invalidateObject-T-">invalidateObject</a></span>(<a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html" title="type parameter in GenericObjectPool">T</a> obj)</code>
+<div class="block">Invalidates an object from the pool.</div>
+</td>
+</tr>
+<tr id="i18" class="altColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html#isAbandonedConfig--">isAbandonedConfig</a></span>()</code>
+<div class="block">Whether or not abandoned object removal is configured for this pool.</div>
+</td>
+</tr>
+<tr id="i19" class="rowColor">
+<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="../../../../../org/apache/commons/pool2/impl/DefaultPooledObjectInfo.html" title="class in org.apache.commons.pool2.impl">DefaultPooledObjectInfo</a>></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html#listAllObjects--">listAllObjects</a></span>()</code>
+<div class="block">Provides information on all the objects in the pool, both idle (waiting
+ to be borrowed) and active (currently borrowed).</div>
+</td>
+</tr>
+<tr id="i20" class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html#preparePool--">preparePool</a></span>()</code>
+<div class="block">Tries to ensure that <a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html#getMinIdle--"><code>getMinIdle()</code></a> idle instances are available
+ in the pool.</div>
+</td>
+</tr>
+<tr id="i21" class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html#returnObject-T-">returnObject</a></span>(<a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html" title="type parameter in GenericObjectPool">T</a> obj)</code>
+<div class="block">Return an instance to the pool.</div>
+</td>
+</tr>
+<tr id="i22" class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html#setAbandonedConfig-org.apache.commons.pool2.impl.AbandonedConfig-">setAbandonedConfig</a></span>(<a href="../../../../../org/apache/commons/pool2/impl/AbandonedConfig.html" title="class in org.apache.commons.pool2.impl">AbandonedConfig</a> abandonedConfig)</code>
+<div class="block">Sets the abandoned object removal configuration.</div>
+</td>
+</tr>
+<tr id="i23" class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html#setConfig-org.apache.commons.pool2.impl.GenericObjectPoolConfig-">setConfig</a></span>(<a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPoolConfig.html" title="class in org.apache.commons.pool2.impl">GenericObjectPoolConfig</a> conf)</code>
+<div class="block">Sets the base pool configuration.</div>
+</td>
+</tr>
+<tr id="i24" class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html#setMaxIdle-int-">setMaxIdle</a></span>(int maxIdle)</code>
+<div class="block">Returns the cap on the number of "idle" instances in the pool.</div>
+</td>
+</tr>
+<tr id="i25" class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html#setMinIdle-int-">setMinIdle</a></span>(int minIdle)</code>
+<div class="block">Sets the target for the minimum number of idle objects to maintain in
+ the pool.</div>
+</td>
+</tr>
+<tr id="i26" class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html#use-T-">use</a></span>(<a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html" title="type parameter in GenericObjectPool">T</a> pooledObject)</code>
+<div class="block">This method is called every time a pooled object to enable the pool to
+ better track borrowed objects.</div>
+</td>
+</tr>
+</table>
+<ul class="blockList">
+<li class="blockList"><a name="methods.inherited.from.class.org.apache.commons.pool2.impl.BaseGenericObjectPool">
+<!-- -->
+</a>
+<h3>Methods inherited from class org.apache.commons.pool2.impl.<a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html" title="class in org.apache.commons.pool2.impl">BaseGenericObjectPool</a></h3>
+<code><a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getBlockWhenExhausted--">getBlockWhenExhausted</a>, <a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getBorrowedCount--">getBorrowedCount</a>, <a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getCreatedCount--">getCreatedCount</a>, <a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getCreationStackTrace--">getCreationStackTrace</a>, <a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getDestroyedByBorrowValidationCount--">getDestroyedByBorrowValidationCount</a>, <a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getDestroyedByEvictorCount--">getDestroyedByEvictorCount</a>, <a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getDestroyedCount--">getDestroyedCount</a>, <a href="../../../../../org/apache/commons/pool2/imp
l/BaseGenericObjectPool.html#getEvictionPolicy--">getEvictionPolicy</a>, <a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getEvictionPolicyClassName--">getEvictionPolicyClassName</a>, <a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getFairness--">getFairness</a>, <a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getJmxName--">getJmxName</a>, <a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getLifo--">getLifo</a>, <a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getMaxBorrowWaitTimeMillis--">getMaxBorrowWaitTimeMillis</a>, <a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getMaxTotal--">getMaxTotal</a>, <a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getMaxWaitMillis--">getMaxWaitMillis</a>, <a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPo
ol.html#getMeanActiveTimeMillis--">getMeanActiveTimeMillis</a>, <a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getMeanBorrowWaitTimeMillis--">getMeanBorrowWaitTimeMillis</a>, <a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getMeanIdleTimeMillis--">getMeanIdleTimeMillis</a>, <a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getMinEvictableIdleTimeMillis--">getMinEvictableIdleTimeMillis</a>, <a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getNumTestsPerEvictionRun--">getNumTestsPerEvictionRun</a>, <a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getReturnedCount--">getReturnedCount</a>, <a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getSoftMinEvictableIdleTimeMillis--">getSoftMinEvictableIdleTimeMillis</a>, <a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getS
wallowedExceptionListener--">getSwallowedExceptionListener</a>, <a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getTestOnBorrow--">getTestOnBorrow</a>, <a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getTestOnCreate--">getTestOnCreate</a>, <a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getTestOnReturn--">getTestOnReturn</a>, <a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getTestWhileIdle--">getTestWhileIdle</a>, <a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getTimeBetweenEvictionRunsMillis--">getTimeBetweenEvictionRunsMillis</a>, <a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html#isClosed--">isClosed</a>, <a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html#setBlockWhenExhausted-boolean-">setBlockWhenExhausted</a>, <a href="../../../../../org/apache/commons/po
ol2/impl/BaseGenericObjectPool.html#setEvictionPolicyClassName-java.lang.String-">setEvictionPolicyClassName</a>, <a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html#setLifo-boolean-">setLifo</a>, <a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html#setMaxTotal-int-">setMaxTotal</a>, <a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html#setMaxWaitMillis-long-">setMaxWaitMillis</a>, <a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html#setMinEvictableIdleTimeMillis-long-">setMinEvictableIdleTimeMillis</a>, <a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html#setNumTestsPerEvictionRun-int-">setNumTestsPerEvictionRun</a>, <a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html#setSoftMinEvictableIdleTimeMillis-long-">setSoftMinEvictableIdleTimeMillis</a>, <a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjec
tPool.html#setSwallowedExceptionListener-org.apache.commons.pool2.SwallowedExceptionListener-">setSwallowedExceptionListener</a>, <a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html#setTestOnBorrow-boolean-">setTestOnBorrow</a>, <a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html#setTestOnCreate-boolean-">setTestOnCreate</a>, <a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html#setTestOnReturn-boolean-">setTestOnReturn</a>, <a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html#setTestWhileIdle-boolean-">setTestWhileIdle</a>, <a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html#setTimeBetweenEvictionRunsMillis-long-">setTimeBetweenEvictionRunsMillis</a></code></li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
+<!-- -->
+</a>
+<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
+<code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang
/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="methods.inherited.from.class.org.apache.commons.pool2.impl.GenericObjectPoolMXBean">
+<!-- -->
+</a>
+<h3>Methods inherited from interface org.apache.commons.pool2.impl.<a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html" title="interface in org.apache.commons.pool2.impl">GenericObjectPoolMXBean</a></h3>
+<code><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html#getBlockWhenExhausted--">getBlockWhenExhausted</a>, <a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html#getBorrowedCount--">getBorrowedCount</a>, <a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html#getCreatedCount--">getCreatedCount</a>, <a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html#getCreationStackTrace--">getCreationStackTrace</a>, <a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html#getDestroyedByBorrowValidationCount--">getDestroyedByBorrowValidationCount</a>, <a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html#getDestroyedByEvictorCount--">getDestroyedByEvictorCount</a>, <a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html#getDestroyedCount--">getDestroyedCount</a>, <a href="../../../../../org/apache/com
mons/pool2/impl/GenericObjectPoolMXBean.html#getFairness--">getFairness</a>, <a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html#getLifo--">getLifo</a>, <a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html#getMaxBorrowWaitTimeMillis--">getMaxBorrowWaitTimeMillis</a>, <a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html#getMaxTotal--">getMaxTotal</a>, <a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html#getMaxWaitMillis--">getMaxWaitMillis</a>, <a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html#getMeanActiveTimeMillis--">getMeanActiveTimeMillis</a>, <a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html#getMeanBorrowWaitTimeMillis--">getMeanBorrowWaitTimeMillis</a>, <a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html#getMeanIdleTimeMillis--">getMeanIdleTimeMillis</a>, <a href
="../../../../../org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html#getMinEvictableIdleTimeMillis--">getMinEvictableIdleTimeMillis</a>, <a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html#getNumTestsPerEvictionRun--">getNumTestsPerEvictionRun</a>, <a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html#getReturnedCount--">getReturnedCount</a>, <a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html#getTestOnBorrow--">getTestOnBorrow</a>, <a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html#getTestOnCreate--">getTestOnCreate</a>, <a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html#getTestOnReturn--">getTestOnReturn</a>, <a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html#getTestWhileIdle--">getTestWhileIdle</a>, <a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html#getTimeB
etweenEvictionRunsMillis--">getTimeBetweenEvictionRunsMillis</a>, <a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html#isClosed--">isClosed</a></code></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="details">
+<ul class="blockList">
+<li class="blockList">
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
+<ul class="blockList">
+<li class="blockList"><a name="constructor.detail">
+<!-- -->
+</a>
+<h3>Constructor Detail</h3>
+<a name="GenericObjectPool-org.apache.commons.pool2.PooledObjectFactory-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>GenericObjectPool</h4>
+<pre>public <a href="../../../../../src-html/org/apache/commons/pool2/impl/GenericObjectPool.html#line.89">GenericObjectPool</a>(<a href="../../../../../org/apache/commons/pool2/PooledObjectFactory.html" title="interface in org.apache.commons.pool2">PooledObjectFactory</a><<a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html" title="type parameter in GenericObjectPool">T</a>> factory)</pre>
+<div class="block">Create a new <code>GenericObjectPool</code> using defaults from
+ <a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPoolConfig.html" title="class in org.apache.commons.pool2.impl"><code>GenericObjectPoolConfig</code></a>.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>factory</code> - The object factory to be used to create object instances
+ used by this pool</dd>
+</dl>
+</li>
+</ul>
+<a name="GenericObjectPool-org.apache.commons.pool2.PooledObjectFactory-org.apache.commons.pool2.impl.GenericObjectPoolConfig-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>GenericObjectPool</h4>
+<pre>public <a href="../../../../../src-html/org/apache/commons/pool2/impl/GenericObjectPool.html#line.104">GenericObjectPool</a>(<a href="../../../../../org/apache/commons/pool2/PooledObjectFactory.html" title="interface in org.apache.commons.pool2">PooledObjectFactory</a><<a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html" title="type parameter in GenericObjectPool">T</a>> factory,
+ <a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPoolConfig.html" title="class in org.apache.commons.pool2.impl">GenericObjectPoolConfig</a> config)</pre>
+<div class="block">Create a new <code>GenericObjectPool</code> using a specific
+ configuration.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>factory</code> - The object factory to be used to create object instances
+ used by this pool</dd>
+<dd><code>config</code> - The configuration to use for this pool instance. The
+ configuration is used by value. Subsequent changes to
+ the configuration object will not be reflected in the
+ pool.</dd>
+</dl>
+</li>
+</ul>
+<a name="GenericObjectPool-org.apache.commons.pool2.PooledObjectFactory-org.apache.commons.pool2.impl.GenericObjectPoolConfig-org.apache.commons.pool2.impl.AbandonedConfig-">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>GenericObjectPool</h4>
+<pre>public <a href="../../../../../src-html/org/apache/commons/pool2/impl/GenericObjectPool.html#line.135">GenericObjectPool</a>(<a href="../../../../../org/apache/commons/pool2/PooledObjectFactory.html" title="interface in org.apache.commons.pool2">PooledObjectFactory</a><<a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html" title="type parameter in GenericObjectPool">T</a>> factory,
+ <a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPoolConfig.html" title="class in org.apache.commons.pool2.impl">GenericObjectPoolConfig</a> config,
+ <a href="../../../../../org/apache/commons/pool2/impl/AbandonedConfig.html" title="class in org.apache.commons.pool2.impl">AbandonedConfig</a> abandonedConfig)</pre>
+<div class="block">Create a new <code>GenericObjectPool</code> that tracks and destroys
+ objects that are checked out, but never returned to the pool.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>factory</code> - The object factory to be used to create object instances
+ used by this pool</dd>
+<dd><code>config</code> - The base pool configuration to use for this pool instance.
+ The configuration is used by value. Subsequent changes to
+ the configuration object will not be reflected in the
+ pool.</dd>
+<dd><code>abandonedConfig</code> - Configuration for abandoned object identification
+ and removal. The configuration is used by value.</dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+<!-- ============ METHOD DETAIL ========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method.detail">
+<!-- -->
+</a>
+<h3>Method Detail</h3>
+<a name="getMaxIdle--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getMaxIdle</h4>
+<pre>public int <a href="../../../../../src-html/org/apache/commons/pool2/impl/GenericObjectPool.html#line.156">getMaxIdle</a>()</pre>
+<div class="block">Returns the cap on the number of "idle" instances in the pool. If maxIdle
+ is set too low on heavily loaded systems it is possible you will see
+ objects being destroyed and almost immediately new objects being created.
+ This is a result of the active threads momentarily returning objects
+ faster than they are requesting them them, causing the number of idle
+ objects to rise above maxIdle. The best value for maxIdle for heavily
+ loaded system will vary but the default is a good starting point.</div>
+<dl>
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
+<dd><code><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html#getMaxIdle--">getMaxIdle</a></code> in interface <code><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html" title="interface in org.apache.commons.pool2.impl">GenericObjectPoolMXBean</a></code></dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the maximum number of "idle" instances that can be held in the
+ pool or a negative value if there is no limit</dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html#setMaxIdle-int-"><code>setMaxIdle(int)</code></a></dd>
+</dl>
+</li>
+</ul>
+<a name="setMaxIdle-int-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setMaxIdle</h4>
+<pre>public void <a href="../../../../../src-html/org/apache/commons/pool2/impl/GenericObjectPool.html#line.176">setMaxIdle</a>(int maxIdle)</pre>
+<div class="block">Returns the cap on the number of "idle" instances in the pool. If maxIdle
+ is set too low on heavily loaded systems it is possible you will see
+ objects being destroyed and almost immediately new objects being created.
+ This is a result of the active threads momentarily returning objects
+ faster than they are requesting them them, causing the number of idle
+ objects to rise above maxIdle. The best value for maxIdle for heavily
+ loaded system will vary but the default is a good starting point.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>maxIdle</code> - The cap on the number of "idle" instances in the pool. Use a
+ negative value to indicate an unlimited number of idle
+ instances</dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html#getMaxIdle--"><code>getMaxIdle()</code></a></dd>
+</dl>
+</li>
+</ul>
+<a name="setMinIdle-int-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setMinIdle</h4>
+<pre>public void <a href="../../../../../src-html/org/apache/commons/pool2/impl/GenericObjectPool.html#line.197">setMinIdle</a>(int minIdle)</pre>
+<div class="block">Sets the target for the minimum number of idle objects to maintain in
+ the pool. This setting only has an effect if it is positive and
+ <a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getTimeBetweenEvictionRunsMillis--"><code>BaseGenericObjectPool.getTimeBetweenEvictionRunsMillis()</code></a> is greater than zero. If this
+ is the case, an attempt is made to ensure that the pool has the required
+ minimum number of instances during idle object eviction runs.
+ <p>
+ If the configured value of minIdle is greater than the configured value
+ for maxIdle then the value of maxIdle will be used instead.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>minIdle</code> - The minimum number of objects.</dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html#getMinIdle--"><code>getMinIdle()</code></a>,
+<a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html#getMaxIdle--"><code>getMaxIdle()</code></a>,
+<a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getTimeBetweenEvictionRunsMillis--"><code>BaseGenericObjectPool.getTimeBetweenEvictionRunsMillis()</code></a></dd>
+</dl>
+</li>
+</ul>
+<a name="getMinIdle--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getMinIdle</h4>
+<pre>public int <a href="../../../../../src-html/org/apache/commons/pool2/impl/GenericObjectPool.html#line.218">getMinIdle</a>()</pre>
+<div class="block">Returns the target for the minimum number of idle objects to maintain in
+ the pool. This setting only has an effect if it is positive and
+ <a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getTimeBetweenEvictionRunsMillis--"><code>BaseGenericObjectPool.getTimeBetweenEvictionRunsMillis()</code></a> is greater than zero. If this
+ is the case, an attempt is made to ensure that the pool has the required
+ minimum number of instances during idle object eviction runs.
+ <p>
+ If the configured value of minIdle is greater than the configured value
+ for maxIdle then the value of maxIdle will be used instead.</div>
+<dl>
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
+<dd><code><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html#getMinIdle--">getMinIdle</a></code> in interface <code><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html" title="interface in org.apache.commons.pool2.impl">GenericObjectPoolMXBean</a></code></dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>The minimum number of objects.</dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html#setMinIdle-int-"><code>setMinIdle(int)</code></a>,
+<a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html#setMaxIdle-int-"><code>setMaxIdle(int)</code></a>,
+<a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html#setTimeBetweenEvictionRunsMillis-long-"><code>BaseGenericObjectPool.setTimeBetweenEvictionRunsMillis(long)</code></a></dd>
+</dl>
+</li>
+</ul>
+<a name="isAbandonedConfig--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>isAbandonedConfig</h4>
+<pre>public boolean <a href="../../../../../src-html/org/apache/commons/pool2/impl/GenericObjectPool.html#line.234">isAbandonedConfig</a>()</pre>
+<div class="block">Whether or not abandoned object removal is configured for this pool.</div>
+<dl>
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
+<dd><code><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html#isAbandonedConfig--">isAbandonedConfig</a></code> in interface <code><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html" title="interface in org.apache.commons.pool2.impl">GenericObjectPoolMXBean</a></code></dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>true if this pool is configured to detect and remove
+ abandoned objects</dd>
+</dl>
+</li>
+</ul>
+<a name="getLogAbandoned--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getLogAbandoned</h4>
+<pre>public boolean <a href="../../../../../src-html/org/apache/commons/pool2/impl/GenericObjectPool.html#line.247">getLogAbandoned</a>()</pre>
+<div class="block">Will this pool identify and log any abandoned objects?</div>
+<dl>
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
+<dd><code><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html#getLogAbandoned--">getLogAbandoned</a></code> in interface <code><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html" title="interface in org.apache.commons.pool2.impl">GenericObjectPoolMXBean</a></code></dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd><code>true</code> if abandoned object removal is configured for this
+ pool and removal events are to be logged otherwise <code>false</code></dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="../../../../../org/apache/commons/pool2/impl/AbandonedConfig.html#getLogAbandoned--"><code>AbandonedConfig.getLogAbandoned()</code></a></dd>
+</dl>
+</li>
+</ul>
+<a name="getRemoveAbandonedOnBorrow--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getRemoveAbandonedOnBorrow</h4>
+<pre>public boolean <a href="../../../../../src-html/org/apache/commons/pool2/impl/GenericObjectPool.html#line.262">getRemoveAbandonedOnBorrow</a>()</pre>
+<div class="block">Will a check be made for abandoned objects when an object is borrowed
+ from this pool?</div>
+<dl>
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
+<dd><code><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html#getRemoveAbandonedOnBorrow--">getRemoveAbandonedOnBorrow</a></code> in interface <code><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html" title="interface in org.apache.commons.pool2.impl">GenericObjectPoolMXBean</a></code></dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd><code>true</code> if abandoned object removal is configured to be
+ activated by borrowObject otherwise <code>false</code></dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="../../../../../org/apache/commons/pool2/impl/AbandonedConfig.html#getRemoveAbandonedOnBorrow--"><code>AbandonedConfig.getRemoveAbandonedOnBorrow()</code></a></dd>
+</dl>
+</li>
+</ul>
+<a name="getRemoveAbandonedOnMaintenance--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getRemoveAbandonedOnMaintenance</h4>
+<pre>public boolean <a href="../../../../../src-html/org/apache/commons/pool2/impl/GenericObjectPool.html#line.276">getRemoveAbandonedOnMaintenance</a>()</pre>
+<div class="block">Will a check be made for abandoned objects when the evictor runs?</div>
+<dl>
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
+<dd><code><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html#getRemoveAbandonedOnMaintenance--">getRemoveAbandonedOnMaintenance</a></code> in interface <code><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html" title="interface in org.apache.commons.pool2.impl">GenericObjectPoolMXBean</a></code></dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd><code>true</code> if abandoned object removal is configured to be
+ activated when the evictor runs otherwise <code>false</code></dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="../../../../../org/apache/commons/pool2/impl/AbandonedConfig.html#getRemoveAbandonedOnMaintenance--"><code>AbandonedConfig.getRemoveAbandonedOnMaintenance()</code></a></dd>
+</dl>
+</li>
+</ul>
+<a name="getRemoveAbandonedTimeout--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getRemoveAbandonedTimeout</h4>
+<pre>public int <a href="../../../../../src-html/org/apache/commons/pool2/impl/GenericObjectPool.html#line.291">getRemoveAbandonedTimeout</a>()</pre>
+<div class="block">Obtain the timeout before which an object will be considered to be
+ abandoned by this pool.</div>
+<dl>
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
+<dd><code><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html#getRemoveAbandonedTimeout--">getRemoveAbandonedTimeout</a></code> in interface <code><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html" title="interface in org.apache.commons.pool2.impl">GenericObjectPoolMXBean</a></code></dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>The abandoned object timeout in seconds if abandoned object
+ removal is configured for this pool; Integer.MAX_VALUE otherwise.</dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="../../../../../org/apache/commons/pool2/impl/AbandonedConfig.html#getRemoveAbandonedTimeout--"><code>AbandonedConfig.getRemoveAbandonedTimeout()</code></a></dd>
+</dl>
+</li>
+</ul>
+<a name="setConfig-org.apache.commons.pool2.impl.GenericObjectPoolConfig-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setConfig</h4>
+<pre>public void <a href="../../../../../src-html/org/apache/commons/pool2/impl/GenericObjectPool.html#line.304">setConfig</a>(<a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPoolConfig.html" title="class in org.apache.commons.pool2.impl">GenericObjectPoolConfig</a> conf)</pre>
+<div class="block">Sets the base pool configuration.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>conf</code> - the new configuration to use. This is used by value.</dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPoolConfig.html" title="class in org.apache.commons.pool2.impl"><code>GenericObjectPoolConfig</code></a></dd>
+</dl>
+</li>
+</ul>
+<a name="setAbandonedConfig-org.apache.commons.pool2.impl.AbandonedConfig-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setAbandonedConfig</h4>
+<pre>public void <a href="../../../../../src-html/org/apache/commons/pool2/impl/GenericObjectPool.html#line.331">setAbandonedConfig</a>(<a href="../../../../../org/apache/commons/pool2/impl/AbandonedConfig.html" title="class in org.apache.commons.pool2.impl">AbandonedConfig</a> abandonedConfig)
+ throws <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></pre>
+<div class="block">Sets the abandoned object removal configuration.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>abandonedConfig</code> - the new configuration to use. This is used by value.</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code></dd>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="../../../../../org/apache/commons/pool2/impl/AbandonedConfig.html" title="class in org.apache.commons.pool2.impl"><code>AbandonedConfig</code></a></dd>
+</dl>
+</li>
+</ul>
+<a name="getFactory--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getFactory</h4>
+<pre>public <a href="../../../../../org/apache/commons/pool2/PooledObjectFactory.html" title="interface in org.apache.commons.pool2">PooledObjectFactory</a><<a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html" title="type parameter in GenericObjectPool">T</a>> <a href="../../../../../src-html/org/apache/commons/pool2/impl/GenericObjectPool.html#line.351">getFactory</a>()</pre>
+<div class="block">Obtain a reference to the factory used to create, destroy and validate
+ the objects used by this pool.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the factory</dd>
+</dl>
+</li>
+</ul>
+<a name="borrowObject--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>borrowObject</h4>
+<pre>public <a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html" title="type parameter in GenericObjectPool">T</a> <a href="../../../../../src-html/org/apache/commons/pool2/impl/GenericObjectPool.html#line.362">borrowObject</a>()
+ throws <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
+<div class="block">Equivalent to <code><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html#borrowObject-long-"><code>borrowObject</code></a>(<a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getMaxWaitMillis--"><code>BaseGenericObjectPool.getMaxWaitMillis()</code></a>)</code>.
+ <p>
+ Obtains an instance from this pool.
+ <p>
+ Instances returned from this method will have been either newly created
+ with <a href="../../../../../org/apache/commons/pool2/PooledObjectFactory.html#makeObject--"><code>PooledObjectFactory.makeObject()</code></a> or will be a previously
+ idle object and have been activated with
+ <a href="../../../../../org/apache/commons/pool2/PooledObjectFactory.html#activateObject-org.apache.commons.pool2.PooledObject-"><code>PooledObjectFactory.activateObject(org.apache.commons.pool2.PooledObject<T>)</code></a> and then validated with
+ <a href="../../../../../org/apache/commons/pool2/PooledObjectFactory.html#validateObject-org.apache.commons.pool2.PooledObject-"><code>PooledObjectFactory.validateObject(org.apache.commons.pool2.PooledObject<T>)</code></a>.
+ <p>
+ By contract, clients <strong>must</strong> return the borrowed instance
+ using <a href="../../../../../org/apache/commons/pool2/ObjectPool.html#returnObject-T-"><code>ObjectPool.returnObject(T)</code></a>, <a href="../../../../../org/apache/commons/pool2/ObjectPool.html#invalidateObject-T-"><code>ObjectPool.invalidateObject(T)</code></a>, or a related
+ method as defined in an implementation or sub-interface.
+ <p>
+ The behaviour of this method when the pool has been exhausted
+ is not strictly specified (although it may be specified by
+ implementations).</div>
+<dl>
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
+<dd><code><a href="../../../../../org/apache/commons/pool2/ObjectPool.html#borrowObject--">borrowObject</a></code> in interface <code><a href="../../../../../org/apache/commons/pool2/ObjectPool.html" title="interface in org.apache.commons.pool2">ObjectPool</a><<a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html" title="type parameter in GenericObjectPool">T</a>></code></dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>an instance from this pool.</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - after <a href="../../../../../org/apache/commons/pool2/ObjectPool.html#close--"><code>close</code></a> has been called on this pool.</dd>
+<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - when <a href="../../../../../org/apache/commons/pool2/PooledObjectFactory.html#makeObject--"><code>PooledObjectFactory.makeObject()</code></a> throws an
+ exception.</dd>
+<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/util/NoSuchElementException.html?is-external=true" title="class or interface in java.util">NoSuchElementException</a></code> - when the pool is exhausted and cannot or will not return
+ another instance.</dd>
+</dl>
+</li>
+</ul>
+<a name="borrowObject-long-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>borrowObject</h4>
+<pre>public <a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html" title="type parameter in GenericObjectPool">T</a> <a href="../../../../../src-html/org/apache/commons/pool2/impl/GenericObjectPool.html#line.411">borrowObject</a>(long borrowMaxWaitMillis)
+ throws <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
+<div class="block">Borrow an object from the pool using the specific waiting time which only
+ applies if <a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getBlockWhenExhausted--"><code>BaseGenericObjectPool.getBlockWhenExhausted()</code></a> is true.
+ <p>
+ If there is one or more idle instance available in the pool, then an
+ idle instance will be selected based on the value of <a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getLifo--"><code>BaseGenericObjectPool.getLifo()</code></a>,
+ activated and returned. If activation fails, or <a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getTestOnBorrow--"><code>testOnBorrow</code></a> is set to <code>true</code> and validation fails, the
+ instance is destroyed and the next available instance is examined. This
+ continues until either a valid instance is returned or there are no more
+ idle instances available.
+ <p>
+ If there are no idle instances available in the pool, behavior depends on
+ the <a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getMaxTotal--"><code>maxTotal</code></a>, (if applicable)
+ <a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getBlockWhenExhausted--"><code>BaseGenericObjectPool.getBlockWhenExhausted()</code></a> and the value passed in to the
+ <code>borrowMaxWaitMillis</code> parameter. If the number of instances
+ checked out from the pool is less than <code>maxTotal,</code> a new
+ instance is created, activated and (if applicable) validated and returned
+ to the caller. If validation fails, a <code>NoSuchElementException</code>
+ is thrown.
+ <p>
+ If the pool is exhausted (no available idle instances and no capacity to
+ create new ones), this method will either block (if
+ <a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getBlockWhenExhausted--"><code>BaseGenericObjectPool.getBlockWhenExhausted()</code></a> is true) or throw a
+ <code>NoSuchElementException</code> (if
+ <a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getBlockWhenExhausted--"><code>BaseGenericObjectPool.getBlockWhenExhausted()</code></a> is false). The length of time that this
+ method will block when <a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getBlockWhenExhausted--"><code>BaseGenericObjectPool.getBlockWhenExhausted()</code></a> is true is
+ determined by the value passed in to the <code>borrowMaxWaitMillis</code>
+ parameter.
+ <p>
+ When the pool is exhausted, multiple calling threads may be
+ simultaneously blocked waiting for instances to become available. A
+ "fairness" algorithm has been implemented to ensure that threads receive
+ available instances in request arrival order.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>borrowMaxWaitMillis</code> - The time to wait in milliseconds for an object
+ to become available</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>object instance from the pool</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/util/NoSuchElementException.html?is-external=true" title="class or interface in java.util">NoSuchElementException</a></code> - if an instance cannot be returned</dd>
+<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if an object instance cannot be returned due to an
+ error</dd>
+</dl>
+</li>
+</ul>
+<a name="returnObject-java.lang.Object-">
+<!-- -->
+</a><a name="returnObject-T-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>returnObject</h4>
+<pre>public void <a href="../../../../../src-html/org/apache/commons/pool2/impl/GenericObjectPool.html#line.536">returnObject</a>(<a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html" title="type parameter in GenericObjectPool">T</a> obj)</pre>
+<div class="block">Return an instance to the pool. By contract, <code>obj</code>
+ <strong>must</strong> have been obtained using <a href="../../../../../org/apache/commons/pool2/ObjectPool.html#borrowObject--"><code>ObjectPool.borrowObject()</code></a> or
+ a related method as defined in an implementation or sub-interface.
+ <p>
+ If <a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html#getMaxIdle--"><code>maxIdle</code></a> is set to a positive value and the
+ number of idle instances has reached this value, the returning instance
+ is destroyed.
+ <p>
+ If <a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getTestOnReturn--"><code>testOnReturn</code></a> == true, the returning
+ instance is validated before being returned to the idle instance pool. In
+ this case, if validation fails, the instance is destroyed.
+ <p>
+ Exceptions encountered destroying objects for any reason are swallowed
+ but notified via a <a href="../../../../../org/apache/commons/pool2/SwallowedExceptionListener.html" title="interface in org.apache.commons.pool2"><code>SwallowedExceptionListener</code></a>.</div>
+<dl>
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
+<dd><code><a href="../../../../../org/apache/commons/pool2/ObjectPool.html#returnObject-T-">returnObject</a></code> in interface <code><a href="../../../../../org/apache/commons/pool2/ObjectPool.html" title="interface in org.apache.commons.pool2">ObjectPool</a><<a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html" title="type parameter in GenericObjectPool">T</a>></code></dd>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>obj</code> - a <a href="../../../../../org/apache/commons/pool2/ObjectPool.html#borrowObject--"><code>borrowed</code></a> instance to be returned.</dd>
+</dl>
+</li>
+</ul>
+<a name="invalidateObject-java.lang.Object-">
+<!-- -->
+</a><a name="invalidateObject-T-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>invalidateObject</h4>
+<pre>public void <a href="../../../../../src-html/org/apache/commons/pool2/impl/GenericObjectPool.html#line.634">invalidateObject</a>(<a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html" title="type parameter in GenericObjectPool">T</a> obj)
+ throws <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
+<div class="block">Invalidates an object from the pool.
+ <p>
+ By contract, <code>obj</code> <strong>must</strong> have been obtained
+ using <a href="../../../../../org/apache/commons/pool2/ObjectPool.html#borrowObject--"><code>ObjectPool.borrowObject()</code></a> or a related method as defined in an
+ implementation or sub-interface.
+ <p>
+ This method should be used when an object that has been borrowed is
+ determined (due to an exception or other problem) to be invalid.
+ <p>
+ Activation of this method decrements the active count and attempts to
+ destroy the instance.</div>
+<dl>
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
+<dd><code><a href="../../../../../org/apache/commons/pool2/ObjectPool.html#invalidateObject-T-">invalidateObject</a></code> in interface <code><a href="../../../../../org/apache/commons/pool2/ObjectPool.html" title="interface in org.apache.commons.pool2">ObjectPool</a><<a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html" title="type parameter in GenericObjectPool">T</a>></code></dd>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>obj</code> - a <a href="../../../../../org/apache/commons/pool2/ObjectPool.html#borrowObject--"><code>borrowed</code></a> instance to be disposed.</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if an exception occurs destroying the
+ object</dd>
+<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if obj does not belong to this pool</dd>
+</dl>
+</li>
+</ul>
+<a name="clear--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>clear</h4>
+<pre>public void <a href="../../../../../src-html/org/apache/commons/pool2/impl/GenericObjectPool.html#line.670">clear</a>()</pre>
+<div class="block">Clears any objects sitting idle in the pool by removing them from the
+ idle instance pool and then invoking the configured
+ <a href="../../../../../org/apache/commons/pool2/PooledObjectFactory.html#destroyObject-org.apache.commons.pool2.PooledObject-"><code>PooledObjectFactory.destroyObject(PooledObject)</code></a> method on each
+ idle instance.
+ <p>
+ Implementation notes:
+ <ul>
+ <li>This method does not destroy or effect in any way instances that are
+ checked out of the pool when it is invoked.</li>
+ <li>Invoking this method does not prevent objects being returned to the
+ idle instance pool, even during its execution. Additional instances may
+ be returned while removed items are being destroyed.</li>
+ <li>Exceptions encountered destroying idle instances are swallowed
+ but notified via a <a href="../../../../../org/apache/commons/pool2/SwallowedExceptionListener.html" title="interface in org.apache.commons.pool2"><code>SwallowedExceptionListener</code></a>.</li>
+ </ul></div>
+<dl>
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
+<dd><code><a href="../../../../../org/apache/commons/pool2/ObjectPool.html#clear--">clear</a></code> in interface <code><a href="../../../../../org/apache/commons/pool2/ObjectPool.html" title="interface in org.apache.commons.pool2">ObjectPool</a><<a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html" title="type parameter in GenericObjectPool">T</a>></code></dd>
+</dl>
+</li>
+</ul>
+<a name="getNumActive--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getNumActive</h4>
+<pre>public int <a href="../../../../../src-html/org/apache/commons/pool2/impl/GenericObjectPool.html#line.684">getNumActive</a>()</pre>
+<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/commons/pool2/ObjectPool.html#getNumActive--">ObjectPool</a></code></span></div>
+<div class="block">Return the number of instances currently borrowed from this pool. Returns
+ a negative value if this information is not available.</div>
+<dl>
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
+<dd><code><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html#getNumActive--">getNumActive</a></code> in interface <code><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html" title="interface in org.apache.commons.pool2.impl">GenericObjectPoolMXBean</a></code></dd>
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
+<dd><code><a href="../../../../../org/apache/commons/pool2/ObjectPool.html#getNumActive--">getNumActive</a></code> in interface <code><a href="../../../../../org/apache/commons/pool2/ObjectPool.html" title="interface in org.apache.commons.pool2">ObjectPool</a><<a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html" title="type parameter in GenericObjectPool">T</a>></code></dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the number of instances currently borrowed from this pool.</dd>
+</dl>
+</li>
+</ul>
+<a name="getNumIdle--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getNumIdle</h4>
+<pre>public int <a href="../../../../../src-html/org/apache/commons/pool2/impl/GenericObjectPool.html#line.689">getNumIdle</a>()</pre>
+<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getNumIdle--">BaseGenericObjectPool</a></code></span></div>
+<div class="block">The number of instances currently idle in this pool.</div>
+<dl>
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
+<dd><code><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html#getNumIdle--">getNumIdle</a></code> in interface <code><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html" title="interface in org.apache.commons.pool2.impl">GenericObjectPoolMXBean</a></code></dd>
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
+<dd><code><a href="../../../../../org/apache/commons/pool2/ObjectPool.html#getNumIdle--">getNumIdle</a></code> in interface <code><a href="../../../../../org/apache/commons/pool2/ObjectPool.html" title="interface in org.apache.commons.pool2">ObjectPool</a><<a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html" title="type parameter in GenericObjectPool">T</a>></code></dd>
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
+<dd><code><a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getNumIdle--">getNumIdle</a></code> in class <code><a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html" title="class in org.apache.commons.pool2.impl">BaseGenericObjectPool</a><<a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html" title="type parameter in GenericObjectPool">T</a>></code></dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>count of instances available for checkout from the pool</dd>
+</dl>
+</li>
+</ul>
+<a name="close--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>close</h4>
+<pre>public void <a href="../../../../../src-html/org/apache/commons/pool2/impl/GenericObjectPool.html#line.702">close</a>()</pre>
+<div class="block">Closes the pool. Once the pool is closed, <a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html#borrowObject--"><code>borrowObject()</code></a> will
+ fail with IllegalStateException, but <a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html#returnObject-T-"><code>returnObject(Object)</code></a> and
+ <a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html#invalidateObject-T-"><code>invalidateObject(Object)</code></a> will continue to work, with returned
+ objects destroyed on return.
+ <p>
+ Destroys idle instances in the pool by invoking <a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html#clear--"><code>clear()</code></a>.</div>
+<dl>
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
+<dd><code><a href="../../../../../org/apache/commons/pool2/ObjectPool.html#close--">close</a></code> in interface <code><a href="../../../../../org/apache/commons/pool2/ObjectPool.html" title="interface in org.apache.commons.pool2">ObjectPool</a><<a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html" title="type parameter in GenericObjectPool">T</a>></code></dd>
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
+<dd><code><a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html#close--">close</a></code> in class <code><a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html" title="class in org.apache.commons.pool2.impl">BaseGenericObjectPool</a><<a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html" title="type parameter in GenericObjectPool">T</a>></code></dd>
+</dl>
+</li>
+</ul>
+<a name="evict--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>evict</h4>
+<pre>public void <a href="../../../../../src-html/org/apache/commons/pool2/impl/GenericObjectPool.html#line.734">evict</a>()
+ throws <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
+<div class="block"><p>Perform <code>numTests</code> idle object eviction tests, evicting
+ examined objects that meet the criteria for eviction. If
+ <code>testWhileIdle</code> is true, examined objects are validated
+ when visited (and removed if invalid); otherwise only objects that
+ have been idle for more than <code>minEvicableIdleTimeMillis</code>
+ are removed.</p>
+ <p>
+ Successive activations of this method examine objects in sequence,
+ cycling through objects in oldest-to-youngest order.</div>
+<dl>
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
+<dd><code><a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html#evict--">evict</a></code> in class <code><a href="../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html" title="class in org.apache.commons.pool2.impl">BaseGenericObjectPool</a><<a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html" title="type parameter in GenericObjectPool">T</a>></code></dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - when there is a problem evicting idle objects.</dd>
+</dl>
+</li>
+</ul>
+<a name="preparePool--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>preparePool</h4>
+<pre>public void <a href="../../../../../src-html/org/apache/commons/pool2/impl/GenericObjectPool.html#line.840">preparePool</a>()
+ throws <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
+<div class="block">Tries to ensure that <a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html#getMinIdle--"><code>getMinIdle()</code></a> idle instances are available
+ in the pool.</div>
+<dl>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - If the associated factory throws an exception</dd>
+<dt><span class="simpleTagLabel">Since:</span></dt>
+<dd>2.4</dd>
+</dl>
+</li>
+</ul>
+<a name="addObject--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>addObject</h4>
+<pre>public void <a href="../../../../../src-html/org/apache/commons/pool2/impl/GenericObjectPool.html#line.955">addObject</a>()
+ throws <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
+<div class="block">Create an object, and place it into the pool. addObject() is useful for
+ "pre-loading" a pool with idle objects.
+ <p>
+ If there is no capacity available to add to the pool, this is a no-op
+ (no exception, no impact to the pool). </p></div>
+<dl>
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
+<dd><code><a href="../../../../../org/apache/commons/pool2/ObjectPool.html#addObject--">addObject</a></code> in interface <code><a href="../../../../../org/apache/commons/pool2/ObjectPool.html" title="interface in org.apache.commons.pool2">ObjectPool</a><<a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html" title="type parameter in GenericObjectPool">T</a>></code></dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - when <a href="../../../../../org/apache/commons/pool2/PooledObjectFactory.html#makeObject--"><code>PooledObjectFactory.makeObject()</code></a> fails.</dd>
+<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - after <a href="../../../../../org/apache/commons/pool2/ObjectPool.html#close--"><code>ObjectPool.close()</code></a> has been called on this pool.</dd>
+<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - when this pool cannot add new idle objects.</dd>
+</dl>
+</li>
+</ul>
+<a name="use-java.lang.Object-">
+<!-- -->
+</a><a name="use-T-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>use</h4>
+<pre>public void <a href="../../../../../src-html/org/apache/commons/pool2/impl/GenericObjectPool.html#line.1044">use</a>(<a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html" title="type parameter in GenericObjectPool">T</a> pooledObject)</pre>
+<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/commons/pool2/UsageTracking.html#use-T-">UsageTracking</a></code></span></div>
+<div class="block">This method is called every time a pooled object to enable the pool to
+ better track borrowed objects.</div>
+<dl>
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
+<dd><code><a href="../../../../../org/apache/commons/pool2/UsageTracking.html#use-T-">use</a></code> in interface <code><a href="../../../../../org/apache/commons/pool2/UsageTracking.html" title="interface in org.apache.commons.pool2">UsageTracking</a><<a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html" title="type parameter in GenericObjectPool">T</a>></code></dd>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>pooledObject</code> - The object that is being used</dd>
+</dl>
+</li>
+</ul>
+<a name="getNumWaiters--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getNumWaiters</h4>
+<pre>public int <a href="../../../../../src-html/org/apache/commons/pool2/impl/GenericObjectPool.html#line.1066">getNumWaiters</a>()</pre>
+<div class="block">Return an estimate of the number of threads currently blocked waiting for
+ an object from the pool. This is intended for monitoring only, not for
+ synchronization control.</div>
+<dl>
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
+<dd><code><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html#getNumWaiters--">getNumWaiters</a></code> in interface <code><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html" title="interface in org.apache.commons.pool2.impl">GenericObjectPoolMXBean</a></code></dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>The estimate of the number of threads currently blocked waiting
+ for an object from the pool</dd>
+</dl>
+</li>
+</ul>
+<a name="getFactoryType--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getFactoryType</h4>
+<pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/commons/pool2/impl/GenericObjectPool.html#line.1081">getFactoryType</a>()</pre>
+<div class="block">Return the type - including the specific type rather than the generic -
+ of the factory.</div>
+<dl>
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
+<dd><code><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html#getFactoryType--">getFactoryType</a></code> in interface <code><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html" title="interface in org.apache.commons.pool2.impl">GenericObjectPoolMXBean</a></code></dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>A string representation of the factory type</dd>
+</dl>
+</li>
+</ul>
+<a name="listAllObjects--">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>listAllObjects</h4>
+<pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="../../../../../org/apache/commons/pool2/impl/DefaultPooledObjectInfo.html" title="class in org.apache.commons.pool2.impl">DefaultPooledObjectInfo</a>> <a href="../../../../../src-html/org/apache/commons/pool2/impl/GenericObjectPool.html#line.1108">listAllObjects</a>()</pre>
+<div class="block">Provides information on all the objects in the pool, both idle (waiting
+ to be borrowed) and active (currently borrowed).
+ <p>
+ Note: This is named listAllObjects so it is presented as an operation via
+ JMX. That means it won't be invoked unless the explicitly requested
+ whereas all attributes will be automatically requested when viewing the
+ attributes for an object in a tool like JConsole.</div>
+<dl>
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
+<dd><code><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html#listAllObjects--">listAllObjects</a></code> in interface <code><a href="../../../../../org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html" title="interface in org.apache.commons.pool2.impl">GenericObjectPoolMXBean</a></code></dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>Information grouped on all the objects in the pool</dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
[... 67 lines stripped ...]