org.apache.directory.ldap.client.api
Class LdapConnectionPool

java.lang.Object
  extended by org.apache.commons.pool.BaseObjectPool
      extended by org.apache.commons.pool.impl.GenericObjectPool
          extended by org.apache.directory.ldap.client.api.LdapConnectionPool
All Implemented Interfaces:
org.apache.commons.pool.ObjectPool

public class LdapConnectionPool
extends org.apache.commons.pool.impl.GenericObjectPool

A pool implementation for LdapConnection objects. This class is just a wrapper around the commons GenericObjectPool, and has a more meaningful name to represent the pool type

Version:
$Rev$, $Date$
Author:
Apache Directory Project

Nested Class Summary
 
Nested classes/interfaces inherited from class org.apache.commons.pool.impl.GenericObjectPool
org.apache.commons.pool.impl.GenericObjectPool.Config
 
Field Summary
 
Fields inherited from class org.apache.commons.pool.impl.GenericObjectPool
DEFAULT_LIFO, DEFAULT_MAX_ACTIVE, DEFAULT_MAX_IDLE, DEFAULT_MAX_WAIT, DEFAULT_MIN_EVICTABLE_IDLE_TIME_MILLIS, DEFAULT_MIN_IDLE, DEFAULT_NUM_TESTS_PER_EVICTION_RUN, DEFAULT_SOFT_MIN_EVICTABLE_IDLE_TIME_MILLIS, DEFAULT_TEST_ON_BORROW, DEFAULT_TEST_ON_RETURN, DEFAULT_TEST_WHILE_IDLE, DEFAULT_TIME_BETWEEN_EVICTION_RUNS_MILLIS, DEFAULT_WHEN_EXHAUSTED_ACTION, WHEN_EXHAUSTED_BLOCK, WHEN_EXHAUSTED_FAIL, WHEN_EXHAUSTED_GROW
 
Constructor Summary
LdapConnectionPool()
           
LdapConnectionPool(PoolableLdapConnectionFactory factory)
           
 
Method Summary
 LdapConnection getConnection()
          gives a LdapConnection fetched from the pool
 void releaseConnection(LdapConnection connection)
          places the given LdapConnection back in the pool
 void setFactory(PoolableLdapConnectionFactory factory)
          
 
Methods inherited from class org.apache.commons.pool.impl.GenericObjectPool
addObject, borrowObject, clear, close, evict, getLifo, getMaxActive, getMaxIdle, getMaxWait, getMinEvictableIdleTimeMillis, getMinIdle, getNumActive, getNumIdle, getNumTestsPerEvictionRun, getSoftMinEvictableIdleTimeMillis, getTestOnBorrow, getTestOnReturn, getTestWhileIdle, getTimeBetweenEvictionRunsMillis, getWhenExhaustedAction, invalidateObject, returnObject, setConfig, setFactory, setLifo, setMaxActive, setMaxIdle, setMaxWait, setMinEvictableIdleTimeMillis, setMinIdle, setNumTestsPerEvictionRun, setSoftMinEvictableIdleTimeMillis, setTestOnBorrow, setTestOnReturn, setTestWhileIdle, setTimeBetweenEvictionRunsMillis, setWhenExhaustedAction, startEvictor
 
Methods inherited from class org.apache.commons.pool.BaseObjectPool
assertOpen, isClosed
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LdapConnectionPool

public LdapConnectionPool()

LdapConnectionPool

public LdapConnectionPool(PoolableLdapConnectionFactory factory)
Method Detail

setFactory

public void setFactory(PoolableLdapConnectionFactory factory)


getConnection

public LdapConnection getConnection()
                             throws java.lang.Exception
gives a LdapConnection fetched from the pool

Returns:
an LdapConnection object from pool
Throws:
java.lang.Exception

releaseConnection

public void releaseConnection(LdapConnection connection)
                       throws java.lang.Exception
places the given LdapConnection back in the pool

Parameters:
connection - the LdapConnection to be released
Throws:
java.lang.Exception


Copyright © 2009-2011 Apache Software Foundation. All Rights Reserved.