java.io.Serializable
, java.sql.Wrapper
, javax.naming.Referenceable
, javax.sql.CommonDataSource
, javax.sql.DataSource
PerUserPoolDataSource
, SharedPoolDataSource
public abstract class InstanceKeyDataSource
extends java.lang.Object
implements javax.sql.DataSource, javax.naming.Referenceable, java.io.Serializable
The base class for SharedPoolDataSource
and
PerUserPoolDataSource
. Many of the configuration properties
are shared and defined here. This class is declared public in order
to allow particular usage with commons-beanutils; do not make direct
use of it outside of commons-dbcp.
A J2EE container will normally provide some method of initializing the
DataSource
whose attributes are presented
as bean getters/setters and then deploying it via JNDI. It is then
available to an application as a source of pooled logical connections to
the database. The pool needs a source of physical connections. This
source is in the form of a ConnectionPoolDataSource
that
can be specified via the setDataSourceName(String)
used to
lookup the source via JNDI.
Although normally used within a JNDI environment, A DataSource
can be instantiated and initialized as any bean. In this case the
ConnectionPoolDataSource
will likely be instantiated in
a similar manner. This class allows the physical source of connections
to be attached directly to this pool using the
setConnectionPoolDataSource(ConnectionPoolDataSource)
method.
The dbcp package contains an adapter,
DriverAdapterCPDS
,
that can be used to allow the use of DataSource
's based on this
class with jdbc driver implementations that do not supply a
ConnectionPoolDataSource
, but still
provide a Driver
implementation.
The package documentation contains an example using Apache Tomcat and JNDI and it also contains a non-JNDI example.
Constructor | Description |
---|---|
InstanceKeyDataSource() |
Default no-arg constructor for Serialization
|
Modifier and Type | Method | Description |
---|---|---|
abstract void |
close() |
Close the connection pool being maintained by this datasource.
|
java.sql.Connection |
getConnection() |
Attempt to establish a database connection.
|
java.sql.Connection |
getConnection(java.lang.String username,
java.lang.String password) |
Attempt to retrieve a database connection using
getPooledConnectionAndInfo(String, String)
with the provided username and password. |
javax.sql.ConnectionPoolDataSource |
getConnectionPoolDataSource() |
Get the value of connectionPoolDataSource.
|
java.lang.String |
getDataSourceName() |
Get the name of the ConnectionPoolDataSource which backs this pool.
|
int |
getDefaultTransactionIsolation() |
Get the value of defaultTransactionIsolation, which defines the state of
connections handed out from this pool.
|
java.lang.String |
getDescription() |
Get the description.
|
java.lang.String |
getJndiEnvironment(java.lang.String key) |
Get the value of jndiEnvironment which is used when instantiating
a jndi InitialContext.
|
int |
getLoginTimeout() |
Get the value of loginTimeout.
|
java.io.PrintWriter |
getLogWriter() |
Get the value of logWriter.
|
int |
getMinEvictableIdleTimeMillis() |
Returns the minimum amount of time an object may sit idle in the pool
before it is eligable for eviction by the idle object evictor
(if any).
|
int |
getNumTestsPerEvictionRun() |
Returns the number of objects to examine during each run of the
idle object evictor thread (if any).
|
javax.naming.Reference |
getReference() |
Retrieves the Reference of this object.
|
boolean |
getTestOnBorrow() |
When true, objects will be
{*link PoolableObjectFactory#validateObject validated}
before being returned by the {*link #borrowObject}
method.
|
boolean |
getTestOnReturn() |
When true, objects will be
{*link PoolableObjectFactory#validateObject validated}
before being returned to the pool within the
{*link #returnObject}.
|
boolean |
getTestWhileIdle() |
When true, objects will be
{*link PoolableObjectFactory#validateObject validated}
by the idle object evictor (if any).
|
int |
getTimeBetweenEvictionRunsMillis() |
Returns the number of milliseconds to sleep between runs of the
idle object evictor thread.
|
java.lang.String |
getValidationQuery() |
The SQL query that will be used to validate connections from this pool
before returning them to the caller.
|
boolean |
isDefaultAutoCommit() |
Get the value of defaultAutoCommit, which defines the state of
connections handed out from this pool.
|
boolean |
isDefaultReadOnly() |
Get the value of defaultReadOnly, which defines the state of
connections handed out from this pool.
|
boolean |
isRollbackAfterValidation() |
Whether a rollback will be issued after executing the SQL query
that will be used to validate connections from this pool
before returning them to the caller.
|
boolean |
isTestOnBorrow() |
|
boolean |
isTestOnReturn() |
|
boolean |
isTestWhileIdle() |
|
boolean |
isWrapperFor(java.lang.Class<?> iface) |
|
void |
setConnectionPoolDataSource(javax.sql.ConnectionPoolDataSource v) |
Set the backend ConnectionPoolDataSource.
|
void |
setDataSourceName(java.lang.String v) |
Set the name of the ConnectionPoolDataSource which backs this pool.
|
void |
setDefaultAutoCommit(boolean v) |
Set the value of defaultAutoCommit, which defines the state of
connections handed out from this pool.
|
void |
setDefaultReadOnly(boolean v) |
Set the value of defaultReadOnly, which defines the state of
connections handed out from this pool.
|
void |
setDefaultTransactionIsolation(int v) |
Set the value of defaultTransactionIsolation, which defines the state of
connections handed out from this pool.
|
void |
setDescription(java.lang.String v) |
Set the description.
|
void |
setJndiEnvironment(java.lang.String key,
java.lang.String value) |
Sets the value of the given JNDI environment property to be used when
instantiating a JNDI InitialContext.
|
void |
setLoginTimeout(int v) |
Set the value of loginTimeout.
|
void |
setLogWriter(java.io.PrintWriter v) |
Set the value of logWriter.
|
void |
setMinEvictableIdleTimeMillis(int minEvictableIdleTimeMillis) |
Sets the minimum amount of time an object 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 objects to examine during each run of the
idle object evictor thread (if any).
|
void |
setRollbackAfterValidation(boolean rollbackAfterValidation) |
Whether a rollback will be issued after executing the SQL query
that will be used to validate connections from this pool
before returning them to the caller.
|
void |
setTestOnBorrow(boolean testOnBorrow) |
When true, objects will be
{*link PoolableObjectFactory#validateObject validated}
before being returned by the {*link #borrowObject}
method.
|
void |
setTestOnReturn(boolean testOnReturn) |
When true, objects will be
{*link PoolableObjectFactory#validateObject validated}
before being returned to the pool within the
{*link #returnObject}.
|
void |
setTestWhileIdle(boolean testWhileIdle) |
When true, objects will be
{*link PoolableObjectFactory#validateObject validated}
by the idle object evictor (if any).
|
void |
setTimeBetweenEvictionRunsMillis(int timeBetweenEvictionRunsMillis) |
Sets the number of milliseconds to sleep between runs of the
idle object evictor thread.
|
void |
setValidationQuery(java.lang.String validationQuery) |
The SQL query that will be used to validate connections from this pool
before returning them to the caller.
|
<T> T |
unwrap(java.lang.Class<T> iface) |
public InstanceKeyDataSource()
public abstract void close() throws java.lang.Exception
java.lang.Exception
public java.sql.Connection getConnection() throws java.sql.SQLException
getConnection
in interface javax.sql.DataSource
java.sql.SQLException
public java.sql.Connection getConnection(java.lang.String username, java.lang.String password) throws java.sql.SQLException
getPooledConnectionAndInfo(String, String)
with the provided username and password. The password on the PooledConnectionAndInfo
instance returned by getPooledConnectionAndInfo
is compared to the password
parameter. If the comparison fails, a database connection using the supplied username and password
is attempted. If the connection attempt fails, an SQLException is thrown, indicating that the given password
did not match the password used to create the pooled connection. If the connection attempt succeeds, this
means that the database password has been changed. In this case, the PooledConnectionAndInfo
instance retrieved with the old password is destroyed and the getPooledConnectionAndInfo
is
repeatedly invoked until a PooledConnectionAndInfo
instance with the new password is returned.getConnection
in interface javax.sql.DataSource
java.sql.SQLException
public javax.sql.ConnectionPoolDataSource getConnectionPoolDataSource()
public java.lang.String getDataSourceName()
public int getDefaultTransactionIsolation()
public java.lang.String getDescription()
public java.lang.String getJndiEnvironment(java.lang.String key)
public int getLoginTimeout()
getLoginTimeout
in interface javax.sql.CommonDataSource
getLoginTimeout
in interface javax.sql.DataSource
public java.io.PrintWriter getLogWriter()
getLogWriter
in interface javax.sql.CommonDataSource
getLogWriter
in interface javax.sql.DataSource
public int getMinEvictableIdleTimeMillis()
public int getNumTestsPerEvictionRun()
public javax.naming.Reference getReference() throws javax.naming.NamingException
InstanceKeyDataSource
subclasses
should override this method. The implementaion included below
is not robust and will be removed at the next major version DBCP
release.getReference
in interface javax.naming.Referenceable
javax.naming.NamingException
- If a naming exception was encountered
while retrieving the reference.public boolean getTestOnBorrow()
setTestOnBorrow(boolean)
public boolean getTestOnReturn()
setTestOnReturn(boolean)
public boolean getTestWhileIdle()
public int getTimeBetweenEvictionRunsMillis()
setTimeBetweenEvictionRunsMillis(int)
public java.lang.String getValidationQuery()
public boolean isDefaultAutoCommit()
public boolean isDefaultReadOnly()
public boolean isRollbackAfterValidation()
public final boolean isTestOnBorrow()
getTestOnBorrow()
public final boolean isTestOnReturn()
getTestOnReturn()
public final boolean isTestWhileIdle()
getTestWhileIdle()
public boolean isWrapperFor(java.lang.Class<?> iface) throws java.sql.SQLException
isWrapperFor
in interface java.sql.Wrapper
java.sql.SQLException
public void setConnectionPoolDataSource(javax.sql.ConnectionPoolDataSource v)
v
- Value to assign to connectionPoolDataSource.public void setDataSourceName(java.lang.String v)
v
- Value to assign to dataSourceName.public void setDefaultAutoCommit(boolean v)
v
- Value to assign to defaultAutoCommit.public void setDefaultReadOnly(boolean v)
v
- Value to assign to defaultReadOnly.public void setDefaultTransactionIsolation(int v)
v
- Value to assign to defaultTransactionIsolationpublic void setDescription(java.lang.String v)
v
- Value to assign to description.public void setJndiEnvironment(java.lang.String key, java.lang.String value)
key
- the JNDI environment property to set.value
- the value assigned to specified JNDI environment property.public void setLoginTimeout(int v)
setLoginTimeout
in interface javax.sql.CommonDataSource
setLoginTimeout
in interface javax.sql.DataSource
v
- Value to assign to loginTimeout.public void setLogWriter(java.io.PrintWriter v)
setLogWriter
in interface javax.sql.CommonDataSource
setLogWriter
in interface javax.sql.DataSource
v
- Value to assign to logWriter.public void setMinEvictableIdleTimeMillis(int minEvictableIdleTimeMillis)
public void setNumTestsPerEvictionRun(int numTestsPerEvictionRun)
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.
public void setRollbackAfterValidation(boolean rollbackAfterValidation)
rollbackAfterValidation
- new property valuepublic void setTestOnBorrow(boolean testOnBorrow)
true
value to have any effect,
the validationQuery
property must be set to a non-null
string.getTestOnBorrow()
public void setTestOnReturn(boolean testOnReturn)
true
value to have any effect,
the validationQuery
property must be set to a non-null
string.getTestOnReturn()
public void setTestWhileIdle(boolean testWhileIdle)
true
value to have any effect,
the validationQuery
property must be set to a non-null
string.public void setTimeBetweenEvictionRunsMillis(int timeBetweenEvictionRunsMillis)
getTimeBetweenEvictionRunsMillis()
public void setValidationQuery(java.lang.String validationQuery)
public <T> T unwrap(java.lang.Class<T> iface) throws java.sql.SQLException
unwrap
in interface java.sql.Wrapper
java.sql.SQLException
Copyright © 2001-2004 Apache Software Foundation. Documenation generated April 15 2019.