org.apache.commons.dbcp
Class BasicDataSource

java.lang.Object
  extended by org.apache.commons.dbcp.BasicDataSource
All Implemented Interfaces:
java.sql.Wrapper, javax.sql.CommonDataSource, javax.sql.DataSource
Direct Known Subclasses:
BasicManagedDataSource

public class BasicDataSource
extends java.lang.Object
implements javax.sql.DataSource

Basic implementation of javax.sql.DataSource that is configured via JavaBeans properties. This is not the only way to combine the commons-dbcp and commons-pool packages, but provides a "one stop shopping" solution for basic requirements.

Users extending this class should take care to use appropriate accessors rather than accessing protected fields directly to ensure thread-safety.

Version:
$Revision: 895844 $ $Date: 2010-01-04 20:50:04 -0500 (Mon, 04 Jan 2010) $
Author:
Glenn L. Nielsen, Craig R. McClanahan, Dirk Verbeeck

Constructor Summary
BasicDataSource()
           
 
Method Summary
 void addConnectionProperty(java.lang.String name, java.lang.String value)
          Add a custom connection property to the set that will be passed to our JDBC driver.
 void close()
          Closes and releases all idle connections that are currently stored in the connection pool associated with this data source.
 java.sql.Connection getConnection()
          Create (if necessary) and return a connection to the database.
 java.sql.Connection getConnection(java.lang.String user, java.lang.String pass)
          BasicDataSource does NOT support this method.
 java.util.Collection getConnectionInitSqls()
          Returns the list of SQL statements executed when a physical connection is first created.
 boolean getDefaultAutoCommit()
          Returns the default auto-commit property.
 java.lang.String getDefaultCatalog()
          Returns the default catalog.
 boolean getDefaultReadOnly()
          Returns the default readOnly property.
 int getDefaultTransactionIsolation()
          Returns the default transaction isolation state of returned connections.
 java.lang.ClassLoader getDriverClassLoader()
          Returns the class loader specified for loading the JDBC driver.
 java.lang.String getDriverClassName()
          Returns the jdbc driver class name.
 int getInitialSize()
          Returns the initial size of the connection pool.
 boolean getLogAbandoned()
          Flag to log stack traces for application code which abandoned a Statement or Connection.
 int getLoginTimeout()
          BasicDataSource does NOT support this method.
 java.io.PrintWriter getLogWriter()
          Returns the log writer being used by this data source.
 int getMaxActive()
          Returns the maximum number of active connections that can be allocated at the same time.
 int getMaxIdle()
          Returns the maximum number of connections that can remain idle in the pool.
 int getMaxOpenPreparedStatements()
          Gets the value of the maxOpenPreparedStatements property.
 long getMaxWait()
          Returns the maximum number of milliseconds that the pool will wait for a connection to be returned before throwing an exception.
 long getMinEvictableIdleTimeMillis()
          Returns the minEvictableIdleTimeMillis property.
 int getMinIdle()
          Returns the minimum number of idle connections in the pool
 int getNumActive()
          [Read Only] The current number of active connections that have been allocated from this data source.
 int getNumIdle()
          [Read Only] The current number of idle connections that are waiting to be allocated from this data source.
 int getNumTestsPerEvictionRun()
          Returns the value of the numTestsPerEvictionRun property.
 java.lang.String getPassword()
          Returns the password passed to the JDBC driver to establish connections.
 boolean getRemoveAbandoned()
          Flag to remove abandoned connections if they exceed the removeAbandonedTimout.
 int getRemoveAbandonedTimeout()
          Timeout in seconds before an abandoned connection can be removed.
 boolean getTestOnBorrow()
          Returns the testOnBorrow property.
 boolean getTestOnReturn()
          Returns the value of the testOnReturn property.
 boolean getTestWhileIdle()
          Returns the value of the testWhileIdle property.
 long getTimeBetweenEvictionRunsMillis()
          Returns the value of the timeBetweenEvictionRunsMillis property.
 java.lang.String getUrl()
          Returns the JDBC connection url property.
 java.lang.String getUsername()
          Returns the JDBC connection username property.
 java.lang.String getValidationQuery()
          Returns the validation query used to validate connections before returning them.
 int getValidationQueryTimeout()
          Returns the validation query timeout.
 boolean isAccessToUnderlyingConnectionAllowed()
          Returns the value of the accessToUnderlyingConnectionAllowed property.
 boolean isClosed()
          If true, this data source is closed and no more connections can be retrieved from this datasource.
 boolean isPoolPreparedStatements()
          Returns true if we are pooling statements.
 boolean isWrapperFor(java.lang.Class<?> iface)
           
 void removeConnectionProperty(java.lang.String name)
          Remove a custom connection property.
 void setAccessToUnderlyingConnectionAllowed(boolean allow)
          Sets the value of the accessToUnderlyingConnectionAllowed property.
 void setConnectionInitSqls(java.util.Collection connectionInitSqls)
          Sets the list of SQL statements to be executed when a physical connection is first created.
 void setConnectionProperties(java.lang.String connectionProperties)
          Sets the connection properties passed to driver.connect(...).
 void setDefaultAutoCommit(boolean defaultAutoCommit)
          Sets default auto-commit state of connections returned by this datasource.
 void setDefaultCatalog(java.lang.String defaultCatalog)
          Sets the default catalog.
 void setDefaultReadOnly(boolean defaultReadOnly)
          Sets defaultReadonly property.
 void setDefaultTransactionIsolation(int defaultTransactionIsolation)
          Sets the default transaction isolation state for returned connections.
 void setDriverClassLoader(java.lang.ClassLoader driverClassLoader)
          Sets the class loader to be used to load the JDBC driver.
 void setDriverClassName(java.lang.String driverClassName)
          Sets the jdbc driver class name.
 void setInitialSize(int initialSize)
          Sets the initial size of the connection pool.
 void setLogAbandoned(boolean logAbandoned)
           
 void setLoginTimeout(int loginTimeout)
          BasicDataSource does NOT support this method.
 void setLogWriter(java.io.PrintWriter logWriter)
          Sets the log writer being used by this data source.
 void setMaxActive(int maxActive)
          Sets the maximum number of active connections that can be allocated at the same time.
 void setMaxIdle(int maxIdle)
          Sets the maximum number of connections that can remain idle in the pool.
 void setMaxOpenPreparedStatements(int maxOpenStatements)
          Sets the value of the maxOpenPreparedStatements property.
 void setMaxWait(long maxWait)
          Sets the maxWait property.
 void setMinEvictableIdleTimeMillis(long minEvictableIdleTimeMillis)
          Sets the minEvictableIdleTimeMillis property.
 void setMinIdle(int minIdle)
          Sets the minimum number of idle connections in the pool.
 void setNumTestsPerEvictionRun(int numTestsPerEvictionRun)
          Sets the value of the numTestsPerEvictionRun property.
 void setPassword(java.lang.String password)
          Sets the password.
 void setPoolPreparedStatements(boolean poolingStatements)
          Sets whether to pool statements or not.
 void setRemoveAbandoned(boolean removeAbandoned)
           
 void setRemoveAbandonedTimeout(int removeAbandonedTimeout)
           
 void setTestOnBorrow(boolean testOnBorrow)
          Sets the testOnBorrow property.
 void setTestOnReturn(boolean testOnReturn)
          Sets the testOnReturn property.
 void setTestWhileIdle(boolean testWhileIdle)
          Sets the testWhileIdle property.
 void setTimeBetweenEvictionRunsMillis(long timeBetweenEvictionRunsMillis)
          Sets the timeBetweenEvictionRunsMillis property.
 void setUrl(java.lang.String url)
          Sets the url.
 void setUsername(java.lang.String username)
          Sets the username.
 void setValidationQuery(java.lang.String validationQuery)
          Sets the validationQuery.
 void setValidationQueryTimeout(int timeout)
          Sets the validation query timeout, the amount of time, in seconds, that connection validation will wait for a response from the database when executing a validation query.
<T> T
unwrap(java.lang.Class<T> iface)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BasicDataSource

public BasicDataSource()
Method Detail

addConnectionProperty

public void addConnectionProperty(java.lang.String name,
                                  java.lang.String value)
Add a custom connection property to the set that will be passed to our JDBC driver. This MUST be called before the first connection is retrieved (along with all the other configuration property setters). Calls to this method after the connection pool has been initialized have no effect.

Parameters:
name - Name of the custom connection property
value - Value of the custom connection property

close

public void close()
           throws java.sql.SQLException

Closes and releases all idle connections that are currently stored in the connection pool associated with this data source.

Connections that are checked out to clients when this method is invoked are not affected. When client applications subsequently invoke Connection.close() to return these connections to the pool, the underlying JDBC connections are closed.

Attempts to acquire connections using getConnection() after this method has been invoked result in SQLExceptions.

This method is idempotent - i.e., closing an already closed BasicDataSource has no effect and does not generate exceptions.

Throws:
java.sql.SQLException - if an error occurs closing idle connections

getConnection

public java.sql.Connection getConnection()
                                  throws java.sql.SQLException
Create (if necessary) and return a connection to the database.

Specified by:
getConnection in interface javax.sql.DataSource
Returns:
a database connection
Throws:
java.sql.SQLException - if a database access error occurs

getConnection

public java.sql.Connection getConnection(java.lang.String user,
                                         java.lang.String pass)
                                  throws java.sql.SQLException
BasicDataSource does NOT support this method.

Specified by:
getConnection in interface javax.sql.DataSource
Parameters:
user - Database user on whose behalf the Connection is being made
pass - The database user's password
Returns:
nothing - always throws UnsupportedOperationException
Throws:
java.lang.UnsupportedOperationException
java.sql.SQLException - if a database access error occurs

getConnectionInitSqls

public java.util.Collection getConnectionInitSqls()
Returns the list of SQL statements executed when a physical connection is first created. Returns an empty list if there are no initialization statements configured.

Returns:
initialization SQL statements
Since:
1.3

getDefaultAutoCommit

public boolean getDefaultAutoCommit()
Returns the default auto-commit property.

Returns:
true if default auto-commit is enabled

getDefaultCatalog

public java.lang.String getDefaultCatalog()
Returns the default catalog.

Returns:
the default catalog

getDefaultReadOnly

public boolean getDefaultReadOnly()
Returns the default readOnly property.

Returns:
true if connections are readOnly by default

getDefaultTransactionIsolation

public int getDefaultTransactionIsolation()
Returns the default transaction isolation state of returned connections.

Returns:
the default value for transaction isolation state
See Also:
Connection.getTransactionIsolation()

getDriverClassLoader

public java.lang.ClassLoader getDriverClassLoader()
Returns the class loader specified for loading the JDBC driver. Returns null if no class loader has been explicitly specified.


getDriverClassName

public java.lang.String getDriverClassName()
Returns the jdbc driver class name.

Returns:
the jdbc driver class name

getInitialSize

public int getInitialSize()
Returns the initial size of the connection pool.

Returns:
the number of connections created when the pool is initialized

getLogAbandoned

public boolean getLogAbandoned()

Flag to log stack traces for application code which abandoned a Statement or Connection.

Defaults to false.

Logging of abandoned Statements and Connections adds overhead for every Connection open or new Statement because a stack trace has to be generated.


getLoginTimeout

public int getLoginTimeout()
                    throws java.sql.SQLException
BasicDataSource does NOT support this method.

Returns the login timeout (in seconds) for connecting to the database.

Calls createDataSource(), so has the side effect of initializing the connection pool.

Specified by:
getLoginTimeout in interface javax.sql.CommonDataSource
Returns:
login timeout in seconds
Throws:
java.sql.SQLException - if a database access error occurs
java.lang.UnsupportedOperationException - If the DataSource implementation does not support the login timeout feature.

getLogWriter

public java.io.PrintWriter getLogWriter()
                                 throws java.sql.SQLException

Returns the log writer being used by this data source.

Calls createDataSource(), so has the side effect of initializing the connection pool.

Specified by:
getLogWriter in interface javax.sql.CommonDataSource
Returns:
log writer in use
Throws:
java.sql.SQLException - if a database access error occurs

getMaxActive

public int getMaxActive()

Returns the maximum number of active connections that can be allocated at the same time.

A negative number means that there is no limit.

Returns:
the maximum number of active connections

getMaxIdle

public int getMaxIdle()

Returns the maximum number of connections that can remain idle in the pool.

A negative value indicates that there is no limit

Returns:
the maximum number of idle connections

getMaxOpenPreparedStatements

public int getMaxOpenPreparedStatements()
Gets the value of the maxOpenPreparedStatements property.

Returns:
the maximum number of open statements
See Also:
maxOpenPreparedStatements

getMaxWait

public long getMaxWait()

Returns the maximum number of milliseconds that the pool will wait for a connection to be returned before throwing an exception.

A value less than or equal to zero means the pool is set to wait indefinitely.

Returns:
the maxWait property value

getMinEvictableIdleTimeMillis

public long getMinEvictableIdleTimeMillis()
Returns the minEvictableIdleTimeMillis property.

Returns:
the value of the minEvictableIdleTimeMillis property
See Also:
minEvictableIdleTimeMillis

getMinIdle

public int getMinIdle()
Returns the minimum number of idle connections in the pool

Returns:
the minimum number of idle connections
See Also:
GenericObjectPool#getMinIdle()

getNumActive

public int getNumActive()
[Read Only] The current number of active connections that have been allocated from this data source.

Returns:
the current number of active connections

getNumIdle

public int getNumIdle()
[Read Only] The current number of idle connections that are waiting to be allocated from this data source.

Returns:
the current number of idle connections

getNumTestsPerEvictionRun

public int getNumTestsPerEvictionRun()
Returns the value of the numTestsPerEvictionRun property.

Returns:
the number of objects to examine during idle object evictor runs
See Also:
numTestsPerEvictionRun

getPassword

public java.lang.String getPassword()
Returns the password passed to the JDBC driver to establish connections.

Returns:
the connection password

getRemoveAbandoned

public boolean getRemoveAbandoned()
Flag to remove abandoned connections if they exceed the removeAbandonedTimout. Set to true or false, default false. If set to true a connection is considered abandoned and eligible for removal if it has been idle longer than the removeAbandonedTimeout. Setting this to true can recover db connections from poorly written applications which fail to close a connection.

Abandonded connections are identified and removed when getConnection() is invoked and the following conditions hold


getRemoveAbandonedTimeout

public int getRemoveAbandonedTimeout()
Timeout in seconds before an abandoned connection can be removed. Defaults to 300 seconds.

Returns:
abandoned connection timeout

getTestOnBorrow

public boolean getTestOnBorrow()
Returns the testOnBorrow property.

Returns:
true if objects are validated before being borrowed from the pool
See Also:
testOnBorrow

getTestOnReturn

public boolean getTestOnReturn()
Returns the value of the testOnReturn property.

Returns:
true if objects are validated before being returned to the pool
See Also:
testOnReturn

getTestWhileIdle

public boolean getTestWhileIdle()
Returns the value of the testWhileIdle property.

Returns:
true if objects examined by the idle object evictor are validated
See Also:
testWhileIdle

getTimeBetweenEvictionRunsMillis

public long getTimeBetweenEvictionRunsMillis()
Returns the value of the timeBetweenEvictionRunsMillis property.

Returns:
the time (in miliseconds) between evictor runs
See Also:
timeBetweenEvictionRunsMillis

getUrl

public java.lang.String getUrl()
Returns the JDBC connection url property.

Returns:
the url passed to the JDBC driver to establish connections

getUsername

public java.lang.String getUsername()
Returns the JDBC connection username property.

Returns:
the username passed to the JDBC driver to establish connections

getValidationQuery

public java.lang.String getValidationQuery()
Returns the validation query used to validate connections before returning them.

Returns:
the SQL validation query
See Also:
validationQuery

getValidationQueryTimeout

public int getValidationQueryTimeout()
Returns the validation query timeout.

Returns:
the timeout in seconds before connection validation queries fail.
Since:
1.3

isAccessToUnderlyingConnectionAllowed

public boolean isAccessToUnderlyingConnectionAllowed()
Returns the value of the accessToUnderlyingConnectionAllowed property.

Returns:
true if access to the underlying connection is allowed, false otherwise.

isClosed

public boolean isClosed()
If true, this data source is closed and no more connections can be retrieved from this datasource.

Returns:
true, if the data source is closed; false otherwise

isPoolPreparedStatements

public boolean isPoolPreparedStatements()
Returns true if we are pooling statements.

Returns:
true if prepared and callable statements are pooled

isWrapperFor

public boolean isWrapperFor(java.lang.Class<?> iface)
                     throws java.sql.SQLException
Specified by:
isWrapperFor in interface java.sql.Wrapper
Throws:
java.sql.SQLException

removeConnectionProperty

public void removeConnectionProperty(java.lang.String name)
Remove a custom connection property.

Parameters:
name - Name of the custom connection property to remove
See Also:
addConnectionProperty(String, String)

setAccessToUnderlyingConnectionAllowed

public void setAccessToUnderlyingConnectionAllowed(boolean allow)

Sets the value of the accessToUnderlyingConnectionAllowed property. It controls if the PoolGuard allows access to the underlying connection. (Default: false)

Note: this method currently has no effect once the pool has been initialized. The pool is initialized the first time one of the following methods is invoked: getConnection, setLogwriter, setLoginTimeout, getLoginTimeout, getLogWriter.

Parameters:
allow - Access to the underlying connection is granted when true.

setConnectionInitSqls

public void setConnectionInitSqls(java.util.Collection connectionInitSqls)
Sets the list of SQL statements to be executed when a physical connection is first created.

Note: this method currently has no effect once the pool has been initialized. The pool is initialized the first time one of the following methods is invoked: getConnection, setLogwriter, setLoginTimeout, getLoginTimeout, getLogWriter.

Parameters:
connectionInitSqls - Collection of SQL statements to execute on connection creation

setConnectionProperties

public void setConnectionProperties(java.lang.String connectionProperties)
Sets the connection properties passed to driver.connect(...). Format of the string must be [propertyName=property;]* NOTE - The "user" and "password" properties will be added explicitly, so they do not need to be included here.

Parameters:
connectionProperties - the connection properties used to create new connections

setDefaultAutoCommit

public void setDefaultAutoCommit(boolean defaultAutoCommit)

Sets default auto-commit state of connections returned by this datasource.

Note: this method currently has no effect once the pool has been initialized. The pool is initialized the first time one of the following methods is invoked: getConnection, setLogwriter, setLoginTimeout, getLoginTimeout, getLogWriter.

Parameters:
defaultAutoCommit - default auto-commit value

setDefaultCatalog

public void setDefaultCatalog(java.lang.String defaultCatalog)

Sets the default catalog.

Note: this method currently has no effect once the pool has been initialized. The pool is initialized the first time one of the following methods is invoked: getConnection, setLogwriter, setLoginTimeout, getLoginTimeout, getLogWriter.

Parameters:
defaultCatalog - the default catalog

setDefaultReadOnly

public void setDefaultReadOnly(boolean defaultReadOnly)

Sets defaultReadonly property.

Note: this method currently has no effect once the pool has been initialized. The pool is initialized the first time one of the following methods is invoked: getConnection, setLogwriter, setLoginTimeout, getLoginTimeout, getLogWriter.

Parameters:
defaultReadOnly - default read-only value

setDefaultTransactionIsolation

public void setDefaultTransactionIsolation(int defaultTransactionIsolation)

Sets the default transaction isolation state for returned connections.

Note: this method currently has no effect once the pool has been initialized. The pool is initialized the first time one of the following methods is invoked: getConnection, setLogwriter, setLoginTimeout, getLoginTimeout, getLogWriter.

Parameters:
defaultTransactionIsolation - the default transaction isolation state
See Also:
Connection.getTransactionIsolation()

setDriverClassLoader

public void setDriverClassLoader(java.lang.ClassLoader driverClassLoader)

Sets the class loader to be used to load the JDBC driver.

Note: this method currently has no effect once the pool has been initialized. The pool is initialized the first time one of the following methods is invoked: getConnection, setLogwriter, setLoginTimeout, getLoginTimeout, getLogWriter.

Parameters:
driverClassLoader - the class loader with which to load the JDBC driver

setDriverClassName

public void setDriverClassName(java.lang.String driverClassName)

Sets the jdbc driver class name.

Note: this method currently has no effect once the pool has been initialized. The pool is initialized the first time one of the following methods is invoked: getConnection, setLogwriter, setLoginTimeout, getLoginTimeout, getLogWriter.

Parameters:
driverClassName - the class name of the jdbc driver

setInitialSize

public void setInitialSize(int initialSize)

Sets the initial size of the connection pool.

Note: this method currently has no effect once the pool has been initialized. The pool is initialized the first time one of the following methods is invoked: getConnection, setLogwriter, setLoginTimeout, getLoginTimeout, getLogWriter.

Parameters:
initialSize - the number of connections created when the pool is initialized

setLogAbandoned

public void setLogAbandoned(boolean logAbandoned)
Parameters:
logAbandoned - new logAbandoned property value

setLoginTimeout

public void setLoginTimeout(int loginTimeout)
                     throws java.sql.SQLException
BasicDataSource does NOT support this method.

Set the login timeout (in seconds) for connecting to the database.

Calls createDataSource(), so has the side effect of initializing the connection pool.

Specified by:
setLoginTimeout in interface javax.sql.CommonDataSource
Parameters:
loginTimeout - The new login timeout, or zero for no timeout
Throws:
java.lang.UnsupportedOperationException - If the DataSource implementation does not support the login timeout feature.
java.sql.SQLException - if a database access error occurs

setLogWriter

public void setLogWriter(java.io.PrintWriter logWriter)
                  throws java.sql.SQLException

Sets the log writer being used by this data source.

Calls createDataSource(), so has the side effect of initializing the connection pool.

Specified by:
setLogWriter in interface javax.sql.CommonDataSource
Parameters:
logWriter - The new log writer
Throws:
java.sql.SQLException - if a database access error occurs

setMaxActive

public void setMaxActive(int maxActive)
Sets the maximum number of active connections that can be allocated at the same time. Use a negative value for no limit.

Parameters:
maxActive - the new value for maxActive
See Also:
getMaxActive()

setMaxIdle

public void setMaxIdle(int maxIdle)
Sets the maximum number of connections that can remain idle in the pool.

Parameters:
maxIdle - the new value for maxIdle
See Also:
getMaxIdle()

setMaxOpenPreparedStatements

public void setMaxOpenPreparedStatements(int maxOpenStatements)

Sets the value of the maxOpenPreparedStatements property.

Note: this method currently has no effect once the pool has been initialized. The pool is initialized the first time one of the following methods is invoked: getConnection, setLogwriter, setLoginTimeout, getLoginTimeout, getLogWriter.

Parameters:
maxOpenStatements - the new maximum number of prepared statements
See Also:
maxOpenPreparedStatements

setMaxWait

public void setMaxWait(long maxWait)

Sets the maxWait property.

Use -1 to make the pool wait indefinitely.

Parameters:
maxWait - the new value for maxWait
See Also:
getMaxWait()

setMinEvictableIdleTimeMillis

public void setMinEvictableIdleTimeMillis(long minEvictableIdleTimeMillis)
Sets the minEvictableIdleTimeMillis property.

Parameters:
minEvictableIdleTimeMillis - the minimum amount of time an object may sit idle in the pool
See Also:
minEvictableIdleTimeMillis

setMinIdle

public void setMinIdle(int minIdle)
Sets the minimum number of idle connections in the pool.

Parameters:
minIdle - the new value for minIdle
See Also:
GenericObjectPool#setMinIdle(int)

setNumTestsPerEvictionRun

public void setNumTestsPerEvictionRun(int numTestsPerEvictionRun)
Sets the value of the numTestsPerEvictionRun property.

Parameters:
numTestsPerEvictionRun - the new numTestsPerEvictionRun value
See Also:
numTestsPerEvictionRun

setPassword

public void setPassword(java.lang.String password)

Sets the password.

Note: this method currently has no effect once the pool has been initialized. The pool is initialized the first time one of the following methods is invoked: getConnection, setLogwriter, setLoginTimeout, getLoginTimeout, getLogWriter.

Parameters:
password - new value for the password

setPoolPreparedStatements

public void setPoolPreparedStatements(boolean poolingStatements)

Sets whether to pool statements or not.

Note: this method currently has no effect once the pool has been initialized. The pool is initialized the first time one of the following methods is invoked: getConnection, setLogwriter, setLoginTimeout, getLoginTimeout, getLogWriter.

Parameters:
poolingStatements - pooling on or off

setRemoveAbandoned

public void setRemoveAbandoned(boolean removeAbandoned)
Parameters:
removeAbandoned - new removeAbandoned property value
See Also:
getRemoveAbandoned()

setRemoveAbandonedTimeout

public void setRemoveAbandonedTimeout(int removeAbandonedTimeout)
Parameters:
removeAbandonedTimeout - new removeAbandonedTimeout value

setTestOnBorrow

public void setTestOnBorrow(boolean testOnBorrow)
Sets the testOnBorrow property. This property determines whether or not the pool will validate objects before they are borrowed from the pool. For a true value to have any effect, the validationQuery property must be set to a non-null string.

Parameters:
testOnBorrow - new value for testOnBorrow property

setTestOnReturn

public void setTestOnReturn(boolean testOnReturn)
Sets the testOnReturn property. This property determines whether or not the pool will validate objects before they are returned to the pool. For a true value to have any effect, the validationQuery property must be set to a non-null string.

Parameters:
testOnReturn - new value for testOnReturn property

setTestWhileIdle

public void setTestWhileIdle(boolean testWhileIdle)
Sets the testWhileIdle property. This property determines whether or not the idle object evictor will validate connections. For a true value to have any effect, the validationQuery property must be set to a non-null string.

Parameters:
testWhileIdle - new value for testWhileIdle property

setTimeBetweenEvictionRunsMillis

public void setTimeBetweenEvictionRunsMillis(long timeBetweenEvictionRunsMillis)
Sets the timeBetweenEvictionRunsMillis property.

Parameters:
timeBetweenEvictionRunsMillis - the new time between evictor runs
See Also:
timeBetweenEvictionRunsMillis

setUrl

public void setUrl(java.lang.String url)

Sets the url.

Note: this method currently has no effect once the pool has been initialized. The pool is initialized the first time one of the following methods is invoked: getConnection, setLogwriter, setLoginTimeout, getLoginTimeout, getLogWriter.

Parameters:
url - the new value for the JDBC connection url

setUsername

public void setUsername(java.lang.String username)

Sets the username.

Note: this method currently has no effect once the pool has been initialized. The pool is initialized the first time one of the following methods is invoked: getConnection, setLogwriter, setLoginTimeout, getLoginTimeout, getLogWriter.

Parameters:
username - the new value for the JDBC connection username

setValidationQuery

public void setValidationQuery(java.lang.String validationQuery)

Sets the validationQuery.

Note: this method currently has no effect once the pool has been initialized. The pool is initialized the first time one of the following methods is invoked: getConnection, setLogwriter, setLoginTimeout, getLoginTimeout, getLogWriter.

Parameters:
validationQuery - the new value for the validation query

setValidationQueryTimeout

public void setValidationQueryTimeout(int timeout)
Sets the validation query timeout, the amount of time, in seconds, that connection validation will wait for a response from the database when executing a validation query. Use a value less than or equal to 0 for no timeout.

Note: this method currently has no effect once the pool has been initialized. The pool is initialized the first time one of the following methods is invoked: getConnection, setLogwriter, setLoginTimeout, getLoginTimeout, getLogWriter.

Parameters:
timeout - new validation query timeout value in seconds
Since:
1.3

unwrap

public <T> T unwrap(java.lang.Class<T> iface)
         throws java.sql.SQLException
Specified by:
unwrap in interface java.sql.Wrapper
Throws:
java.sql.SQLException


Copyright © 2001-2004 Apache Software Foundation. Documenation generated December 4 2011.