rwaldhoff 02/04/29 05:16:23
Modified: docs/pool index.html
Log:
expanded pool index doc
Revision Changes Path
1.2 +181 -0 jakarta-commons/docs/pool/index.html
Index: index.html
===================================================================
RCS file: /home/cvs/jakarta-commons/docs/pool/index.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- index.html 23 Apr 2002 00:22:45 -0000 1.1
+++ index.html 29 Apr 2002 12:16:23 -0000 1.2
@@ -101,6 +101,187 @@
</td></tr>
<tr><td><br/></td></tr>
</table>
+ <table border="0" cellspacing="0"
cellpadding="2" width="100%">
+ <tr><td bgcolor="#525D76">
+ <font color="#ffffff" face="arial,helvetica,sanserif">
+ <a name="Features"><strong>Features</strong></a>
+ </font>
+ </td></tr>
+ <tr><td>
+ <blockquote>
+ <p>
+ The
+ <a
href="http://nagoya.apache.org/gump/javadoc/jakarta-commons/pool/dist/docs/api/org/apache/commons/pool/package-summary.html";>org.apache.commons.pool</a>
+ package defines a handful of pooling interfaces and some base classes
+ that may be useful when creating new pool implementations.
+ </p>
+ <table border="0"
cellspacing="0" cellpadding="2" width="100%">
+ <tr><td bgcolor="#828DA6">
+ <font color="#ffffff" face="arial,helvetica,sanserif">
+ <a name="ObjectPool"><strong>ObjectPool</strong></a>
+ </font>
+ </td></tr>
+ <tr><td>
+ <blockquote>
+ <p>
+ <a
href="http://nagoya.apache.org/gump/javadoc/jakarta-commons/pool/dist/docs/api/org/apache/commons/pool/ObjectPool.html";><code>ObjectPool</code></a>
+ defines a trivially simple pooling interface:
+ </p>
+ <pre>
+ public interface ObjectPool {
+ Object borrowObject();
+ void returnObject(Object borrowed);
+ }
+ </pre>
+ <p>
+ Some client classes won't integrate with <i>Pool</i> any more than this.
+ Clients written to this interface can use arbitrary
<code>ObjectPool</code>
+ implementations interchangeably.
+ </p>
+ <p>
+ <a
href="http://nagoya.apache.org/gump/javadoc/jakarta-commons/pool/dist/docs/api/org/apache/commons/pool/BaseObjectPool.html";><code>BaseObjectPool</code></a>
+ provides an abstract base implementation of <code>ObjectPool</code>.
Clients are
+ encouraged but not required to extend <code>BaseObjectPool</code> for
new
+ <code>ObjectPool</code> implementations.
+ </p>
+ <p>
+ <a
href="http://nagoya.apache.org/gump/javadoc/jakarta-commons/pool/dist/docs/api/org/apache/commons/pool/KeyedObjectPool.html";><code>KeyedObjectPool</code></a>
+ defines a similiar interface for pools composed of heterogenous
objects:
+ </p>
+ <pre>
+ public interface KeyedObjectPool {
+ Object borrowObject(Object key);
+ void returnObject(Object key, Object borrowed);
+ }
+ </pre>
+ </blockquote>
+ </td></tr>
+ <tr><td><br/></td></tr>
+ </table>
+ <table border="0"
cellspacing="0" cellpadding="2" width="100%">
+ <tr><td bgcolor="#828DA6">
+ <font color="#ffffff" face="arial,helvetica,sanserif">
+ <a name="PoolableObjectFactory"><strong>PoolableObjectFactory</strong></a>
+ </font>
+ </td></tr>
+ <tr><td>
+ <blockquote>
+ <p>
+ The <i>Pool</i> package makes it possible separate the way in which
instances
+ are pooled from the way in which instances are created and destroyed.
+ <a
href="http://nagoya.apache.org/gump/javadoc/jakarta-commons/pool/dist/docs/api/org/apache/commons/pool/PoolableObjectFactory.html";><code>PoolableObjectFactory</code></a>
+ supports this by providing a generic inteface for the lifecycle of a
pooled object:
+ </p>
+ <pre>
+ public interface PoolableObjectFactory {
+ Object makeObject();
+ void activateObject(Object obj);
+ void passivateObject(Object obj);
+ boolean validateObject(Object obj);
+ void destroyObject(Object obj);
+ }
+ </pre>
+ <p>
+ <code>ObjectPool</code> implementations may be written to accept
arbitrary
+ <code>PoolableObjectFactory</code>s.
+ This makes is possible for clients to select pooling-behavior distinct
+ from the kinds of objects that are pooled.
+ </p>
+ <p>
+ <a
href="http://nagoya.apache.org/gump/javadoc/jakarta-commons/pool/dist/docs/api/org/apache/commons/pool/BasePoolableObjectFactory.html";><code>BasePoolableObjectFactory</code></a>
+ provides an abstract base implementation of
<code>PoolableObjectFactory</code> that
+ makes implementations a snap.
+ </p>
+ <p>
+ <a
href="http://nagoya.apache.org/gump/javadoc/jakarta-commons/pool/dist/docs/api/org/apache/commons/pool/KeyedPoolableObjectFactory.html";><code>KeyedPoolableObjectFactory</code></a>
+ defines a similiar interface for <code>KeyedObjectPool</code>s:
+ </p>
+ <pre>
+ public interface KeyedPoolableObjectFactory {
+ Object makeObject(Object key);
+ void activateObject(Object key, Object obj);
+ void passivateObject(Object key, Object obj);
+ boolean validateObject(Object key, Object obj);
+ void destroyObject(Object key, Object obj);
+ }
+ </pre>
+ <p>
+ <a
href="http://nagoya.apache.org/gump/javadoc/jakarta-commons/pool/dist/docs/api/org/apache/commons/pool/BaseKeyedPoolableObjectFactory.html";><code>BaseKeyedPoolableObjectFactory</code></a>
+ provides an abstract base implementation of
<code>KeyedPoolableObjectFactory</code> that
+ makes implementations a snap.
+ </p>
+ </blockquote>
+ </td></tr>
+ <tr><td><br/></td></tr>
+ </table>
+ <p>
+ The
+ <a
href="http://nagoya.apache.org/gump/javadoc/jakarta-commons/pool/dist/docs/api/org/apache/commons/pool/impl/package-summary.html";>org.apache.commons.pool.impl</a>
+ package provides some <i>Pool</i> implementations.
+ </p>
+ <table border="0"
cellspacing="0" cellpadding="2" width="100%">
+ <tr><td bgcolor="#828DA6">
+ <font color="#ffffff" face="arial,helvetica,sanserif">
+ <a name="StackObjectPool"><strong>StackObjectPool</strong></a>
+ </font>
+ </td></tr>
+ <tr><td>
+ <blockquote>
+ <p>
+ <a
href="http://nagoya.apache.org/gump/javadoc/jakarta-commons/pool/dist/docs/api/org/apache/commons/pool/impl/StackObjectPool.html";><code>StackObjectPool</code></a>
+ will pool a finite number of "idle" instances, but will create new
instances a needed in
+ order to support high demand.
+ </p>
+ <p>
+ <a
href="http://nagoya.apache.org/gump/javadoc/jakarta-commons/pool/dist/docs/api/org/apache/commons/pool/impl/StackKeyedObjectPool.html";><code>StackKeyedObjectPool</code></a>
+ offers the same behavior for keyed pools.
+ </p>
+ </blockquote>
+ </td></tr>
+ <tr><td><br/></td></tr>
+ </table>
+ <table border="0"
cellspacing="0" cellpadding="2" width="100%">
+ <tr><td bgcolor="#828DA6">
+ <font color="#ffffff" face="arial,helvetica,sanserif">
+ <a name="GenericObjectPool"><strong>GenericObjectPool</strong></a>
+ </font>
+ </td></tr>
+ <tr><td>
+ <blockquote>
+ <p>
+ <a
href="http://nagoya.apache.org/gump/javadoc/jakarta-commons/pool/dist/docs/api/org/apache/commons/pool/impl/GenericObjectPool.html";><code>GenericObjectPool</code></a>
+ provides a wide variety of configuration options, including the ablity
to cap the number of idle or
+ active instances, to evict instances as they sit idle in the pool, etc.
+ </p>
+ <p>
+ <a
href="http://nagoya.apache.org/gump/javadoc/jakarta-commons/pool/dist/docs/api/org/apache/commons/pool/impl/GenericKeyedObjectPool.html";><code>GenericKeyedObjectPool</code></a>
+ offers the same behavior for keyed pools.
+ </p>
+ </blockquote>
+ </td></tr>
+ <tr><td><br/></td></tr>
+ </table>
+ <table border="0"
cellspacing="0" cellpadding="2" width="100%">
+ <tr><td bgcolor="#828DA6">
+ <font color="#ffffff" face="arial,helvetica,sanserif">
+ <a
name="SoftReferenceObjectPool"><strong>SoftReferenceObjectPool</strong></a>
+ </font>
+ </td></tr>
+ <tr><td>
+ <blockquote>
+ <p>
+ <a
href="http://nagoya.apache.org/gump/javadoc/jakarta-commons/pool/dist/docs/api/org/apache/commons/pool/impl/SoftReferenceObjectPool.html";><code>SoftReferenceObjectPool</code></a>
+ can grow as needed, but allows the garbage collector to evict idle
instances from the pool as needed.
+ </p>
+ </blockquote>
+ </td></tr>
+ <tr><td><br/></td></tr>
+ </table>
+ </blockquote>
+ </p>
+ </td></tr>
+ <tr><td><br/></td></tr>
+ </table>
</td>
</tr>
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
