org.apache.commons.dbcp.datasources

Class SharedPoolDataSource

Implemented Interfaces:
DataSource, Referenceable, Serializable

public class SharedPoolDataSource
extends InstanceKeyDataSource

A pooling DataSource appropriate for deployment within J2EE environment. There are many configuration options, most of which are defined in the parent class. All users (based on username) share a single maximum number of Connections in this datasource.
Version:
$Revision: 1.9 $ $Date: 2004/02/28 12:18:17 $
Author:
John D. McNally

Constructor Summary

SharedPoolDataSource()
Default no-arg constructor for Serialization

Method Summary

void
close()
Close pool being maintained by this datasource.
int
getMaxActive()
The maximum number of active connections that can be allocated from this pool at the same time, or zero for no limit.
int
getMaxIdle()
The maximum number of active connections that can remain idle in the pool, without extra ones being released, or zero for no limit.
int
getMaxWait()
The maximum number of milliseconds that the pool will wait (when there are no available connections) for a connection to be returned before throwing an exception, or -1 to wait indefinitely.
int
getNumActive()
Get the number of active connections in the pool.
int
getNumIdle()
Get the number of idle connections in the pool.
void
setMaxActive(int maxActive)
The maximum number of active connections that can be allocated from this pool at the same time, or zero for no limit.
void
setMaxIdle(int maxIdle)
The maximum number of active connections that can remain idle in the pool, without extra ones being released, or zero for no limit.
void
setMaxWait(int maxWait)
The maximum number of milliseconds that the pool will wait (when there are no available connections) for a connection to be returned before throwing an exception, or -1 to wait indefinitely.

Methods inherited from class org.apache.commons.dbcp.datasources.InstanceKeyDataSource

close, getConnection, getConnection, getConnectionPoolDataSource, getDataSourceName, getDefaultTransactionIsolation, getDescription, getJndiEnvironment, getLogWriter, getLoginTimeout, getMinEvictableIdleTimeMillis, getNumTestsPerEvictionRun, getReference, getTestOnBorrow, getTestOnReturn, getTestWhileIdle, getTimeBetweenEvictionRunsMillis, getValidationQuery, isDefaultAutoCommit, isDefaultReadOnly, isTestOnBorrow, isTestOnReturn, isTestWhileIdle, setConnectionPoolDataSource, setDataSourceName, setDefaultAutoCommit, setDefaultReadOnly, setDefaultTransactionIsolation, setDescription, setJndiEnvironment, setLogWriter, setLoginTimeout, setMinEvictableIdleTimeMillis, setNumTestsPerEvictionRun, setTestOnBorrow, setTestOnReturn, setTestWhileIdle, setTimeBetweenEvictionRunsMillis, setValidationQuery

Constructor Details

SharedPoolDataSource

public SharedPoolDataSource()
Default no-arg constructor for Serialization

Method Details

close

public void close()
            throws Exception
Close pool being maintained by this datasource.
Overrides:
close in interface InstanceKeyDataSource

getMaxActive

public int getMaxActive()
The maximum number of active connections that can be allocated from this pool at the same time, or zero for no limit. The default is 0.

getMaxIdle

public int getMaxIdle()
The maximum number of active connections that can remain idle in the pool, without extra ones being released, or zero for no limit. The default is 0.

getMaxWait

public int getMaxWait()
The maximum number of milliseconds that the pool will wait (when there are no available connections) for a connection to be returned before throwing an exception, or -1 to wait indefinitely. Will fail immediately if value is 0. The default is -1.

getNumActive

public int getNumActive()
Get the number of active connections in the pool.

getNumIdle

public int getNumIdle()
Get the number of idle connections in the pool.

setMaxActive

public void setMaxActive(int maxActive)
The maximum number of active connections that can be allocated from this pool at the same time, or zero for no limit. The default is 0.

setMaxIdle

public void setMaxIdle(int maxIdle)
The maximum number of active connections that can remain idle in the pool, without extra ones being released, or zero for no limit. The default is 0.

setMaxWait

public void setMaxWait(int maxWait)
The maximum number of milliseconds that the pool will wait (when there are no available connections) for a connection to be returned before throwing an exception, or -1 to wait indefinitely. Will fail immediately if value is 0. The default is -1.

Copyright © 2001-2003 Apache Software Foundation. Documenation generated January 16 2006.