public class BasicDataSource extends Object implements DataSource, BasicDataSourceMXBean, MBeanRegistration, AutoCloseable
Basic implementation of javax.sql.DataSource
that is
configured via JavaBeans properties. This is not the only way to
combine the commons-dbcp2 and commons-pool2 packages,
but provides a "one stop shopping" solution for basic requirements.
Constructor and Description |
---|
BasicDataSource() |
Modifier and Type | Method and Description |
---|---|
void |
addConnectionProperty(String name,
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.
|
protected ConnectionFactory |
createConnectionFactory()
Creates a JDBC connection factory for this datasource.
|
protected void |
createConnectionPool(PoolableConnectionFactory factory)
Creates a connection pool for this datasource.
|
protected DataSource |
createDataSource()
Create (if necessary) and return the internal data source we are
using to manage our connections.
|
protected DataSource |
createDataSourceInstance()
Creates the actual data source instance.
|
protected GenericObjectPool<PoolableConnection> |
createObjectPool(PoolableConnectionFactory factory,
GenericObjectPoolConfig poolConfig,
AbandonedConfig abandonedConfig)
Creates an object pool used to provide pooling support for
JDBC connections . |
protected PoolableConnectionFactory |
createPoolableConnectionFactory(ConnectionFactory driverConnectionFactory)
Creates the PoolableConnectionFactory and attaches it to the connection pool.
|
PrintWriter |
getAbandonedLogWriter()
Gets the log writer to be used by this configuration to log
information on abandoned objects.
|
boolean |
getAbandonedUsageTracking()
If the connection pool implements
UsageTracking , should the
connection pool record a stack trace every time a method is called on a
pooled connection and retain the most recent stack trace to aid debugging
of abandoned connections? |
boolean |
getCacheState()
Returns the state caching flag.
|
Connection |
getConnection()
Create (if necessary) and return a connection to the database.
|
Connection |
getConnection(String user,
String pass)
BasicDataSource does NOT support this method.
|
List<String> |
getConnectionInitSqls()
Returns the list of SQL statements executed when a physical connection
is first created.
|
String[] |
getConnectionInitSqlsAsArray()
Provides the same data as
getConnectionInitSqls() but in an
array so it is accessible via JMX. |
protected GenericObjectPool<PoolableConnection> |
getConnectionPool() |
Boolean |
getDefaultAutoCommit()
Returns the default auto-commit property.
|
String |
getDefaultCatalog()
Returns the default catalog.
|
Integer |
getDefaultQueryTimeout()
Obtain the default query timeout that will be used for
Statement s
created from this connection. |
Boolean |
getDefaultReadOnly()
Returns the default readOnly property.
|
int |
getDefaultTransactionIsolation()
Returns the default transaction isolation state of returned connections.
|
Set<String> |
getDisconnectionSqlCodes()
Returns the set of SQL_STATE codes considered to signal fatal conditions.
|
String[] |
getDisconnectionSqlCodesAsArray()
Provides the same data as
getDisconnectionSqlCodes() but in an
array so it is accessible via JMX. |
Driver |
getDriver()
Returns the JDBC Driver that has been configured for use by this pool.
|
ClassLoader |
getDriverClassLoader()
Returns the class loader specified for loading the JDBC driver.
|
String |
getDriverClassName()
Returns the JDBC driver class name.
|
boolean |
getEnableAutoCommitOnReturn()
Returns the value of the flag that controls whether or not connections
being returned to the pool will be checked and configured with
Connection.setAutoCommit(true)
if the auto commit setting is false when the connection
is returned. |
String |
getEvictionPolicyClassName()
Gets the EvictionPolicy implementation in use with this connection pool.
|
boolean |
getFastFailValidation()
True means that validation will fail immediately for connections that
have previously thrown SQLExceptions with SQL_STATE indicating fatal
disconnection errors.
|
int |
getInitialSize()
Returns the initial size of the connection pool.
|
String |
getJmxName()
Returns the JMX name that has been requested for this DataSource.
|
boolean |
getLifo()
Returns the LIFO property.
|
boolean |
getLogAbandoned()
Flag to log stack traces for application code which abandoned
a Statement or Connection.
|
boolean |
getLogExpiredConnections()
When
getMaxConnLifetimeMillis() is set to limit connection lifetime,
this property determines whether or not log messages are generated when the
pool closes connections due to maximum lifetime exceeded. |
int |
getLoginTimeout()
BasicDataSource does NOT support this method.
|
PrintWriter |
getLogWriter()
Returns the log writer being used by this data source.
|
long |
getMaxConnLifetimeMillis()
Returns the maximum permitted lifetime of a connection in milliseconds.
|
int |
getMaxIdle()
Returns the maximum number of connections that can remain idle in the
pool.
|
int |
getMaxOpenPreparedStatements()
Gets the value of the
maxOpenPreparedStatements property. |
int |
getMaxTotal()
Returns the maximum number of active connections that can be
allocated at the same time.
|
long |
getMaxWaitMillis()
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. |
Logger |
getParentLogger() |
String |
getPassword()
Returns the password passed to the JDBC driver to establish connections.
|
protected ObjectName |
getRegisteredJmxName() |
boolean |
getRemoveAbandonedOnBorrow()
Flag to remove abandoned connections if they exceed the
removeAbandonedTimeout when borrowObject is invoked.
|
boolean |
getRemoveAbandonedOnMaintenance()
Flag to remove abandoned connections if they exceed the
removeAbandonedTimeout during pool maintenance.
|
int |
getRemoveAbandonedTimeout()
Timeout in seconds before an abandoned connection can be removed.
|
boolean |
getRollbackOnReturn()
Gets the current value of the flag that controls if a connection will be
rolled back when it is returned to the pool if auto commit is not enabled
and the connection is not read only.
|
long |
getSoftMinEvictableIdleTimeMillis()
Returns the minimum amount of time a connection may sit idle in the
pool before it is eligible for eviction by the idle object evictor, with
the extra condition that at least "minIdle" connections remain in the
pool.
|
boolean |
getTestOnBorrow()
Returns the
testOnBorrow property. |
boolean |
getTestOnCreate()
Returns the
testOnCreate 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. |
String |
getUrl()
Returns the JDBC connection
url property. |
String |
getUsername()
Returns the JDBC connection
username property. |
String |
getValidationQuery()
Returns the validation query used to validate connections before
returning them.
|
int |
getValidationQueryTimeout()
Returns the validation query timeout.
|
void |
invalidateConnection(Connection connection)
Manually invalidates a connection, effectively requesting the pool to try
to close it, remove it from the pool and reclaim pool capacity.
|
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(Class<?> iface) |
protected void |
log(String message) |
void |
postDeregister() |
void |
postRegister(Boolean registrationDone) |
void |
preDeregister() |
ObjectName |
preRegister(MBeanServer server,
ObjectName name) |
void |
removeConnectionProperty(String name)
Remove a custom connection property.
|
void |
setAbandonedLogWriter(PrintWriter logWriter)
Sets the log writer to be used by this configuration to log
information on abandoned objects.
|
void |
setAbandonedUsageTracking(boolean usageTracking)
If the connection pool implements
UsageTracking , configure
whether the connection pool should record a stack trace every time a
method is called on a pooled connection and retain the most recent stack
trace to aid debugging of abandoned connections. |
void |
setAccessToUnderlyingConnectionAllowed(boolean allow)
Sets the value of the accessToUnderlyingConnectionAllowed property.
|
void |
setCacheState(boolean cacheState)
Sets the state caching flag.
|
void |
setConnectionInitSqls(Collection<String> connectionInitSqls)
Sets the list of SQL statements to be executed when a physical
connection is first created.
|
void |
setConnectionProperties(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(String defaultCatalog)
Sets the default catalog.
|
void |
setDefaultQueryTimeout(Integer defaultQueryTimeout)
Set the default query timeout that will be used for
Statement s
created from this connection. |
void |
setDefaultReadOnly(Boolean defaultReadOnly)
Sets defaultReadonly property.
|
void |
setDefaultTransactionIsolation(int defaultTransactionIsolation)
Sets the default transaction isolation state for returned
connections.
|
void |
setDisconnectionSqlCodes(Collection<String> disconnectionSqlCodes)
Sets the SQL_STATE codes considered to signal fatal conditions.
|
void |
setDriver(Driver driver)
Sets the JDBC Driver instance to use for this pool.
|
void |
setDriverClassLoader(ClassLoader driverClassLoader)
Sets the class loader to be used to load the JDBC driver.
|
void |
setDriverClassName(String driverClassName)
Sets the JDBC driver class name.
|
void |
setEnableAutoCommitOnReturn(boolean enableAutoCommitOnReturn)
Sets the value of the flag that controls whether or not connections
being returned to the pool will be checked and configured with
Connection.setAutoCommit(true)
if the auto commit setting is false when the connection
is returned. |
void |
setEvictionPolicyClassName(String evictionPolicyClassName)
Sets the EvictionPolicy implementation to use with this connection pool.
|
void |
setFastFailValidation(boolean fastFailValidation) |
void |
setInitialSize(int initialSize)
Sets the initial size of the connection pool.
|
void |
setJmxName(String jmxName)
Sets the JMX name that has been requested for this DataSource.
|
void |
setLifo(boolean lifo)
Sets the LIFO property.
|
void |
setLogAbandoned(boolean logAbandoned) |
void |
setLogExpiredConnections(boolean logExpiredConnections)
When
getMaxConnLifetimeMillis() is set to limit connection lifetime,
this property determines whether or not log messages are generated when the
pool closes connections due to maximum lifetime exceeded. |
void |
setLoginTimeout(int loginTimeout)
BasicDataSource does NOT support this method.
|
void |
setLogWriter(PrintWriter logWriter)
Sets the log writer being used by this data source.
|
void |
setMaxConnLifetimeMillis(long maxConnLifetimeMillis)
Sets the maximum permitted lifetime of a connection in
milliseconds.
|
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 |
setMaxTotal(int maxTotal)
Sets the maximum total number of idle and borrows connections that can be
active at the same time.
|
void |
setMaxWaitMillis(long maxWaitMillis)
Sets the MaxWaitMillis 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(String password)
Sets the
password . |
void |
setPoolPreparedStatements(boolean poolingStatements)
Sets whether to pool statements or not.
|
void |
setRemoveAbandonedOnBorrow(boolean removeAbandonedOnBorrow) |
void |
setRemoveAbandonedOnMaintenance(boolean removeAbandonedOnMaintenance) |
void |
setRemoveAbandonedTimeout(int removeAbandonedTimeout)
Sets the timeout in seconds before an abandoned connection can be
removed.
|
void |
setRollbackOnReturn(boolean rollbackOnReturn)
Sets the flag that controls if a connection will be rolled back when it
is returned to the pool if auto commit is not enabled and the connection
is not read only.
|
void |
setSoftMinEvictableIdleTimeMillis(long softMinEvictableIdleTimeMillis)
Sets the minimum amount of time a connection may sit idle in the pool
before it is eligible for eviction by the idle object evictor, with the
extra condition that at least "minIdle" connections remain in the pool.
|
void |
setTestOnBorrow(boolean testOnBorrow)
Sets the
testOnBorrow property. |
void |
setTestOnCreate(boolean testOnCreate)
Sets the
testOnCreate 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(String url)
Sets the
url . |
void |
setUsername(String username)
Sets the
username . |
void |
setValidationQuery(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.
|
protected void |
startPoolMaintenance()
Starts the connection pool maintenance task, if configured.
|
<T> T |
unwrap(Class<T> iface) |
protected static void |
validateConnectionFactory(PoolableConnectionFactory connectionFactory) |
public BasicDataSource()
public Boolean getDefaultAutoCommit()
getDefaultAutoCommit
in interface BasicDataSourceMXBean
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.
defaultAutoCommit
- default auto-commit valuepublic Boolean getDefaultReadOnly()
getDefaultReadOnly
in interface BasicDataSourceMXBean
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.
defaultReadOnly
- default read-only valuepublic int getDefaultTransactionIsolation()
getDefaultTransactionIsolation
in interface BasicDataSourceMXBean
Connection.getTransactionIsolation()
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.
defaultTransactionIsolation
- the default transaction isolation
stateConnection.getTransactionIsolation()
public Integer getDefaultQueryTimeout()
Statement
s
created from this connection. null
means that the driver
default will be used.public void setDefaultQueryTimeout(Integer defaultQueryTimeout)
Statement
s
created from this connection. null
means that the driver
default will be used.public String getDefaultCatalog()
getDefaultCatalog
in interface BasicDataSourceMXBean
public void setDefaultCatalog(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.
defaultCatalog
- the default catalogpublic boolean getCacheState()
getCacheState
in interface BasicDataSourceMXBean
public void setCacheState(boolean cacheState)
cacheState
- The new value for the state caching flagpublic Driver getDriver()
Note: This getter only returns the last value set by a call to
setDriver(Driver)
. It does not return any driver instance that
may have been created from the value set via
setDriverClassName(String)
.
public void setDriver(Driver 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.
driver
- public String getDriverClassName()
Note: This getter only returns the last value set by a call to
setDriverClassName(String)
. It does not return the class name of
any driver that may have been set via setDriver(Driver)
.
getDriverClassName
in interface BasicDataSourceMXBean
public void setDriverClassName(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.
driverClassName
- the class name of the JDBC driverpublic ClassLoader getDriverClassLoader()
null
if no class loader has been explicitly specified.
Note: This getter only returns the last value set by a call to
setDriverClassLoader(ClassLoader)
. It does not return the class
loader of any driver that may have been set via
setDriver(Driver)
.
public void setDriverClassLoader(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.
driverClassLoader
- the class loader with which to load the JDBC
driverpublic boolean getLifo()
getLifo
in interface BasicDataSourceMXBean
public void setLifo(boolean lifo)
lifo
- the new value for the LIFO propertypublic int getMaxTotal()
Returns the maximum number of active connections that can be allocated at the same time.
A negative number means that there is no limit.
getMaxTotal
in interface BasicDataSourceMXBean
public void setMaxTotal(int maxTotal)
maxTotal
- the new value for maxTotalgetMaxTotal()
public int getMaxIdle()
Returns the maximum number of connections that can remain idle in the pool. Excess idle connections are destroyed on return to the pool.
A negative value indicates that there is no limit
getMaxIdle
in interface BasicDataSourceMXBean
public void setMaxIdle(int maxIdle)
maxIdle
- the new value for maxIdlegetMaxIdle()
public int getMinIdle()
timeBetweenEvictionRunsMillis
has a positive value.getMinIdle
in interface BasicDataSourceMXBean
GenericObjectPool.getMinIdle()
public void setMinIdle(int minIdle)
timeBetweenEvictionRunsMillis
has a positive value.minIdle
- the new value for minIdleGenericObjectPool.setMinIdle(int)
public int getInitialSize()
getInitialSize
in interface BasicDataSourceMXBean
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.
initialSize
- the number of connections created when the pool
is initializedpublic long getMaxWaitMillis()
getMaxWaitMillis
in interface BasicDataSourceMXBean
public void setMaxWaitMillis(long maxWaitMillis)
maxWaitMillis
- the new value for MaxWaitMillisgetMaxWaitMillis()
public boolean isPoolPreparedStatements()
isPoolPreparedStatements
in interface BasicDataSourceMXBean
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.
poolingStatements
- pooling on or offpublic int getMaxOpenPreparedStatements()
maxOpenPreparedStatements
property.getMaxOpenPreparedStatements
in interface BasicDataSourceMXBean
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.
maxOpenStatements
- the new maximum number of prepared statementspublic boolean getTestOnCreate()
testOnCreate
property.getTestOnCreate
in interface BasicDataSourceMXBean
testOnCreate
public void setTestOnCreate(boolean testOnCreate)
testOnCreate
property. This property determines
whether or not the pool will validate objects immediately after they are
created by the pooltestOnCreate
- new value for testOnCreate propertypublic boolean getTestOnBorrow()
testOnBorrow
property.getTestOnBorrow
in interface BasicDataSourceMXBean
testOnBorrow
public void setTestOnBorrow(boolean testOnBorrow)
testOnBorrow
property. This property determines
whether or not the pool will validate objects before they are borrowed
from the pool.testOnBorrow
- new value for testOnBorrow propertypublic boolean getTestOnReturn()
testOnReturn
property.testOnReturn
public void setTestOnReturn(boolean testOnReturn)
testOnReturn
property. This property determines
whether or not the pool will validate objects before they are returned
to the pool.testOnReturn
- new value for testOnReturn propertypublic long getTimeBetweenEvictionRunsMillis()
timeBetweenEvictionRunsMillis
property.getTimeBetweenEvictionRunsMillis
in interface BasicDataSourceMXBean
timeBetweenEvictionRunsMillis
public void setTimeBetweenEvictionRunsMillis(long timeBetweenEvictionRunsMillis)
timeBetweenEvictionRunsMillis
property.timeBetweenEvictionRunsMillis
- the new time between evictor runstimeBetweenEvictionRunsMillis
public int getNumTestsPerEvictionRun()
numTestsPerEvictionRun
property.getNumTestsPerEvictionRun
in interface BasicDataSourceMXBean
numTestsPerEvictionRun
public void setNumTestsPerEvictionRun(int numTestsPerEvictionRun)
numTestsPerEvictionRun
property.numTestsPerEvictionRun
- the new numTestsPerEvictionRun
valuenumTestsPerEvictionRun
public long getMinEvictableIdleTimeMillis()
minEvictableIdleTimeMillis
property.getMinEvictableIdleTimeMillis
in interface BasicDataSourceMXBean
minEvictableIdleTimeMillis
propertyminEvictableIdleTimeMillis
public void setMinEvictableIdleTimeMillis(long minEvictableIdleTimeMillis)
minEvictableIdleTimeMillis
property.minEvictableIdleTimeMillis
- the minimum amount of time an object
may sit idle in the poolminEvictableIdleTimeMillis
public void setSoftMinEvictableIdleTimeMillis(long softMinEvictableIdleTimeMillis)
softMinEvictableIdleTimeMillis
- minimum amount of time a
connection may sit idle in the pool before it is eligible for eviction,
assuming there are minIdle idle connections in the pool.getSoftMinEvictableIdleTimeMillis()
public long getSoftMinEvictableIdleTimeMillis()
Returns the minimum amount of time a connection may sit idle in the pool before it is eligible for eviction by the idle object evictor, with the extra condition that at least "minIdle" connections remain in the pool.
When minEvictableIdleTimeMillis
is set to a positive value, minEvictableIdleTimeMillis is examined
first by the idle connection evictor - i.e. when idle connections are
visited by the evictor, idle time is first compared against
minEvictableIdleTimeMillis
(without considering the number of idle
connections in the pool) and then against
softMinEvictableIdleTimeMillis
, including the minIdle
,
constraint.
getSoftMinEvictableIdleTimeMillis
in interface BasicDataSourceMXBean
public String getEvictionPolicyClassName()
public void setEvictionPolicyClassName(String evictionPolicyClassName)
evictionPolicyClassName
- The fully qualified class name of the
EvictionPolicy implementationpublic boolean getTestWhileIdle()
testWhileIdle
property.getTestWhileIdle
in interface BasicDataSourceMXBean
testWhileIdle
public void setTestWhileIdle(boolean testWhileIdle)
testWhileIdle
property. This property determines
whether or not the idle object evictor will validate connections.testWhileIdle
- new value for testWhileIdle propertypublic int getNumActive()
getNumActive
in interface BasicDataSourceMXBean
public int getNumIdle()
getNumIdle
in interface BasicDataSourceMXBean
public String getPassword()
getPassword
in interface BasicDataSourceMXBean
public void setPassword(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.
password
- new value for the passwordpublic String getUrl()
url
property.getUrl
in interface BasicDataSourceMXBean
url
passed to the JDBC driver to establish
connectionspublic void setUrl(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.
url
- the new value for the JDBC connection urlpublic String getUsername()
username
property.getUsername
in interface BasicDataSourceMXBean
username
passed to the JDBC driver to establish
connectionspublic void setUsername(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.
username
- the new value for the JDBC connection usernamepublic String getValidationQuery()
getValidationQuery
in interface BasicDataSourceMXBean
validationQuery
public void setValidationQuery(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.
validationQuery
- the new value for the validation querypublic int getValidationQueryTimeout()
getValidationQueryTimeout
in interface BasicDataSourceMXBean
public void setValidationQueryTimeout(int 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.
timeout
- new validation query timeout value in secondspublic List<String> getConnectionInitSqls()
public String[] getConnectionInitSqlsAsArray()
getConnectionInitSqls()
but in an
array so it is accessible via JMX.getConnectionInitSqlsAsArray
in interface BasicDataSourceMXBean
getConnectionInitSqlsAsArray()
public void setConnectionInitSqls(Collection<String> connectionInitSqls)
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.
connectionInitSqls
- Collection of SQL statements to execute
on connection creationpublic boolean isAccessToUnderlyingConnectionAllowed()
isAccessToUnderlyingConnectionAllowed
in interface BasicDataSourceMXBean
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.
allow
- Access to the underlying connection is granted when true.public long getMaxConnLifetimeMillis()
getMaxConnLifetimeMillis
in interface BasicDataSourceMXBean
getMaxConnLifetimeMillis()
public boolean getLogExpiredConnections()
getMaxConnLifetimeMillis()
is set to limit connection lifetime,
this property determines whether or not log messages are generated when the
pool closes connections due to maximum lifetime exceeded.getLogExpiredConnections
in interface BasicDataSourceMXBean
getLogExpiredConnections()
public void setMaxConnLifetimeMillis(long maxConnLifetimeMillis)
Sets the maximum permitted lifetime of a connection in milliseconds. A value of zero or less indicates an infinite lifetime.
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.
public void setLogExpiredConnections(boolean logExpiredConnections)
getMaxConnLifetimeMillis()
is set to limit connection lifetime,
this property determines whether or not log messages are generated when the
pool closes connections due to maximum lifetime exceeded. Set this property
to false to suppress log messages when connections expire.public String getJmxName()
public void setJmxName(String jmxName)
public boolean getEnableAutoCommitOnReturn()
Connection.setAutoCommit(true)
if the auto commit setting is false
when the connection
is returned. It is true
by default.public void setEnableAutoCommitOnReturn(boolean enableAutoCommitOnReturn)
Connection.setAutoCommit(true)
if the auto commit setting is false
when the connection
is returned. It is true
by default.public boolean getRollbackOnReturn()
public void setRollbackOnReturn(boolean rollbackOnReturn)
public Set<String> getDisconnectionSqlCodes()
setDisconnectionSqlCodes(Collection)
public String[] getDisconnectionSqlCodesAsArray()
getDisconnectionSqlCodes()
but in an
array so it is accessible via JMX.getDisconnectionSqlCodesAsArray
in interface BasicDataSourceMXBean
getDisconnectionSqlCodesAsArray()
public void setDisconnectionSqlCodes(Collection<String> disconnectionSqlCodes)
Overrides the defaults in Utils.DISCONNECTION_SQL_CODES
(plus anything starting with Utils.DISCONNECTION_SQL_CODE_PREFIX
).
If this property is non-null and getFastFailValidation()
is
true
, whenever connections created by this datasource generate exceptions
with SQL_STATE codes in this list, they will be marked as "fatally disconnected"
and subsequent validations will fail fast (no attempt at isValid or validation
query).
If getFastFailValidation()
is false
setting this property has no
effect.
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
.
disconnectionSqlCodes
- SQL_STATE codes considered to signal fatal conditionspublic boolean getFastFailValidation()
getFastFailValidation
in interface BasicDataSourceMXBean
setDisconnectionSqlCodes(Collection)
public void setFastFailValidation(boolean fastFailValidation)
fastFailValidation
- true means connections created by this factory will
fast fail validationgetFastFailValidation()
protected GenericObjectPool<PoolableConnection> getConnectionPool()
public Connection getConnection() throws SQLException
getConnection
in interface DataSource
SQLException
- if a database access error occurspublic Connection getConnection(String user, String pass) throws SQLException
getConnection
in interface DataSource
user
- Database user on whose behalf the Connection
is being madepass
- The database user's passwordUnsupportedOperationException
SQLException
- if a database access error occurspublic int getLoginTimeout() throws SQLException
Returns the login timeout (in seconds) for connecting to the database.
Calls createDataSource()
, so has the side effect
of initializing the connection pool.
getLoginTimeout
in interface CommonDataSource
SQLException
- if a database access error occursUnsupportedOperationException
- If the DataSource implementation
does not support the login timeout feature.public PrintWriter getLogWriter() throws SQLException
Returns the log writer being used by this data source.
Calls createDataSource()
, so has the side effect
of initializing the connection pool.
getLogWriter
in interface CommonDataSource
SQLException
- if a database access error occurspublic void setLoginTimeout(int loginTimeout) throws SQLException
Set the login timeout (in seconds) for connecting to the database.
Calls createDataSource()
, so has the side effect
of initializing the connection pool.
setLoginTimeout
in interface CommonDataSource
loginTimeout
- The new login timeout, or zero for no timeoutUnsupportedOperationException
- If the DataSource implementation
does not support the login timeout feature.SQLException
- if a database access error occurspublic void setLogWriter(PrintWriter logWriter) throws SQLException
Sets the log writer being used by this data source.
Calls createDataSource()
, so has the side effect
of initializing the connection pool.
setLogWriter
in interface CommonDataSource
logWriter
- The new log writerSQLException
- if a database access error occurspublic boolean getRemoveAbandonedOnBorrow()
Flag to remove abandoned connections if they exceed the removeAbandonedTimeout when borrowObject is invoked.
The default value is false.
If set to true a connection is considered abandoned and eligible
for removal if it has not been used for more than
removeAbandonedTimeout
seconds.
Abandoned connections are identified and removed when
getConnection()
is invoked and all of the following conditions hold:
getRemoveAbandonedOnBorrow
in interface BasicDataSourceMXBean
getRemoveAbandonedOnBorrow()
getRemoveAbandonedTimeout()
public void setRemoveAbandonedOnMaintenance(boolean removeAbandonedOnMaintenance)
removeAbandonedOnMaintenance
- true means abandoned connections may
be removed on pool maintenance.getRemoveAbandonedOnMaintenance()
public boolean getRemoveAbandonedOnMaintenance()
Flag to remove abandoned connections if they exceed the removeAbandonedTimeout during pool maintenance.
The default value is false.
If set to true a connection is considered abandoned and eligible
for removal if it has not been used for more than
removeAbandonedTimeout
seconds.
getRemoveAbandonedOnMaintenance
in interface BasicDataSourceMXBean
getRemoveAbandonedOnMaintenance()
getRemoveAbandonedTimeout()
public void setRemoveAbandonedOnBorrow(boolean removeAbandonedOnBorrow)
removeAbandonedOnBorrow
- true means abandoned connections may be
removed when connections are borrowed from the pool.getRemoveAbandonedOnBorrow()
public int getRemoveAbandonedTimeout()
Timeout in seconds before an abandoned connection can be removed.
Creating a Statement, PreparedStatement or CallableStatement or using one of these to execute a query (using one of the execute methods) resets the lastUsed property of the parent connection.
Abandoned connection cleanup happens when:
getRemoveAbandonedOnBorrow()
or
getRemoveAbandonedOnMaintenance()
= truenumIdle
< 2numActive
> maxTotal
- 3The default value is 300 seconds.
getRemoveAbandonedTimeout
in interface BasicDataSourceMXBean
getRemoveAbandonedTimeout()
public void setRemoveAbandonedTimeout(int removeAbandonedTimeout)
Sets the timeout in seconds before an abandoned connection can be removed.
Setting this property has no effect if
getRemoveAbandonedOnBorrow()
and
getRemoveAbandonedOnMaintenance()
are false.
removeAbandonedTimeout
- new abandoned timeout in secondsgetRemoveAbandonedTimeout()
,
getRemoveAbandonedOnBorrow()
,
getRemoveAbandonedOnMaintenance()
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.
getLogAbandoned
in interface BasicDataSourceMXBean
getLogAbandoned()
public void setLogAbandoned(boolean logAbandoned)
logAbandoned
- new logAbandoned property valuepublic PrintWriter getAbandonedLogWriter()
public void setAbandonedLogWriter(PrintWriter logWriter)
logWriter
- The new log writerpublic boolean getAbandonedUsageTracking()
UsageTracking
, should the
connection pool record a stack trace every time a method is called on a
pooled connection and retain the most recent stack trace to aid debugging
of abandoned connections?getAbandonedUsageTracking
in interface BasicDataSourceMXBean
true
if usage tracking is enabledpublic void setAbandonedUsageTracking(boolean usageTracking)
UsageTracking
, configure
whether the connection pool should record a stack trace every time a
method is called on a pooled connection and retain the most recent stack
trace to aid debugging of abandoned connections.usageTracking
- A value of true
will enable
the recording of a stack trace on every use
of a pooled connectionpublic void addConnectionProperty(String name, String value)
name
- Name of the custom connection propertyvalue
- Value of the custom connection propertypublic void removeConnectionProperty(String name)
name
- Name of the custom connection property to removeaddConnectionProperty(String, String)
public void setConnectionProperties(String connectionProperties)
connectionProperties
- the connection properties used to
create new connectionspublic void close() throws 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.
close
in interface AutoCloseable
SQLException
- if an error occurs closing idle connectionspublic boolean isClosed()
isClosed
in interface BasicDataSourceMXBean
public boolean isWrapperFor(Class<?> iface) throws SQLException
isWrapperFor
in interface Wrapper
SQLException
public <T> T unwrap(Class<T> iface) throws SQLException
unwrap
in interface Wrapper
SQLException
public Logger getParentLogger() throws SQLFeatureNotSupportedException
getParentLogger
in interface CommonDataSource
SQLFeatureNotSupportedException
public void invalidateConnection(Connection connection) throws IllegalStateException
IllegalStateException
- if invalidating the connection failed.protected DataSource createDataSource() throws SQLException
Create (if necessary) and return the internal data source we are using to manage our connections.
SQLException
- if the object pool cannot be created.protected ConnectionFactory createConnectionFactory() throws SQLException
setDriver(Driver)
use itdriverClassName
is
specified that class is loaded using the ClassLoader
of this
class or, if driverClassLoader
is set, driverClassName
is loaded with the specified ClassLoader
.driverClassName
is specified and the previous attempt
fails, the class is loaded using the context class loader of the current
thread.DriverManager
using the specified url
.
SQLException
protected void createConnectionPool(PoolableConnectionFactory factory)
startPoolMaintenance()
, since setting timeBetweenEvictionRunsMillis
to a positive value causes GenericObjectPool
's eviction timer
to be started.protected GenericObjectPool<PoolableConnection> createObjectPool(PoolableConnectionFactory factory, GenericObjectPoolConfig poolConfig, AbandonedConfig abandonedConfig)
JDBC connections
.factory
- the object factorypoolConfig
- the object pool configurationabandonedConfig
- the abandoned objects configurationprotected void startPoolMaintenance()
protected DataSource createDataSourceInstance() throws SQLException
SQLException
- if unable to create a datasource instanceprotected PoolableConnectionFactory createPoolableConnectionFactory(ConnectionFactory driverConnectionFactory) throws SQLException
driverConnectionFactory
- JDBC connection factorySQLException
- if an error occurs creating the PoolableConnectionFactoryprotected static void validateConnectionFactory(PoolableConnectionFactory connectionFactory) throws Exception
Exception
public ObjectName preRegister(MBeanServer server, ObjectName name)
preRegister
in interface MBeanRegistration
public void postRegister(Boolean registrationDone)
postRegister
in interface MBeanRegistration
public void preDeregister() throws Exception
preDeregister
in interface MBeanRegistration
Exception
public void postDeregister()
postDeregister
in interface MBeanRegistration
protected ObjectName getRegisteredJmxName()
Copyright © 2001–2017 The Apache Software Foundation. All rights reserved.