Package org.ldaptive.pool
Interface ConnectionPool
-
- All Known Implementing Classes:
AbstractConnectionPool
,BlockingConnectionPool
,PooledConnectionFactory
public interface ConnectionPool
Provides an interface for connection pooling.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description int
activeCount()
Returns the number of connections in use.int
availableCount()
Returns the number of connections available for use.void
close()
Empty this pool, freeing any resources.ConnectionActivator
getActivator()
Returns the activator for this pool.Connection
getConnection()
Returns an object from the pool.ConnectionPassivator
getPassivator()
Returns the passivator for this pool.Set<PooledConnectionStatistics>
getPooledConnectionStatistics()
Returns the statistics for each connection in the pool.void
initialize()
Initialize this pool for use.void
setActivator(ConnectionActivator a)
Sets the activator for this pool.void
setPassivator(ConnectionPassivator p)
Sets the passivator for this pool.
-
-
-
Method Detail
-
getActivator
ConnectionActivator getActivator()
Returns the activator for this pool.- Returns:
- activator
-
setActivator
void setActivator(ConnectionActivator a)
Sets the activator for this pool.- Parameters:
a
- activator
-
getPassivator
ConnectionPassivator getPassivator()
Returns the passivator for this pool.- Returns:
- passivator
-
setPassivator
void setPassivator(ConnectionPassivator p)
Sets the passivator for this pool.- Parameters:
p
- passivator
-
initialize
void initialize()
Initialize this pool for use.
-
getConnection
Connection getConnection() throws PoolException
Returns an object from the pool.- Returns:
- pooled object
- Throws:
PoolException
- if this operation failsBlockingTimeoutException
- if this pool is configured with a block time and it occurs
-
availableCount
int availableCount()
Returns the number of connections available for use.- Returns:
- count
-
activeCount
int activeCount()
Returns the number of connections in use.- Returns:
- count
-
getPooledConnectionStatistics
Set<PooledConnectionStatistics> getPooledConnectionStatistics()
Returns the statistics for each connection in the pool.- Returns:
- connection statistics
-
close
void close()
Empty this pool, freeing any resources.
-
-