org.apache.commons.dbcp.cpdsadapter
public class DriverAdapterCPDS extends Object implements ConnectionPoolDataSource, Referenceable, Serializable, ObjectFactory
An adapter for jdbc drivers that do not include an implementation
of javax.sql.ConnectionPoolDataSource, but still include a
java.sql.DriverManager implementation.
ConnectionPoolDataSource
s are not used within general
applications. They are used by DataSource
implementations
that pool Connection
s, such as
SharedPoolDataSource. A J2EE
container will normally provide some method of initializing the
ConnectionPoolDataSource
whose attributes are presented
as bean getters/setters and then deploying it via JNDI. It is then
available as a source of physical connections to the database, when
the pooling DataSource
needs to create a new
physical connection.
Although normally used within a JNDI environment, the DriverAdapterCPDS
can be instantiated and initialized as any bean and then attached
directly to a pooling DataSource
.
Jdbc2PoolDataSource
can use the
ConnectionPoolDataSource
with or without the use of JNDI.
The DriverAdapterCPDS also provides PreparedStatement
pooling
which is not generally available in jbdc2
ConnectionPoolDataSource
implementation, but is
addressed within the jdbc3 specification. The PreparedStatement
pool in DriverAdapterCPDS has been in the dbcp package for some time, but
it has not undergone extensive testing in the configuration used here.
It should be considered experimental and can be toggled with the
poolPreparedStatements attribute.
The package documentation contains an
example using catalina and JNDI. The datasources package documentation
shows how to use DriverAdapterCPDS
as a source for
Jdbc2PoolDataSource
without the use of JNDI.
Version: $Revision: 500687 $ $Date: 2007-01-27 16:33:47 -0700 (Sat, 27 Jan 2007) $
Constructor Summary | |
---|---|
DriverAdapterCPDS()
Default no-arg constructor for Serialization |
Method Summary | |
---|---|
String | getDescription()
Get the value of description. |
String | getDriver()
Get the driver classname. |
int | getLoginTimeout()
Gets the maximum time in seconds that this data source can wait
while attempting to connect to a database. |
PrintWriter | getLogWriter()
Get the log writer for this data source. |
int | getMaxActive()
The maximum number of active statements that can be allocated from
this pool at the same time, or non-positive for no limit. |
int | getMaxIdle()
The maximum number of statements that can remain idle in the
pool, without extra ones being released, or negative for no limit. |
int | getMaxPreparedStatements()
Returns the maximun number of prepared statements.
|
int | getMinEvictableIdleTimeMillis()
Returns the minimum amount of time a statement may sit idle in the pool
before it is eligible for eviction by the idle object evictor
(if any).
|
int | getNumTestsPerEvictionRun()
Returns the number of statements to examine during each run of the
idle object evictor thread (if any).
|
Object | getObjectInstance(Object refObj, Name name, Context context, Hashtable env)
implements ObjectFactory to create an instance of this class |
String | getPassword()
Get the value of password for the default user. |
PooledConnection | getPooledConnection()
Attempt to establish a database connection using the default
user and password. |
PooledConnection | getPooledConnection(String username, String password)
Attempt to establish a database connection. |
Reference | getReference()Referenceable implementation. |
int | getTimeBetweenEvictionRunsMillis()
Returns the number of milliseconds to sleep between runs of the
idle object evictor thread.
|
String | getUrl()
Get the value of url used to locate the database for this datasource. |
String | getUser()
Get the value of default user (login or username). |
boolean | isPoolPreparedStatements()
Flag to toggle the pooling of PreparedStatement s |
void | setDescription(String v)
Set the value of description. |
void | setDriver(String v)
Set the driver classname. |
void | setLoginTimeout(int seconds)
Sets the maximum time in seconds that this data source will wait
while attempting to connect to a database. |
void | setLogWriter(PrintWriter out)
Set the log writer for this data source. |
void | setMaxActive(int maxActive)
The maximum number of active statements that can be allocated from
this pool at the same time, or non-positive for no limit. |
void | setMaxIdle(int maxIdle)
The maximum number of statements that can remain idle in the
pool, without extra ones being released, or negative for no limit. |
void | setMaxPreparedStatements(int maxPreparedStatements)
Sets the maximum number of prepared statements. |
void | setMinEvictableIdleTimeMillis(int minEvictableIdleTimeMillis)
Sets the minimum amount of time a statement may sit idle in the pool
before it is eligable for eviction by the idle object evictor
(if any).
|
void | setNumTestsPerEvictionRun(int numTestsPerEvictionRun)
Sets the number of statements to examine during each run of the
idle object evictor thread (if any).
|
void | setPassword(String v)
Set the value of password for the default user. |
void | setPoolPreparedStatements(boolean v)
Flag to toggle the pooling of PreparedStatement s |
void | setTimeBetweenEvictionRunsMillis(int timeBetweenEvictionRunsMillis)
Sets the number of milliseconds to sleep between runs of the
idle object evictor thread.
|
void | setUrl(String v)
Set the value of url used to locate the database for this datasource. |
void | setUser(String v)
Set the value of default user (login or username). |
Returns: value of description.
Returns: value of driver.
Returns: maxPrepartedStatements value
Since: 1.2.2
Returns: value of password.
Referenceable
implementation.Returns: value of url.
Returns: value of user.
PreparedStatement
sReturns: value of poolPreparedStatements.
Parameters: v Value to assign to description.
Parameters: v Value to assign to driver.
Parameters: maxPreparedStatements the new maximum number of prepared statements
Since: 1.2.2
When a negative value is supplied, ceil({*link #numIdle})/abs({*link #getNumTestsPerEvictionRun}) tests will be run. I.e., when the value is -n, roughly one nth of the idle objects will be tested per run. *see #getNumTestsPerEvictionRun *see #setTimeBetweenEvictionRunsMillis
Parameters: v Value to assign to password.
PreparedStatement
sParameters: v true to pool statements.
Parameters: v Value to assign to url.
Parameters: v Value to assign to user.