/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.tomcat.dbcp.dbcp2;
import java.io.OutputStreamWriter;
import java.io.PrintWriter;
import java.nio.charset.StandardCharsets;
import java.sql.Connection;
import java.sql.Driver;
import java.sql.DriverManager;
import java.sql.SQLException;
import java.sql.SQLFeatureNotSupportedException;
import java.time.Duration;
import java.util.Collection;
import java.util.Collections;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Objects;
import java.util.Properties;
import java.util.Set;
import java.util.function.BiConsumer;
import java.util.logging.Logger;
import java.util.stream.Collector;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import javax.management.MBeanRegistration;
import javax.management.MBeanServer;
import javax.management.MalformedObjectNameException;
import javax.management.NotCompliantMBeanException;
import javax.management.ObjectName;
import javax.management.StandardMBean;
import javax.sql.DataSource;
import org.apache.juli.logging.Log;
import org.apache.juli.logging.LogFactory;
import org.apache.tomcat.dbcp.pool2.PooledObject;
import org.apache.tomcat.dbcp.pool2.impl.AbandonedConfig;
import org.apache.tomcat.dbcp.pool2.impl.BaseObjectPoolConfig;
import org.apache.tomcat.dbcp.pool2.impl.GenericKeyedObjectPoolConfig;
import org.apache.tomcat.dbcp.pool2.impl.GenericObjectPool;
import org.apache.tomcat.dbcp.pool2.impl.GenericObjectPoolConfig;
/**
* Basic implementation of {@code javax.sql.DataSource} that is configured via JavaBeans properties.
* <p>
* This is not the only way to combine the <em>commons-dbcp2</em> and <em>commons-pool2</em> packages, but provides a
* one-stop solution for basic requirements.
* </p>
*
* @since 2.0
*/
public class BasicDataSource implements DataSource, BasicDataSourceMXBean, MBeanRegistration, AutoCloseable {
private static final Log log = LogFactory.getLog(BasicDataSource.class);
static {
// Attempt to prevent deadlocks - see DBCP-272
DriverManager.getDrivers(); // NOPMD
}
/**
* Validates the given factory.
*
* @param connectionFactory the factory
* @throws SQLException Thrown by one of the factory methods while managing a temporary pooled object.
*/
protected static void validateConnectionFactory(final PoolableConnectionFactory connectionFactory) throws SQLException {
PoolableConnection conn = null;
PooledObject<PoolableConnection> p = null;
try {
p = connectionFactory.makeObject();
conn = p.getObject();
connectionFactory.activateObject(p);
connectionFactory.validateConnection(conn);
connectionFactory.passivateObject(p);
} finally {
if (p != null) {
connectionFactory.destroyObject(p);
}
}
}
/**
* The default auto-commit state of connections created by this pool.
*/
private volatile Boolean defaultAutoCommit;
/**
* The default read-only state of connections created by this pool.
*/
private transient Boolean defaultReadOnly;
/**
* The default TransactionIsolation state of connections created by this pool.
*/
private volatile int defaultTransactionIsolation = PoolableConnectionFactory.UNKNOWN_TRANSACTION_ISOLATION;
private Duration defaultQueryTimeoutDuration;
/**
* The default "catalog" of connections created by this pool.
*/
private volatile String defaultCatalog;
/**
* The default "schema" of connections created by this pool.
*/
private volatile String defaultSchema;
/**
* The property that controls if the pooled connections cache some state rather than query the database for current
* state to improve performance.
*/
private volatile boolean cacheState = true;
/**
* The instance of the JDBC Driver to use.
*/
private Driver driver;
/**
* The fully qualified Java class name of the JDBC driver to be used.
*/
private String driverClassName;
/**
* The class loader instance to use to load the JDBC driver. If not specified, {@link Class#forName(String)} is used
* to load the JDBC driver. If specified, {@link Class#forName(String, boolean, ClassLoader)} is used.
*/
private ClassLoader driverClassLoader;
/**
* True means that borrowObject returns the most recently used ("last in") connection in the pool (if there are idle
* connections available). False means that the pool behaves as a FIFO queue - connections are taken from the idle
* instance pool in the order that they are returned to the pool.
*/
private boolean lifo = BaseObjectPoolConfig.DEFAULT_LIFO;
/**
* The maximum number of active connections that can be allocated from this pool at the same time, or negative for
* no limit.
*/
private int maxTotal = GenericObjectPoolConfig.DEFAULT_MAX_TOTAL;
/**
* The maximum number of connections that can remain idle in the pool, without extra ones being destroyed, or
* negative for no limit. If maxIdle is set too low on heavily loaded systems it is possible you will see
* connections being closed and almost immediately new connections being opened. This is a result of the active
* threads momentarily closing connections faster than they are opening them, causing the number of idle connections
* to rise above maxIdle. The best value for maxIdle for heavily loaded system will vary but the default is a good
* starting point.
*/
private int maxIdle = GenericObjectPoolConfig.DEFAULT_MAX_IDLE;
/**
* The minimum number of active connections that can remain idle in the pool, without extra ones being created when
* the evictor runs, or 0 to create none. The pool attempts to ensure that minIdle connections are available when
* the idle object evictor runs. The value of this property has no effect unless
* {@link #durationBetweenEvictionRuns} has a positive value.
*/
private int minIdle = GenericObjectPoolConfig.DEFAULT_MIN_IDLE;
/**
* The initial number of connections that are created when the pool is started.
*/
private int initialSize;
/**
* The maximum Duration that the pool will wait (when there are no available connections) for a
* connection to be returned before throwing an exception, or <= 0 to wait indefinitely.
*/
private Duration maxWaitDuration = BaseObjectPoolConfig.DEFAULT_MAX_WAIT;
/**
* Prepared statement pooling for this pool. When this property is set to {@code true} both PreparedStatements
* and CallableStatements are pooled.
*/
private boolean poolPreparedStatements;
private volatile boolean clearStatementPoolOnReturn;
/**
* <p>
* The maximum number of open statements that can be allocated from the statement pool at the same time, or negative
* for no limit. Since a connection usually only uses one or two statements at a time, this is mostly used to help
* detect resource leaks.
* </p>
* <p>
* Note: As of version 1.3, CallableStatements (those produced by {@link Connection#prepareCall}) are pooled along
* with PreparedStatements (produced by {@link Connection#prepareStatement}) and
* {@code maxOpenPreparedStatements} limits the total number of prepared or callable statements that may be in
* use at a given time.
* </p>
*/
private int maxOpenPreparedStatements = GenericKeyedObjectPoolConfig.DEFAULT_MAX_TOTAL;
/**
* The indication of whether objects will be validated as soon as they have been created by the pool. If the object
* fails to validate, the borrow operation that triggered the creation will fail.
*/
private boolean testOnCreate;
/**
* The indication of whether objects will be validated before being borrowed from the pool. If the object fails to
* validate, it will be dropped from the pool, and we will attempt to borrow another.
*/
private boolean testOnBorrow = true;
/**
* The indication of whether objects will be validated before being returned to the pool.
*/
private boolean testOnReturn;
/**
* The number of milliseconds to sleep between runs of the idle object evictor thread. When non-positive, no idle
* object evictor thread will be run.
*/
private Duration durationBetweenEvictionRuns = BaseObjectPoolConfig.DEFAULT_DURATION_BETWEEN_EVICTION_RUNS;
/**
* The number of objects to examine during each run of the idle object evictor thread (if any).
*/
private int numTestsPerEvictionRun = BaseObjectPoolConfig.DEFAULT_NUM_TESTS_PER_EVICTION_RUN;
/**
* The minimum amount of time an object may sit idle in the pool before it is eligible for eviction by the idle
* object evictor (if any).
*/
private Duration minEvictableIdleDuration = BaseObjectPoolConfig.DEFAULT_MIN_EVICTABLE_IDLE_DURATION;
/**
* 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. Note that
* {@code minEvictableIdleTimeMillis} takes precedence over this parameter. See
* {@link #getSoftMinEvictableIdleDuration()}.
*/
private Duration softMinEvictableIdleDuration = BaseObjectPoolConfig.DEFAULT_SOFT_MIN_EVICTABLE_IDLE_DURATION;
private String evictionPolicyClassName = BaseObjectPoolConfig.DEFAULT_EVICTION_POLICY_CLASS_NAME;
/**
* The indication of whether objects will be validated by the idle object evictor (if any). If an object fails to
* validate, it will be dropped from the pool.
*/
private boolean testWhileIdle;
/**
* The connection password to be passed to our JDBC driver to establish a connection.
*/
private volatile String password;
/**
* The connection string to be passed to our JDBC driver to establish a connection.
*/
private String connectionString;
/**
* The connection user name to be passed to our JDBC driver to establish a connection.
*/
private String userName;
/**
* The SQL query that will be used to validate connections from this pool before returning them to the caller. If
* specified, this query <strong>MUST</strong> be an SQL SELECT statement that returns at least one row. If not
* specified, {@link Connection#isValid(int)} will be used to validate connections.
*/
private volatile String validationQuery;
/**
* Timeout in seconds before connection validation queries fail.
*/
private volatile Duration validationQueryTimeoutDuration = Duration.ofSeconds(-1);
/**
* The fully qualified Java class name of a {@link ConnectionFactory} implementation.
*/
private String connectionFactoryClassName;
/**
* These SQL statements run once after a Connection is created.
* <p>
* This property can be used for example to run ALTER SESSION SET NLS_SORT=XCYECH in an Oracle Database only once
* after connection creation.
* </p>
*/
private volatile List<String> connectionInitSqls;
/**
* Controls access to the underlying connection.
*/
private volatile boolean accessToUnderlyingConnectionAllowed;
private Duration maxConnDuration = Duration.ofMillis(-1);
private volatile boolean logExpiredConnections = true;
private String jmxName;
private volatile boolean registerConnectionMBean = true;
private volatile boolean autoCommitOnReturn = true;
private volatile boolean rollbackOnReturn = true;
private volatile Set<String> disconnectionSqlCodes;
/**
* A collection of SQL State codes that are not considered fatal disconnection codes.
*
* @since 2.13.0
*/
private volatile Set<String> disconnectionIgnoreSqlCodes;
private volatile boolean fastFailValidation;
/**
* The object pool that internally manages our connections.
*/
private volatile GenericObjectPool<PoolableConnection> connectionPool;
/**
* The connection properties that will be sent to our JDBC driver when establishing new connections.
* <strong>NOTE</strong> - The "user" and "password" properties will be passed explicitly, so they do not need to be
* included here.
*/
private Properties connectionProperties = new Properties();
/**
* The data source we will use to manage connections. This object should be acquired <strong>ONLY</strong> by calls
* to the {@code createDataSource()} method.
*/
private volatile DataSource dataSource;
/**
* The PrintWriter to which log messages should be directed.
*/
private volatile PrintWriter logWriter = new PrintWriter(
new OutputStreamWriter(System.out, StandardCharsets.UTF_8));
private AbandonedConfig abandonedConfig;
private boolean closed;
/**
* Actual name under which this component has been registered.
*/
private ObjectNameWrapper registeredJmxObjectName;
/**
* Constructs a new instance.
*/
public BasicDataSource() {
// empty
}
/**
* Adds a custom connection property to the set that will be passed to our JDBC driver. This <strong>MUST</strong>
* 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.
*
* @param name Name of the custom connection property
* @param value Value of the custom connection property
*/
public void addConnectionProperty(final String name, final String value) {
connectionProperties.put(name, value);
}
/**
* Closes and releases all idle connections that are currently stored in the connection pool associated with this
* data source.
* <p>
* Connections that are checked out to clients when this method is invoked are not affected. When client
* applications subsequently invoke {@link Connection#close()} to return these connections to the pool, the
* underlying JDBC connections are closed.
* </p>
* <p>
* Attempts to acquire connections using {@link #getConnection()} after this method has been invoked result in
* SQLExceptions. To reopen a datasource that has been closed using this method, use {@link #start()}.
* </p>
* <p>
* This method is idempotent - i.e., closing an already closed BasicDataSource has no effect and does not generate
* exceptions.
* </p>
*
* @throws SQLException if an error occurs closing idle connections
*/
@Override
public synchronized void close() throws SQLException {
if (registeredJmxObjectName != null) {
registeredJmxObjectName.unregisterMBean();
registeredJmxObjectName = null;
}
closed = true;
final GenericObjectPool<?> oldPool = connectionPool;
connectionPool = null;
dataSource = null;
try {
if (oldPool != null) {
oldPool.close();
}
} catch (final RuntimeException e) {
throw e;
} catch (final Exception e) {
throw new SQLException(Utils.getMessage("pool.close.fail"), e);
}
}
/**
* Closes the connection pool, silently swallowing any exception that occurs.
*/
private void closeConnectionPool() {
final GenericObjectPool<?> oldPool = connectionPool;
connectionPool = null;
Utils.closeQuietly(oldPool);
}
/**
* Creates a JDBC connection factory for this data source. The JDBC driver is loaded using the following algorithm:
* <ol>
* <li>If a Driver instance has been specified via {@link #setDriver(Driver)} use it</li>
* <li>If no Driver instance was specified and {code driverClassName} is specified that class is loaded using the
* {@link ClassLoader} of this class or, if {code driverClassLoader} is set, {code driverClassName} is loaded
* with the specified {@link ClassLoader}.</li>
* <li>If {code driverClassName} is specified and the previous attempt fails, the class is loaded using the
* context class loader of the current thread.</li>
* <li>If a driver still isn't loaded one is loaded via the {@link DriverManager} using the specified {code connectionString}.</li>
* </ol>
* <p>
* This method exists so subclasses can replace the implementation class.
* </p>
*
* @return A new connection factory.
* @throws SQLException If the connection factory cannot be created
*/
protected ConnectionFactory createConnectionFactory() throws SQLException {
// Load the JDBC driver class
return ConnectionFactoryFactory.createConnectionFactory(this, DriverFactory.createDriver(this));
}
/**
* Creates a connection pool for this datasource. This method only exists so subclasses can replace the
* implementation class.
* <p>
* This implementation configures all pool properties other than timeBetweenEvictionRunsMillis. Setting that
* property is deferred to {@link #startPoolMaintenance()}, since setting timeBetweenEvictionRunsMillis to a
* positive value causes {@link GenericObjectPool}'s eviction timer to be started.
* </p>
*
* @param factory The factory to use to create new connections for this pool.
*/
protected void createConnectionPool(final PoolableConnectionFactory factory) {
// Create an object pool to contain our active connections
final GenericObjectPoolConfig<PoolableConnection> config = new GenericObjectPoolConfig<>();
updateJmxName(config);
// Disable JMX on the underlying pool if the DS is not registered:
config.setJmxEnabled(registeredJmxObjectName != null);
// Set up usage tracking if enabled
if (getAbandonedUsageTracking() && abandonedConfig != null) {
abandonedConfig.setUseUsageTracking(true);
}
final GenericObjectPool<PoolableConnection> gop = createObjectPool(factory, config, abandonedConfig);
gop.setMaxTotal(maxTotal);
gop.setMaxIdle(maxIdle);
gop.setMinIdle(minIdle);
gop.setMaxWait(maxWaitDuration);
gop.setTestOnCreate(testOnCreate);
gop.setTestOnBorrow(testOnBorrow);
gop.setTestOnReturn(testOnReturn);
gop.setNumTestsPerEvictionRun(numTestsPerEvictionRun);
gop.setMinEvictableIdleDuration(minEvictableIdleDuration);
gop.setSoftMinEvictableIdleDuration(softMinEvictableIdleDuration);
gop.setTestWhileIdle(testWhileIdle);
gop.setLifo(lifo);
gop.setSwallowedExceptionListener(new SwallowedExceptionLogger(log, logExpiredConnections));
gop.setEvictionPolicyClassName(evictionPolicyClassName);
factory.setPool(gop);
connectionPool = gop;
}
/**
* Creates (if necessary) and return the internal data source we are using to manage our connections.
*
* @return The current internal DataSource or a newly created instance if it has not yet been created.
* @throws SQLException if the object pool cannot be created.
*/
protected synchronized DataSource createDataSource() throws SQLException {
if (closed) {
throw new SQLException("Data source is closed");
}
// Return the pool if we have already created it
// This is double-checked locking. This is safe since dataSource is
// volatile and the code is targeted at Java 5 onwards.
if (dataSource != null) {
return dataSource;
}
synchronized (this) {
if (dataSource != null) {
return dataSource;
}
jmxRegister();
// create factory which returns raw physical connections
final ConnectionFactory driverConnectionFactory = createConnectionFactory();
// Set up the poolable connection factory
final PoolableConnectionFactory poolableConnectionFactory;
try {
poolableConnectionFactory = createPoolableConnectionFactory(driverConnectionFactory);
poolableConnectionFactory.setPoolStatements(poolPreparedStatements);
poolableConnectionFactory.setMaxOpenPreparedStatements(maxOpenPreparedStatements);
// create a pool for our connections
createConnectionPool(poolableConnectionFactory);
final DataSource newDataSource = createDataSourceInstance();
newDataSource.setLogWriter(logWriter);
connectionPool.addObjects(initialSize);
// If timeBetweenEvictionRunsMillis > 0, start the pool's evictor
// task
startPoolMaintenance();
dataSource = newDataSource;
} catch (final SQLException | RuntimeException se) {
closeConnectionPool();
throw se;
} catch (final Exception ex) {
closeConnectionPool();
throw new SQLException("Error creating connection factory", ex);
}
return dataSource;
}
}
/**
* Creates the actual data source instance. This method only exists so that subclasses can replace the
* implementation class.
*
* @throws SQLException if unable to create a datasource instance
* @return A new DataSource instance
*/
protected DataSource createDataSourceInstance() throws SQLException {
final PoolingDataSource<PoolableConnection> pds = new PoolingDataSource<>(connectionPool);
pds.setAccessToUnderlyingConnectionAllowed(isAccessToUnderlyingConnectionAllowed());
return pds;
}
/**
* Creates an object pool used to provide pooling support for {@link Connection JDBC connections}.
*
* @param factory the object factory
* @param poolConfig the object pool configuration
* @param abandonedConfig the abandoned objects configuration
* @return a non-null instance
*/
protected GenericObjectPool<PoolableConnection> createObjectPool(final PoolableConnectionFactory factory,
final GenericObjectPoolConfig<PoolableConnection> poolConfig, final AbandonedConfig abandonedConfig) {
final GenericObjectPool<PoolableConnection> gop;
if (abandonedConfig != null && (abandonedConfig.getRemoveAbandonedOnBorrow()
|| abandonedConfig.getRemoveAbandonedOnMaintenance())) {
gop = new GenericObjectPool<>(factory, poolConfig, abandonedConfig);
} else {
gop = new GenericObjectPool<>(factory, poolConfig);
}
return gop;
}
/**
* Creates the PoolableConnectionFactory and attaches it to the connection pool. This method only exists so
* subclasses can replace the default implementation.
*
* @param driverConnectionFactory JDBC connection factory
* @throws SQLException if an error occurs creating the PoolableConnectionFactory
* @return A new PoolableConnectionFactory configured with the current configuration of this BasicDataSource
*/
protected PoolableConnectionFactory createPoolableConnectionFactory(final ConnectionFactory driverConnectionFactory)
throws SQLException {
PoolableConnectionFactory connectionFactory = null;
try {
if (registerConnectionMBean) {
connectionFactory = new PoolableConnectionFactory(driverConnectionFactory, ObjectNameWrapper.unwrap(registeredJmxObjectName));
} else {
connectionFactory = new PoolableConnectionFactory(driverConnectionFactory, null);
}
connectionFactory.setValidationQuery(validationQuery);
connectionFactory.setValidationQueryTimeout(validationQueryTimeoutDuration);
connectionFactory.setConnectionInitSql(connectionInitSqls);
connectionFactory.setDefaultReadOnly(defaultReadOnly);
connectionFactory.setDefaultAutoCommit(defaultAutoCommit);
connectionFactory.setDefaultTransactionIsolation(defaultTransactionIsolation);
connectionFactory.setDefaultCatalog(defaultCatalog);
connectionFactory.setDefaultSchema(defaultSchema);
connectionFactory.setCacheState(cacheState);
connectionFactory.setPoolStatements(poolPreparedStatements);
connectionFactory.setClearStatementPoolOnReturn(clearStatementPoolOnReturn);
connectionFactory.setMaxOpenPreparedStatements(maxOpenPreparedStatements);
connectionFactory.setMaxConn(maxConnDuration);
connectionFactory.setRollbackOnReturn(getRollbackOnReturn());
connectionFactory.setAutoCommitOnReturn(getAutoCommitOnReturn());
connectionFactory.setDefaultQueryTimeout(getDefaultQueryTimeoutDuration());
connectionFactory.setFastFailValidation(fastFailValidation);
connectionFactory.setDisconnectionSqlCodes(disconnectionSqlCodes);
connectionFactory.setDisconnectionIgnoreSqlCodes(disconnectionIgnoreSqlCodes);
validateConnectionFactory(connectionFactory);
} catch (final RuntimeException e) {
throw e;
} catch (final Exception e) {
throw new SQLException("Cannot create PoolableConnectionFactory (" + e.getMessage() + ")", e);
}
return connectionFactory;
}
/**
* Manually evicts idle connections
*
* @throws Exception when there is a problem evicting idle objects.
*/
public void evict() throws Exception {
if (connectionPool != null) {
connectionPool.evict();
}
}
/**
* Gets the print writer used by this configuration to log information on abandoned objects.
*
* @return The print writer used by this configuration to log information on abandoned objects.
*/
public PrintWriter getAbandonedLogWriter() {
return abandonedConfig == null ? null : abandonedConfig.getLogWriter();
}
/**
* If the connection pool implements {@link org.apache.tomcat.dbcp.pool2.UsageTracking 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?
*
* @return {@code true} if usage tracking is enabled
*/
@Override
public boolean getAbandonedUsageTracking() {
return abandonedConfig != null && abandonedConfig.getUseUsageTracking();
}
/**
* Gets the value of the flag that controls whether or not connections being returned to the pool will be checked
* and configured with {@link Connection#setAutoCommit(boolean) Connection.setAutoCommit(true)} if the auto commit
* setting is {@code false} when the connection is returned. It is {@code true} by default.
*
* @return Whether or not connections being returned to the pool will be checked and configured with auto-commit.
*/
public boolean getAutoCommitOnReturn() {
return autoCommitOnReturn;
}
/**
* Gets the state caching flag.
*
* @return the state caching flag
*/
@Override
public boolean getCacheState() {
return cacheState;
}
/**
* Creates (if necessary) and return a connection to the database.
*
* @throws SQLException if a database access error occurs
* @return a database connection
*/
@Override
public Connection getConnection() throws SQLException {
return createDataSource().getConnection();
}
/**
* <strong>BasicDataSource does NOT support this method.</strong>
*
* @param user Database user on whose behalf the Connection is being made
* @param pass The database user's password
* @throws UnsupportedOperationException always thrown.
* @throws SQLException if a database access error occurs
* @return nothing - always throws UnsupportedOperationException
*/
@Override
public Connection getConnection(final String user, final String pass) throws SQLException {
// This method isn't supported by the PoolingDataSource returned by the
// createDataSource
throw new UnsupportedOperationException("Not supported by BasicDataSource");
}
/**
* Gets the ConnectionFactoryClassName that has been configured for use by this pool.
* <p>
* Note: This getter only returns the last value set by a call to {@link #setConnectionFactoryClassName(String)}.
* </p>
*
* @return the ConnectionFactoryClassName that has been configured for use by this pool.
* @since 2.7.0
*/
public String getConnectionFactoryClassName() {
return this.connectionFactoryClassName;
}
/**
* Gets the list of SQL statements executed when a physical connection is first created. Returns an empty list if
* there are no initialization statements configured.
*
* @return initialization SQL statements
*/
public List<String> getConnectionInitSqls() {
final List<String> result = connectionInitSqls;
return result == null ? Collections.emptyList() : result;
}
/**
* Provides the same data as {@link #getConnectionInitSqls()} but in an array so it is accessible via JMX.
*/
@Override
public String[] getConnectionInitSqlsAsArray() {
return getConnectionInitSqls().toArray(Utils.EMPTY_STRING_ARRAY);
}
/**
* Gets the underlying connection pool.
*
* @return the underlying connection pool.
* @since DBCP 2.10.0
*/
public GenericObjectPool<PoolableConnection> getConnectionPool() {
return connectionPool;
}
Properties getConnectionProperties() {
return connectionProperties;
}
/**
* Gets the default auto-commit property.
*
* @return true if default auto-commit is enabled
*/
@Override
public Boolean getDefaultAutoCommit() {
return defaultAutoCommit;
}
/**
* Gets the default catalog.
*
* @return the default catalog
*/
@Override
public String getDefaultCatalog() {
return this.defaultCatalog;
}
/**
* Gets the default query timeout that will be used for {@link java.sql.Statement Statement}s created from this
* connection. {@code null} means that the driver default will be used.
*
* @return The default query timeout in seconds.
* @deprecated Use {@link #getDefaultQueryTimeoutDuration()}.
*/
@Deprecated
public Integer getDefaultQueryTimeout() {
return defaultQueryTimeoutDuration == null ? null : Integer.valueOf((int) defaultQueryTimeoutDuration.getSeconds());
}
/**
* Gets the default query timeout that will be used for {@link java.sql.Statement Statement}s created from this
* connection. {@code null} means that the driver default will be used.
*
* @return The default query timeout Duration.
* @since 2.10.0
*/
public Duration getDefaultQueryTimeoutDuration() {
return defaultQueryTimeoutDuration;
}
/**
* Gets the default readOnly property.
*
* @return true if connections are readOnly by default
*/
@Override
public Boolean getDefaultReadOnly() {
return defaultReadOnly;
}
/**
* Gets the default schema.
*
* @return the default schema.
* @since 2.5.0
*/
@Override
public String getDefaultSchema() {
return this.defaultSchema;
}
/**
* Gets the default transaction isolation state of returned connections.
*
* @return the default value for transaction isolation state
* @see Connection#getTransactionIsolation
*/
@Override
public int getDefaultTransactionIsolation() {
return this.defaultTransactionIsolation;
}
/**
* Gets the set of SQL State codes that are not considered fatal disconnection codes.
* <p>
* This method returns the set of SQL State codes that have been specified to be ignored
* when determining if a {@link SQLException} signals a disconnection. These codes will not
* trigger a disconnection even if they match other disconnection criteria.
* </p>
*
* @return a set of SQL State codes that should be ignored for disconnection checks, or an empty set if none have been specified.
* @since 2.13.0
*/
public Set<String> getDisconnectionIgnoreSqlCodes() {
final Set<String> result = disconnectionIgnoreSqlCodes;
return result == null ? Collections.emptySet() : result;
}
/**
* Provides the same data as {@link #getDisconnectionIgnoreSqlCodes()} but in an array, so it is accessible via JMX.
*
* @since 2.13.0
*/
@Override
public String[] getDisconnectionIgnoreSqlCodesAsArray() {
return getDisconnectionIgnoreSqlCodes().toArray(Utils.EMPTY_STRING_ARRAY);
}
/**
* Gets the set of SQL State codes considered to signal fatal conditions.
*
* @return fatal disconnection state codes
* @see #setDisconnectionSqlCodes(Collection)
* @since 2.1
*/
public Set<String> getDisconnectionSqlCodes() {
final Set<String> result = disconnectionSqlCodes;
return result == null ? Collections.emptySet() : result;
}
/**
* Provides the same data as {@link #getDisconnectionSqlCodes} but in an array so it is accessible via JMX.
*
* @since 2.1
*/
@Override
public String[] getDisconnectionSqlCodesAsArray() {
return getDisconnectionSqlCodes().toArray(Utils.EMPTY_STRING_ARRAY);
}
/**
* Gets the JDBC Driver that has been configured for use by this pool.
* <p>
* Note: This getter only returns the last value set by a call to {@link #setDriver(Driver)}. It does not return any
* driver instance that may have been created from the value set via {@link #setDriverClassName(String)}.
* </p>
*
* @return the JDBC Driver that has been configured for use by this pool
*/
public synchronized Driver getDriver() {
return driver;
}
/**
* Gets the class loader specified for loading the JDBC driver. Returns {@code null} if no class loader has
* been explicitly specified.
* <p>
* Note: This getter only returns the last value set by a call to {@link #setDriverClassLoader(ClassLoader)}. It
* does not return the class loader of any driver that may have been set via {@link #setDriver(Driver)}.
* </p>
*
* @return The class loader specified for loading the JDBC driver.
*/
public synchronized ClassLoader getDriverClassLoader() {
return this.driverClassLoader;
}
/**
* Gets the JDBC driver class name.
* <p>
* Note: This getter only returns the last value set by a call to {@link #setDriverClassName(String)}. It does not
* return the class name of any driver that may have been set via {@link #setDriver(Driver)}.
* </p>
*
* @return the JDBC driver class name
*/
@Override
public synchronized String getDriverClassName() {
return this.driverClassName;
}
/**
* Gets the value of the {code durationBetweenEvictionRuns} property.
*
* @return the time (in milliseconds) between evictor runs
* @see #setDurationBetweenEvictionRuns(Duration)
* @since 2.10.0
*/
public synchronized Duration getDurationBetweenEvictionRuns() {
return this.durationBetweenEvictionRuns;
}
/**
* Gets the value of the flag that controls whether or not connections being returned to the pool will be checked
* and configured with {@link Connection#setAutoCommit(boolean) Connection.setAutoCommit(true)} if the auto commit
* setting is {@code false} when the connection is returned. It is {@code true} by default.
*
* @return Whether or not connections being returned to the pool will be checked and configured with auto-commit.
* @deprecated Use {@link #getAutoCommitOnReturn()}.
*/
@Deprecated
public boolean getEnableAutoCommitOnReturn() {
return autoCommitOnReturn;
}
/**
* Gets the EvictionPolicy implementation in use with this connection pool.
*
* @return The EvictionPolicy implementation in use with this connection pool.
*/
public synchronized String getEvictionPolicyClassName() {
return evictionPolicyClassName;
}
/**
* True means that validation will fail immediately for connections that have previously thrown SQLExceptions with
* SQL State indicating fatal disconnection errors.
*
* @return true if connections created by this datasource will fast fail validation.
* @see #setDisconnectionSqlCodes(Collection)
* @see #setDisconnectionIgnoreSqlCodes(Collection)
* @since 2.1
*/
@Override
public boolean getFastFailValidation() {
return fastFailValidation;
}
/**
* Gets the initial size of the connection pool.
*
* @return the number of connections created when the pool is initialized
*/
@Override
public synchronized int getInitialSize() {
return this.initialSize;
}
/**
* Gets the JMX name that has been requested for this DataSource. If the requested name is not valid, an
* alternative may be chosen.
*
* @return The JMX name that has been requested for this DataSource.
*/
public String getJmxName() {
return jmxName;
}
/**
* Gets the LIFO property.
*
* @return true if connection pool behaves as a LIFO queue.
*/
@Override
public synchronized boolean getLifo() {
return this.lifo;
}
/**
* Flag to log stack traces for application code which abandoned a Statement or Connection.
* <p>
* Defaults to false.
* </p>
* <p>
* Logging of abandoned Statements and Connections adds overhead for every Connection open or new Statement because
* a stack trace has to be generated.
* </p>
*/
@Override
public boolean getLogAbandoned() {
return abandonedConfig != null && abandonedConfig.getLogAbandoned();
}
/**
* When {@link #getMaxConnDuration()} 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.
*
* @since 2.1
*/
@Override
public boolean getLogExpiredConnections() {
return logExpiredConnections;
}
/**
* <strong>BasicDataSource does NOT support this method.</strong>
*
* <p>
* Gets the login timeout (in seconds) for connecting to the database.
* </p>
* <p>
* Calls {@link #createDataSource()}, so has the side effect of initializing the connection pool.
* </p>
*
* @throws SQLException if a database access error occurs
* @throws UnsupportedOperationException If the DataSource implementation does not support the login timeout
* feature.
* @return login timeout in seconds
*/
@Override
public int getLoginTimeout() throws SQLException {
// This method isn't supported by the PoolingDataSource returned by the createDataSource
throw new UnsupportedOperationException("Not supported by BasicDataSource");
}
/**
* Gets the log writer being used by this data source.
* <p>
* Calls {@link #createDataSource()}, so has the side effect of initializing the connection pool.
* </p>
*
* @throws SQLException if a database access error occurs
* @return log writer in use
*/
@Override
public PrintWriter getLogWriter() throws SQLException {
return createDataSource().getLogWriter();
}
/**
* Gets the maximum permitted duration of a connection. A value of zero or less indicates an
* infinite lifetime.
* @return the maximum permitted duration of a connection.
* @since 2.10.0
*/
public Duration getMaxConnDuration() {
return maxConnDuration;
}
/**
* Gets the maximum permitted lifetime of a connection in milliseconds. A value of zero or less indicates an
* infinite lifetime.
* @deprecated Use {@link #getMaxConnDuration()}.
*/
@Override
@Deprecated
public long getMaxConnLifetimeMillis() {
return maxConnDuration.toMillis();
}
/**
* Gets the maximum number of connections that can remain idle in the pool. Excess idle connections are destroyed
* on return to the pool.
* <p>
* A negative value indicates that there is no limit
* </p>
*
* @return the maximum number of idle connections
*/
@Override
public synchronized int getMaxIdle() {
return this.maxIdle;
}
/**
* Gets the value of the {@code maxOpenPreparedStatements} property.
*
* @return the maximum number of open statements
*/
@Override
public synchronized int getMaxOpenPreparedStatements() {
return this.maxOpenPreparedStatements;
}
/**
* Gets the maximum number of active connections that can be allocated at the same time.
* <p>
* A negative number means that there is no limit.
* </p>
*
* @return the maximum number of active connections
*/
@Override
public synchronized int getMaxTotal() {
return this.maxTotal;
}
/**
* Gets the maximum Duration 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.
*
* @return the maxWaitDuration property value.
* @since 2.10.0
*/
public synchronized Duration getMaxWaitDuration() {
return this.maxWaitDuration;
}
/**
* Gets 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.
*
* @return the maxWaitMillis property value.
* @deprecated Use {@link #getMaxWaitDuration()}.
*/
@Deprecated
@Override
public synchronized long getMaxWaitMillis() {
return this.maxWaitDuration.toMillis();
}
/**
* Gets the {code minEvictableIdleDuration} property.
*
* @return the value of the {code minEvictableIdleDuration} property
* @see #setMinEvictableIdle(Duration)
* @since 2.10.0
*/
public synchronized Duration getMinEvictableIdleDuration() {
return this.minEvictableIdleDuration;
}
/**
* Gets the {code minEvictableIdleDuration} property.
*
* @return the value of the {code minEvictableIdleDuration} property
* @see #setMinEvictableIdle(Duration)
* @deprecated Use {@link #getMinEvictableIdleDuration()}.
*/
@Deprecated
@Override
public synchronized long getMinEvictableIdleTimeMillis() {
return this.minEvictableIdleDuration.toMillis();
}
/**
* Gets the minimum number of idle connections in the pool. The pool attempts to ensure that minIdle connections
* are available when the idle object evictor runs. The value of this property has no effect unless
* {code durationBetweenEvictionRuns} has a positive value.
*
* @return the minimum number of idle connections
* @see GenericObjectPool#getMinIdle()
*/
@Override
public synchronized int getMinIdle() {
return this.minIdle;
}
/**
* [Read Only] The current number of active connections that have been allocated from this data source.
*
* @return the current number of active connections
*/
@Override
public int getNumActive() {
// Copy reference to avoid NPE if close happens after null check
final GenericObjectPool<PoolableConnection> pool = connectionPool;
return pool == null ? 0 : pool.getNumActive();
}
/**
* [Read Only] The current number of idle connections that are waiting to be allocated from this data source.
*
* @return the current number of idle connections
*/
@Override
public int getNumIdle() {
// Copy reference to avoid NPE if close happens after null check
final GenericObjectPool<PoolableConnection> pool = connectionPool;
return pool == null ? 0 : pool.getNumIdle();
}
/**
* Gets the value of the {code numTestsPerEvictionRun} property.
*
* @return the number of objects to examine during idle object evictor runs
* @see #setNumTestsPerEvictionRun(int)
*/
@Override
public synchronized int getNumTestsPerEvictionRun() {
return this.numTestsPerEvictionRun;
}
@Override
public Logger getParentLogger() throws SQLFeatureNotSupportedException {
throw new SQLFeatureNotSupportedException();
}
/**
* Gets the password passed to the JDBC driver to establish connections.
*
* @return the connection password
* @deprecated Exposing passwords via JMX is an Information Exposure issue.
*/
@Deprecated
@Override
public String getPassword() {
return this.password;
}
/**
* Gets the registered JMX ObjectName.
*
* @return the registered JMX ObjectName.
*/
protected ObjectName getRegisteredJmxName() {
return ObjectNameWrapper.unwrap(registeredJmxObjectName);
}
/**
* Flag to remove abandoned connections if they exceed the removeAbandonedTimeout when borrowObject is invoked.
* <p>
* The default value is false.
* </p>
* <p>
* If set to true a connection is considered abandoned and eligible for removal if it has not been used for more
* than {@link #getRemoveAbandonedTimeoutDuration() removeAbandonedTimeout} seconds.
* </p>
* <p>
* Abandoned connections are identified and removed when {@link #getConnection()} is invoked and all of the
* following conditions hold:
* </p>
* <ul>
* <li>{@link #getRemoveAbandonedOnBorrow()}</li>
* <li>{@link #getNumActive()} > {@link #getMaxTotal()} - 3</li>
* <li>{@link #getNumIdle()} < 2</li>
* </ul>
*
* @see #getRemoveAbandonedTimeoutDuration()
*/
@Override
public boolean getRemoveAbandonedOnBorrow() {
return abandonedConfig != null && abandonedConfig.getRemoveAbandonedOnBorrow();
}
/**
* Flag to remove abandoned connections if they exceed the removeAbandonedTimeout during pool maintenance.
* <p>
* The default value is false.
* </p>
* <p>
* If set to true a connection is considered abandoned and eligible for removal if it has not been used for more
* than {@link #getRemoveAbandonedTimeoutDuration() removeAbandonedTimeout} seconds.
* </p>
*
* @see #getRemoveAbandonedTimeoutDuration()
*/
@Override
public boolean getRemoveAbandonedOnMaintenance() {
return abandonedConfig != null && abandonedConfig.getRemoveAbandonedOnMaintenance();
}
/**
* Gets the timeout in seconds before an abandoned connection can be removed.
* <p>
* 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.
* </p>
* <p>
* Abandoned connection cleanup happens when:
* </p>
* <ul>
* <li>{@link #getRemoveAbandonedOnBorrow()} or {@link #getRemoveAbandonedOnMaintenance()} = true</li>
* <li>{@link #getNumIdle() numIdle} < 2</li>
* <li>{@link #getNumActive() numActive} > {@link #getMaxTotal() maxTotal} - 3</li>
* </ul>
* <p>
* The default value is 300 seconds.
* </p>
* @deprecated Use {@link #getRemoveAbandonedTimeoutDuration()}.
*/
@Deprecated
@Override
public int getRemoveAbandonedTimeout() {
return (int) getRemoveAbandonedTimeoutDuration().getSeconds();
}
/**
* Gets the timeout before an abandoned connection can be removed.
* <p>
* 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.
* </p>
* <p>
* Abandoned connection cleanup happens when:
* </p>
* <ul>
* <li>{@link #getRemoveAbandonedOnBorrow()} or {@link #getRemoveAbandonedOnMaintenance()} = true</li>
* <li>{@link #getNumIdle() numIdle} < 2</li>
* <li>{@link #getNumActive() numActive} > {@link #getMaxTotal() maxTotal} - 3</li>
* </ul>
* <p>
* The default value is 300 seconds.
* </p>
* @return Timeout before an abandoned connection can be removed.
* @since 2.10.0
*/
public Duration getRemoveAbandonedTimeoutDuration() {
return abandonedConfig == null ? Duration.ofSeconds(300) : abandonedConfig.getRemoveAbandonedTimeoutDuration();
}
/**
* Gets the current value of the flag that controls whether 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.
*
* @return whether a connection will be rolled back when it is returned to the pool.
*/
public boolean getRollbackOnReturn() {
return rollbackOnReturn;
}
/**
* Gets 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.
* <p>
* When {@link #getMinEvictableIdleTimeMillis() 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 {@code minEvictableIdleTimeMillis} (without
* considering the number of idle connections in the pool) and then against {@code softMinEvictableIdleTimeMillis},
* including the {@code minIdle}, constraint.
* </p>
*
* @return 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
* @since 2.10.0
*/
public synchronized Duration getSoftMinEvictableIdleDuration() {
return softMinEvictableIdleDuration;
}
/**
* Gets 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.
* <p>
* When {@link #getMinEvictableIdleTimeMillis() 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 {@code minEvictableIdleTimeMillis} (without
* considering the number of idle connections in the pool) and then against {@code softMinEvictableIdleTimeMillis},
* including the {@code minIdle}, constraint.
* </p>
*
* @return 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
* @deprecated Use {@link #getSoftMinEvictableIdleDuration()}.
*/
@Deprecated
@Override
public synchronized long getSoftMinEvictableIdleTimeMillis() {
return softMinEvictableIdleDuration.toMillis();
}
/**
* Gets the {code testOnBorrow} property.
*
* @return true if objects are validated before being borrowed from the pool
* @see #setTestOnBorrow(boolean)
*/
@Override
public synchronized boolean getTestOnBorrow() {
return this.testOnBorrow;
}
/**
* Gets the {code testOnCreate} property.
*
* @return true if objects are validated immediately after they are created by the pool
* @see #setTestOnCreate(boolean)
*/
@Override
public synchronized boolean getTestOnCreate() {
return this.testOnCreate;
}
/**
* Gets the value of the {code testOnReturn} property.
*
* @return true if objects are validated before being returned to the pool
* @see #setTestOnReturn(boolean)
*/
public synchronized boolean getTestOnReturn() {
return this.testOnReturn;
}
/**
* Gets the value of the {code testWhileIdle} property.
*
* @return true if objects examined by the idle object evictor are validated
* @see #setTestWhileIdle(boolean)
*/
@Override
public synchronized boolean getTestWhileIdle() {
return this.testWhileIdle;
}
/**
* Gets the value of the {code durationBetweenEvictionRuns} property.
*
* @return the time (in milliseconds) between evictor runs
* @see #setDurationBetweenEvictionRuns(Duration)
* @deprecated Use {@link #getDurationBetweenEvictionRuns()}.
*/
@Deprecated
@Override
public synchronized long getTimeBetweenEvictionRunsMillis() {
return this.durationBetweenEvictionRuns.toMillis();
}
/**
* Gets the JDBC connection {code connectionString} property.
*
* @return the {code connectionString} passed to the JDBC driver to establish connections
*/
@Override
public synchronized String getUrl() {
return this.connectionString;
}
/**
* Gets the JDBC connection {code userName} property.
*
* @return the {code userName} passed to the JDBC driver to establish connections
* @deprecated Use {@link #getUserName()}.
*/
@Deprecated
@Override
public String getUsername() {
return this.userName;
}
/**
* Gets the validation query used to validate connections before returning them.
*
* @return the SQL validation query
* @see #setValidationQuery(String)
*/
@Override
public String getValidationQuery() {
return this.validationQuery;
}
/**
* Gets the validation query timeout.
*
* @return the timeout in seconds before connection validation queries fail.
* @deprecated Use {@link #getValidationQueryTimeoutDuration()}.
*/
@Deprecated
@Override
public int getValidationQueryTimeout() {
return (int) validationQueryTimeoutDuration.getSeconds();
}
/**
* Gets the validation query timeout.
*
* @return the timeout in seconds before connection validation queries fail.
*/
public Duration getValidationQueryTimeoutDuration() {
return validationQueryTimeoutDuration;
}
/**
* Manually invalidates a connection, effectively requesting the pool to try to close it, remove it from the pool
* and reclaim pool capacity.
*
* @param connection The Connection to invalidate.
* @throws IllegalStateException if invalidating the connection failed.
* @since 2.1
*/
public void invalidateConnection(final Connection connection) throws IllegalStateException {
if (connection == null) {
return;
}
if (connectionPool == null) {
throw new IllegalStateException("Cannot invalidate connection: ConnectionPool is null.");
}
final PoolableConnection poolableConnection;
try {
poolableConnection = connection.unwrap(PoolableConnection.class);
if (poolableConnection == null) {
throw new IllegalStateException(
"Cannot invalidate connection: Connection is not a poolable connection.");
}
} catch (final SQLException e) {
throw new IllegalStateException("Cannot invalidate connection: Unwrapping poolable connection failed.", e);
}
try {
connectionPool.invalidateObject(poolableConnection);
} catch (final Exception e) {
throw new IllegalStateException("Invalidating connection threw unexpected exception", e);
}
}
/**
* Gets the value of the accessToUnderlyingConnectionAllowed property.
*
* @return true if access to the underlying connection is allowed, false otherwise.
*/
@Override
public synchronized boolean isAccessToUnderlyingConnectionAllowed() {
return this.accessToUnderlyingConnectionAllowed;
}
/**
* Returns true if the statement pool is cleared when the connection is returned to its pool.
*
* @return true if the statement pool is cleared at connection return
* @since 2.8.0
*/
@Override
public boolean isClearStatementPoolOnReturn() {
return clearStatementPoolOnReturn;
}
/**
* If true, this data source is closed and no more connections can be retrieved from this data source.
*
* @return true, if the data source is closed; false otherwise
*/
@Override
public synchronized boolean isClosed() {
return closed;
}
/**
* Delegates in a null-safe manner to {@link String#isEmpty()}.
*
* @param value the string to test, may be null.
* @return boolean false if value is null, otherwise {@link String#isEmpty()}.
*/
private boolean isEmpty(final String value) {
return value == null || value.trim().isEmpty();
}
/**
* Returns true if we are pooling statements.
*
* @return true if prepared and callable statements are pooled
*/
@Override
public synchronized boolean isPoolPreparedStatements() {
return this.poolPreparedStatements;
}
@Override
public boolean isWrapperFor(final Class<?> iface) throws SQLException {
return iface != null && iface.isInstance(this);
}
private void jmxRegister() {
// Return immediately if this DataSource has already been registered
if (registeredJmxObjectName != null) {
return;
}
// Return immediately if no JMX name has been specified
final String requestedName = getJmxName();
if (requestedName == null) {
return;
}
registeredJmxObjectName = registerJmxObjectName(requestedName, null);
try {
final StandardMBean standardMBean = new StandardMBean(this, DataSourceMXBean.class);
registeredJmxObjectName.registerMBean(standardMBean);
} catch (final NotCompliantMBeanException e) {
log.warn("The requested JMX name [" + requestedName + "] was not valid and will be ignored.");
}
}
/**
* Logs the given message.
*
* @param message the message to log.
*/
protected void log(final String message) {
if (logWriter != null) {
logWriter.println(message);
}
}
/**
* Logs the given message and throwable.
*
* @param message value to be log.
* @param throwable the throwable.
* @since 2.7.0
*/
protected void log(final String message, final Throwable throwable) {
if (logWriter != null) {
logWriter.println(message);
throwable.printStackTrace(logWriter);
}
}
@Override
public void postDeregister() {
// NO-OP
}
@Override
public void postRegister(final Boolean registrationDone) {
// NO-OP
}
@Override
public void preDeregister() throws Exception {
// NO-OP
}
@Override
public ObjectName preRegister(final MBeanServer server, final ObjectName objectName) {
registeredJmxObjectName = registerJmxObjectName(getJmxName(), objectName);
return ObjectNameWrapper.unwrap(registeredJmxObjectName);
}
private ObjectNameWrapper registerJmxObjectName(final String requestedName, final ObjectName objectName) {
ObjectNameWrapper objectNameWrapper = null;
if (requestedName != null) {
try {
objectNameWrapper = ObjectNameWrapper.wrap(requestedName);
} catch (final MalformedObjectNameException e) {
log.warn("The requested JMX name '" + requestedName + "' was not valid and will be ignored.");
}
}
if (objectNameWrapper == null) {
objectNameWrapper = ObjectNameWrapper.wrap(objectName);
}
return objectNameWrapper;
}
/**
* Removes a custom connection property.
*
* @param name Name of the custom connection property to remove
* @see #addConnectionProperty(String, String)
*/
public void removeConnectionProperty(final String name) {
connectionProperties.remove(name);
}
/**
* Restarts the datasource.
* <p>
* This method calls {@link #close()} and {@link #start()} in sequence within synchronized scope so any
* connection requests that come in while the datasource is shutting down will be served by the new pool.
* <p>
* Idle connections that are stored in the connection pool when this method is invoked are closed, but
* connections that are checked out to clients when this method is invoked are not affected. When client
* applications subsequently invoke {@link Connection#close()} to return these connections to the pool, the
* underlying JDBC connections are closed. These connections do not count in {@link #getMaxTotal()} or
* {@link #getNumActive()} after invoking this method. For example, if there are 3 connections checked out by
* clients when {@link #restart()} is invoked, after this method is called, {@link #getNumActive()} will
* return 0 and up to {@link #getMaxTotal()} + 3 connections may be open until the connections sourced from
* the original pool are returned.
* <p>
* The new connection pool created by this method is initialized with currently set configuration properties.
*
* @throws SQLException if an error occurs initializing the datasource
*/
@Override
public synchronized void restart() throws SQLException {
close();
start();
}
private <T> void setAbandoned(final BiConsumer<AbandonedConfig, T> consumer, final T object) {
if (abandonedConfig == null) {
abandonedConfig = new AbandonedConfig();
}
consumer.accept(abandonedConfig, object);
final GenericObjectPool<?> gop = this.connectionPool;
if (gop != null) {
gop.setAbandonedConfig(abandonedConfig);
}
}
/**
* Sets the print writer to be used by this configuration to log information on abandoned objects.
*
* @param logWriter The new log writer
*/
public void setAbandonedLogWriter(final PrintWriter logWriter) {
setAbandoned(AbandonedConfig::setLogWriter, logWriter);
}
/**
* If the connection pool implements {@link org.apache.tomcat.dbcp.pool2.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.
*
* @param usageTracking A value of {@code true} will enable the recording of a stack trace on every use of a
* pooled connection
*/
public void setAbandonedUsageTracking(final boolean usageTracking) {
setAbandoned(AbandonedConfig::setUseUsageTracking, Boolean.valueOf(usageTracking));
}
/**
* Sets the value of the accessToUnderlyingConnectionAllowed property. It controls if the PoolGuard allows access to
* the underlying connection. (Default: false)
* <p>
* 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: {@link #getConnection()}, {@link #setLogWriter(PrintWriter)},
* {@link #setLoginTimeout(int)}, {@link #getLoginTimeout()}, {@link #getLogWriter()}.
* </p>
*
* @param allow Access to the underlying connection is granted when true.
*/
public synchronized void setAccessToUnderlyingConnectionAllowed(final boolean allow) {
this.accessToUnderlyingConnectionAllowed = allow;
}
/**
* Sets the value of the flag that controls whether or not connections being returned to the pool will be checked
* and configured with {@link Connection#setAutoCommit(boolean) Connection.setAutoCommit(true)} if the auto commit
* setting is {@code false} when the connection is returned. It is {@code true} by default.
*
* @param autoCommitOnReturn Whether or not connections being returned to the pool will be checked and configured
* with auto-commit.
* @since 2.6.0
*/
public void setAutoCommitOnReturn(final boolean autoCommitOnReturn) {
this.autoCommitOnReturn = autoCommitOnReturn;
}
/**
* Sets the state caching flag.
*
* @param cacheState The new value for the state caching flag
*/
public void setCacheState(final boolean cacheState) {
this.cacheState = cacheState;
}
/**
* Sets whether the pool of statements (which was enabled with {@link #setPoolPreparedStatements(boolean)}) should
* be cleared when the connection is returned to its pool. Default is false.
*
* @param clearStatementPoolOnReturn clear or not
* @since 2.8.0
*/
public void setClearStatementPoolOnReturn(final boolean clearStatementPoolOnReturn) {
this.clearStatementPoolOnReturn = clearStatementPoolOnReturn;
}
/**
* Sets the ConnectionFactory class name.
*
* @param connectionFactoryClassName A class name.
* @since 2.7.0
*/
public void setConnectionFactoryClassName(final String connectionFactoryClassName) {
this.connectionFactoryClassName = isEmpty(connectionFactoryClassName) ? null : connectionFactoryClassName;
}
/**
* Sets the collection of SQL statements to be executed when a physical connection is first created.
* <p>
* 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: {@link #getConnection()}, {@link #setLogWriter(PrintWriter)},
* {@link #setLoginTimeout(int)}, {@link #getLoginTimeout()}, {@link #getLogWriter()}.
* </p>
*
* @param connectionInitSqls Collection of SQL statements to execute on connection creation
*/
public void setConnectionInitSqls(final Collection<String> connectionInitSqls) {
final List<String> collect = Utils.isEmpty(connectionInitSqls) ? null
: connectionInitSqls.stream().filter(s -> !isEmpty(s)).collect(Collectors.toList());
this.connectionInitSqls = Utils.isEmpty(collect) ? null : collect;
}
/**
* Sets the list of SQL statements to be executed when a physical connection is first created.
* <p>
* 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: {@link #getConnection()}, {@link #setLogWriter(PrintWriter)},
* {@link #setLoginTimeout(int)}, {@link #getLoginTimeout()}, {@link #getLogWriter()}.
* </p>
*
* @param connectionInitSqls List of SQL statements to execute on connection creation
* @since 2.12.0
*/
public void setConnectionInitSqls(final List<String> connectionInitSqls) {
setConnectionInitSqls((Collection<String>) connectionInitSqls);
}
private <T> void setConnectionPool(final BiConsumer<GenericObjectPool<PoolableConnection>, T> consumer, final T object) {
if (connectionPool != null) {
consumer.accept(connectionPool, object);
}
}
/**
* Sets the connection properties passed to driver.connect(...).
* <p>
* Format of the string must be [propertyName=property;]*
* </p>
* <p>
* NOTE - The "user" and "password" properties will be added explicitly, so they do not need to be included here.
* </p>
*
* @param connectionProperties the connection properties used to create new connections
*/
public void setConnectionProperties(final String connectionProperties) {
Objects.requireNonNull(connectionProperties, "connectionProperties");
final String[] entries = connectionProperties.split(";");
final Properties properties = new Properties();
Stream.of(entries).filter(e -> !e.isEmpty()).forEach(entry -> {
final int index = entry.indexOf('=');
if (index > 0) {
final String name = entry.substring(0, index);
final String value = entry.substring(index + 1);
properties.setProperty(name, value);
} else {
// no value is empty string which is how
// java.util.Properties works
properties.setProperty(entry, "");
}
});
this.connectionProperties = properties;
}
/**
* Sets default auto-commit state of connections returned by this datasource.
* <p>
* 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: {@link #getConnection()}, {@link #setLogWriter(PrintWriter)},
* {@link #setLoginTimeout(int)}, {@link #getLoginTimeout()}, {@link #getLogWriter()}.
* </p>
*
* @param defaultAutoCommit default auto-commit value
*/
public void setDefaultAutoCommit(final Boolean defaultAutoCommit) {
this.defaultAutoCommit = defaultAutoCommit;
}
/**
* Sets the default catalog.
* <p>
* 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: {@link #getConnection()}, {@link #setLogWriter(PrintWriter)},
* {@link #setLoginTimeout(int)}, {@link #getLoginTimeout()}, {@link #getLogWriter()}.
* </p>
*
* @param defaultCatalog the default catalog
*/
public void setDefaultCatalog(final String defaultCatalog) {
this.defaultCatalog = isEmpty(defaultCatalog) ? null : defaultCatalog;
}
/**
* Sets the default query timeout that will be used for {@link java.sql.Statement Statement}s created from this
* connection. {@code null} means that the driver default will be used.
*
* @param defaultQueryTimeoutDuration The default query timeout Duration.
* @since 2.10.0
*/
public void setDefaultQueryTimeout(final Duration defaultQueryTimeoutDuration) {
this.defaultQueryTimeoutDuration = defaultQueryTimeoutDuration;
}
/**
* Sets the default query timeout that will be used for {@link java.sql.Statement Statement}s created from this
* connection. {@code null} means that the driver default will be used.
*
* @param defaultQueryTimeoutSeconds The default query timeout in seconds.
* @deprecated Use {@link #setDefaultQueryTimeout(Duration)}.
*/
@Deprecated
public void setDefaultQueryTimeout(final Integer defaultQueryTimeoutSeconds) {
this.defaultQueryTimeoutDuration = defaultQueryTimeoutSeconds == null ? null : Duration.ofSeconds(defaultQueryTimeoutSeconds.longValue());
}
/**
* Sets defaultReadonly property.
* <p>
* 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: {@link #getConnection()}, {@link #setLogWriter(PrintWriter)},
* {@link #setLoginTimeout(int)}, {@link #getLoginTimeout()}, {@link #getLogWriter()}.
* </p>
*
* @param defaultReadOnly default read-only value
*/
public void setDefaultReadOnly(final Boolean defaultReadOnly) {
this.defaultReadOnly = defaultReadOnly;
}
/**
* Sets the default schema.
* <p>
* 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: {@link #getConnection()}, {@link #setLogWriter(PrintWriter)},
* {@link #setLoginTimeout(int)}, {@link #getLoginTimeout()}, {@link #getLogWriter()}.
* </p>
*
* @param defaultSchema the default catalog
* @since 2.5.0
*/
public void setDefaultSchema(final String defaultSchema) {
this.defaultSchema = isEmpty(defaultSchema) ? null : defaultSchema;
}
/**
* Sets the default transaction isolation state for returned connections.
* <p>
* 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: {@link #getConnection()}, {@link #setLogWriter(PrintWriter)},
* {@link #setLoginTimeout(int)}, {@link #getLoginTimeout()}, {@link #getLogWriter()}.
* </p>
*
* @param defaultTransactionIsolation the default transaction isolation state
* @see Connection#getTransactionIsolation
*/
public void setDefaultTransactionIsolation(final int defaultTransactionIsolation) {
this.defaultTransactionIsolation = defaultTransactionIsolation;
}
/**
* Sets the SQL State codes that should be ignored when determining fatal disconnection conditions.
* <p>
* This method allows you to specify a collection of SQL State codes that will be excluded from
* disconnection checks. These codes will not trigger the "fatally disconnected" status even if they
* match the typical disconnection criteria. This can be useful in scenarios where certain SQL State
* codes (e.g., specific codes starting with "08") are known to be non-fatal in your environment.
* </p>
* <p>
* The effect of this method is similar to the one described in {@link #setDisconnectionSqlCodes(Collection)},
* but instead of setting codes that signal fatal disconnections, it defines codes that should be ignored
* during such checks.
* </p>
* <p>
* 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: {@code getConnection, setLogwriter, setLoginTimeout,
* getLoginTimeout, getLogWriter}.
* </p>
*
* @param disconnectionIgnoreSqlCodes SQL State codes that should be ignored in disconnection checks
* @throws IllegalArgumentException if any SQL state codes overlap with those in {@link #disconnectionSqlCodes}.
* @since 2.13.0
*/
public void setDisconnectionIgnoreSqlCodes(final Collection<String> disconnectionIgnoreSqlCodes) {
Utils.checkSqlCodes(disconnectionIgnoreSqlCodes, this.disconnectionSqlCodes);
final Set<String> collect = Utils.isEmpty(disconnectionIgnoreSqlCodes) ? null
: disconnectionIgnoreSqlCodes.stream().filter(s -> !isEmpty(s)).collect(toLinkedHashSet());
this.disconnectionIgnoreSqlCodes = Utils.isEmpty(collect) ? null : collect;
}
/**
* Sets the SQL State codes considered to signal fatal conditions.
* <p>
* Overrides the defaults in {@link Utils#getDisconnectionSqlCodes()} (plus anything starting with
* {@link Utils#DISCONNECTION_SQL_CODE_PREFIX}). If this property is non-null and {@link #getFastFailValidation()}
* is {@code 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).
* </p>
* <p>
* If {@link #getFastFailValidation()} is {@code false} setting this property has no effect.
* </p>
* <p>
* 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: {@code getConnection, setLogwriter,
* setLoginTimeout, getLoginTimeout, getLogWriter}.
* </p>
*
* @param disconnectionSqlCodes SQL State codes considered to signal fatal conditions
* @throws IllegalArgumentException if any SQL state codes overlap with those in {@link #disconnectionIgnoreSqlCodes}.
* @since 2.1
*/
public void setDisconnectionSqlCodes(final Collection<String> disconnectionSqlCodes) {
Utils.checkSqlCodes(disconnectionSqlCodes, this.disconnectionIgnoreSqlCodes);
final Set<String> collect = Utils.isEmpty(disconnectionSqlCodes) ? null
: disconnectionSqlCodes.stream().filter(s -> !isEmpty(s)).collect(toLinkedHashSet());
this.disconnectionSqlCodes = Utils.isEmpty(collect) ? null : collect;
}
/**
* Sets the JDBC Driver instance to use for this pool.
* <p>
* 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: {@link #getConnection()}, {@link #setLogWriter(PrintWriter)},
* {@link #setLoginTimeout(int)}, {@link #getLoginTimeout()}, {@link #getLogWriter()}.
* </p>
*
* @param driver The JDBC Driver instance to use for this pool.
*/
public synchronized void setDriver(final Driver driver) {
this.driver = driver;
}
/**
* Sets the class loader to be used to load the JDBC driver.
* <p>
* 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: {@link #getConnection()}, {@link #setLogWriter(PrintWriter)},
* {@link #setLoginTimeout(int)}, {@link #getLoginTimeout()}, {@link #getLogWriter()}.
* </p>
*
* @param driverClassLoader the class loader with which to load the JDBC driver
*/
public synchronized void setDriverClassLoader(final ClassLoader driverClassLoader) {
this.driverClassLoader = driverClassLoader;
}
/**
* Sets the JDBC driver class name.
* <p>
* 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: {@link #getConnection()}, {@link #setLogWriter(PrintWriter)},
* {@link #setLoginTimeout(int)}, {@link #getLoginTimeout()}, {@link #getLogWriter()}.
* </p>
*
* @param driverClassName the class name of the JDBC driver
*/
public synchronized void setDriverClassName(final String driverClassName) {
this.driverClassName = isEmpty(driverClassName) ? null : driverClassName;
}
/**
* Sets the {code durationBetweenEvictionRuns} property.
*
* @param timeBetweenEvictionRunsMillis the new time between evictor runs
* @see #setDurationBetweenEvictionRuns(Duration)
* @since 2.10.0
*/
public synchronized void setDurationBetweenEvictionRuns(final Duration timeBetweenEvictionRunsMillis) {
this.durationBetweenEvictionRuns = timeBetweenEvictionRunsMillis;
setConnectionPool(GenericObjectPool::setDurationBetweenEvictionRuns, timeBetweenEvictionRunsMillis);
}
/**
* Sets the value of the flag that controls whether or not connections being returned to the pool will be checked
* and configured with {@link Connection#setAutoCommit(boolean) Connection.setAutoCommit(true)} if the auto commit
* setting is {@code false} when the connection is returned. It is {@code true} by default.
*
* @param autoCommitOnReturn Whether or not connections being returned to the pool will be checked and configured
* with auto-commit.
* @deprecated Use {@link #setAutoCommitOnReturn(boolean)}.
*/
@Deprecated
public void setEnableAutoCommitOnReturn(final boolean autoCommitOnReturn) {
this.autoCommitOnReturn = autoCommitOnReturn;
}
/**
* Sets the EvictionPolicy implementation to use with this connection pool.
*
* @param evictionPolicyClassName The fully qualified class name of the EvictionPolicy implementation
*/
public synchronized void setEvictionPolicyClassName(final String evictionPolicyClassName) {
setConnectionPool(GenericObjectPool::setEvictionPolicyClassName, evictionPolicyClassName);
this.evictionPolicyClassName = evictionPolicyClassName;
}
/**
* Sets whether connections created by this factory will fast fail validation.
*
* @param fastFailValidation true means connections created by this factory will fast fail validation.
* @see #getFastFailValidation()
* @since 2.1
*/
public void setFastFailValidation(final boolean fastFailValidation) {
this.fastFailValidation = fastFailValidation;
}
/**
* Sets the initial size of the connection pool.
* <p>
* 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: {@link #getConnection()}, {@link #setLogWriter(PrintWriter)},
* {@link #setLoginTimeout(int)}, {@link #getLoginTimeout()}, {@link #getLogWriter()}.
* </p>
*
* @param initialSize the number of connections created when the pool is initialized
*/
public synchronized void setInitialSize(final int initialSize) {
this.initialSize = initialSize;
}
/**
* Sets the JMX name that has been requested for this DataSource. If the requested name is not valid, an alternative
* may be chosen. This DataSource will attempt to register itself using this name. If another component registers
* this DataSource with JMX and this name is valid this name will be used in preference to any specified by the
* other component.
*
* @param jmxName The JMX name that has been requested for this DataSource
*/
public void setJmxName(final String jmxName) {
this.jmxName = jmxName;
}
/**
* Sets the LIFO property. True means the pool behaves as a LIFO queue; false means FIFO.
*
* @param lifo the new value for the LIFO property
*/
public synchronized void setLifo(final boolean lifo) {
this.lifo = lifo;
setConnectionPool(GenericObjectPool::setLifo, Boolean.valueOf(lifo));
}
/**
* Sets whether to log abandoned resources.
*
* @param logAbandoned new logAbandoned property value
*/
public void setLogAbandoned(final boolean logAbandoned) {
setAbandoned(AbandonedConfig::setLogAbandoned, Boolean.valueOf(logAbandoned));
}
/**
* When {@link #getMaxConnDuration()} 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.
*
* @param logExpiredConnections Whether or not log messages are generated when the pool closes connections due to
* maximum lifetime exceeded.
*/
public void setLogExpiredConnections(final boolean logExpiredConnections) {
this.logExpiredConnections = logExpiredConnections;
}
/**
* <strong>BasicDataSource does NOT support this method. </strong>
*
* <p>
* Sets the login timeout (in seconds) for connecting to the database.
* </p>
* <p>
* Calls {@link #createDataSource()}, so has the side effect of initializing the connection pool.
* </p>
*
* @param loginTimeout The new login timeout, or zero for no timeout
* @throws UnsupportedOperationException If the DataSource implementation does not support the login timeout
* feature.
* @throws SQLException if a database access error occurs
*/
@Override
public void setLoginTimeout(final int loginTimeout) throws SQLException {
// This method isn't supported by the PoolingDataSource returned by the
// createDataSource
throw new UnsupportedOperationException("Not supported by BasicDataSource");
}
/**
* Sets the log writer being used by this data source.
* <p>
* Calls {@link #createDataSource()}, so has the side effect of initializing the connection pool.
* </p>
*
* @param logWriter The new log writer
* @throws SQLException if a database access error occurs
*/
@Override
public void setLogWriter(final PrintWriter logWriter) throws SQLException {
createDataSource().setLogWriter(logWriter);
this.logWriter = logWriter;
}
/**
* Sets the maximum permitted lifetime of a connection. A value of zero or less indicates an
* infinite lifetime.
* <p>
* 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: {@link #getConnection()}, {@link #setLogWriter(PrintWriter)},
* {@link #setLoginTimeout(int)}, {@link #getLoginTimeout()}, {@link #getLogWriter()}.
* </p>
*
* @param maxConnDuration The maximum permitted lifetime of a connection.
* @since 2.10.0
*/
public void setMaxConn(final Duration maxConnDuration) {
this.maxConnDuration = maxConnDuration;
}
/**
* Sets the maximum permitted lifetime of a connection in milliseconds. A value of zero or less indicates an
* infinite lifetime.
* <p>
* 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: {@link #getConnection()}, {@link #setLogWriter(PrintWriter)},
* {@link #setLoginTimeout(int)}, {@link #getLoginTimeout()}, {@link #getLogWriter()}.
* </p>
*
* @param maxConnLifetimeMillis The maximum permitted lifetime of a connection in milliseconds.
* @deprecated Use {@link #setMaxConn(Duration)}.
*/
@Deprecated
public void setMaxConnLifetimeMillis(final long maxConnLifetimeMillis) {
this.maxConnDuration = Duration.ofMillis(maxConnLifetimeMillis);
}
/**
* Sets the maximum number of connections that can remain idle in the pool. Excess idle connections are destroyed on
* return to the pool.
*
* @see #getMaxIdle()
* @param maxIdle the new value for maxIdle
*/
public synchronized void setMaxIdle(final int maxIdle) {
this.maxIdle = maxIdle;
setConnectionPool(GenericObjectPool::setMaxIdle, Integer.valueOf(maxIdle));
}
/**
* Sets the value of the {@code maxOpenPreparedStatements} property.
* <p>
* 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: {@link #getConnection()}, {@link #setLogWriter(PrintWriter)},
* {@link #setLoginTimeout(int)}, {@link #getLoginTimeout()}, {@link #getLogWriter()}.
* </p>
*
* @param maxOpenStatements the new maximum number of prepared statements
*/
public synchronized void setMaxOpenPreparedStatements(final int maxOpenStatements) {
this.maxOpenPreparedStatements = maxOpenStatements;
}
/**
* Sets the maximum total number of idle and borrows connections that can be active at the same time. Use a negative
* value for no limit.
*
* @param maxTotal the new value for maxTotal
* @see #getMaxTotal()
*/
public synchronized void setMaxTotal(final int maxTotal) {
this.maxTotal = maxTotal;
setConnectionPool(GenericObjectPool::setMaxTotal, Integer.valueOf(maxTotal));
}
/**
* Sets the MaxWaitMillis property. Use -1 to make the pool wait indefinitely.
*
* @param maxWaitDuration the new value for MaxWaitMillis
* @see #getMaxWaitDuration()
* @since 2.10.0
*/
public synchronized void setMaxWait(final Duration maxWaitDuration) {
this.maxWaitDuration = maxWaitDuration;
setConnectionPool(GenericObjectPool::setMaxWait, maxWaitDuration);
}
/**
* Sets the MaxWaitMillis property. Use -1 to make the pool wait indefinitely.
*
* @param maxWaitMillis the new value for MaxWaitMillis
* @see #getMaxWaitDuration()
* @deprecated {@link #setMaxWait(Duration)}.
*/
@Deprecated
public synchronized void setMaxWaitMillis(final long maxWaitMillis) {
setMaxWait(Duration.ofMillis(maxWaitMillis));
}
/**
* Sets the {code minEvictableIdleDuration} property.
*
* @param minEvictableIdleDuration the minimum amount of time an object may sit idle in the pool
* @see #setMinEvictableIdle(Duration)
* @since 2.10.0
*/
public synchronized void setMinEvictableIdle(final Duration minEvictableIdleDuration) {
this.minEvictableIdleDuration = minEvictableIdleDuration;
setConnectionPool(GenericObjectPool::setMinEvictableIdleDuration, minEvictableIdleDuration);
}
/**
* Sets the {code minEvictableIdleDuration} property.
*
* @param minEvictableIdleTimeMillis the minimum amount of time an object may sit idle in the pool
* @see #setMinEvictableIdle(Duration)
* @deprecated Use {@link #setMinEvictableIdle(Duration)}.
*/
@Deprecated
public synchronized void setMinEvictableIdleTimeMillis(final long minEvictableIdleTimeMillis) {
setMinEvictableIdle(Duration.ofMillis(minEvictableIdleTimeMillis));
}
/**
* Sets the minimum number of idle connections in the pool. The pool attempts to ensure that minIdle connections are
* available when the idle object evictor runs. The value of this property has no effect unless
* {code durationBetweenEvictionRuns} has a positive value.
*
* @param minIdle the new value for minIdle
* @see GenericObjectPool#setMinIdle(int)
*/
public synchronized void setMinIdle(final int minIdle) {
this.minIdle = minIdle;
setConnectionPool(GenericObjectPool::setMinIdle, Integer.valueOf(minIdle));
}
/**
* Sets the value of the {code numTestsPerEvictionRun} property.
*
* @param numTestsPerEvictionRun the new {code numTestsPerEvictionRun} value
* @see #setNumTestsPerEvictionRun(int)
*/
public synchronized void setNumTestsPerEvictionRun(final int numTestsPerEvictionRun) {
this.numTestsPerEvictionRun = numTestsPerEvictionRun;
setConnectionPool(GenericObjectPool::setNumTestsPerEvictionRun, Integer.valueOf(numTestsPerEvictionRun));
}
/**
* Sets the {code password}.
* <p>
* 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: {@link #getConnection()}, {@link #setLogWriter(PrintWriter)},
* {@link #setLoginTimeout(int)}, {@link #getLoginTimeout()}, {@link #getLogWriter()}.
* </p>
*
* @param password new value for the password
*/
public void setPassword(final String password) {
this.password = password;
}
/**
* Sets whether to pool statements or not.
* <p>
* 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: {@link #getConnection()}, {@link #setLogWriter(PrintWriter)},
* {@link #setLoginTimeout(int)}, {@link #getLoginTimeout()}, {@link #getLogWriter()}.
* </p>
*
* @param poolingStatements pooling on or off
*/
public synchronized void setPoolPreparedStatements(final boolean poolingStatements) {
this.poolPreparedStatements = poolingStatements;
}
/**
* Sets if connection level JMX tracking is requested for this DataSource. If true, each connection will be
* registered for tracking with JMX.
*
* @param registerConnectionMBean connection tracking requested for this DataSource.
*/
public void setRegisterConnectionMBean(final boolean registerConnectionMBean) {
this.registerConnectionMBean = registerConnectionMBean;
}
/**
* Sets abandoned connections may be removed when connections are borrowed from the pool.
*
* @param removeAbandonedOnBorrow true means abandoned connections may be removed when connections are borrowed from the pool.
* @see #getRemoveAbandonedOnBorrow()
*/
public void setRemoveAbandonedOnBorrow(final boolean removeAbandonedOnBorrow) {
setAbandoned(AbandonedConfig::setRemoveAbandonedOnBorrow, Boolean.valueOf(removeAbandonedOnBorrow));
}
/**
* Sets whether abandoned connections may be removed on pool maintenance.
*
* @param removeAbandonedOnMaintenance true means abandoned connections may be removed on pool maintenance.
* @see #getRemoveAbandonedOnMaintenance()
*/
public void setRemoveAbandonedOnMaintenance(final boolean removeAbandonedOnMaintenance) {
setAbandoned(AbandonedConfig::setRemoveAbandonedOnMaintenance, Boolean.valueOf(removeAbandonedOnMaintenance));
}
/**
* Sets the timeout before an abandoned connection can be removed.
* <p>
* Setting this property has no effect if {@link #getRemoveAbandonedOnBorrow()} and
* {code getRemoveAbandonedOnMaintenance()} are false.
* </p>
*
* @param removeAbandonedTimeout new abandoned timeout
* @see #getRemoveAbandonedTimeoutDuration()
* @see #getRemoveAbandonedOnBorrow()
* @see #getRemoveAbandonedOnMaintenance()
* @since 2.10.0
*/
public void setRemoveAbandonedTimeout(final Duration removeAbandonedTimeout) {
setAbandoned(AbandonedConfig::setRemoveAbandonedTimeout, removeAbandonedTimeout);
}
/**
* Sets the timeout in seconds before an abandoned connection can be removed.
* <p>
* Setting this property has no effect if {@link #getRemoveAbandonedOnBorrow()} and
* {@link #getRemoveAbandonedOnMaintenance()} are false.
* </p>
*
* @param removeAbandonedTimeout new abandoned timeout in seconds
* @see #getRemoveAbandonedTimeoutDuration()
* @see #getRemoveAbandonedOnBorrow()
* @see #getRemoveAbandonedOnMaintenance()
* @deprecated Use {@link #setRemoveAbandonedTimeout(Duration)}.
*/
@Deprecated
public void setRemoveAbandonedTimeout(final int removeAbandonedTimeout) {
setAbandoned(AbandonedConfig::setRemoveAbandonedTimeout, Duration.ofSeconds(removeAbandonedTimeout));
}
/**
* 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.
*
* @param rollbackOnReturn whether a connection will be rolled back when it is returned to the pool.
*/
public void setRollbackOnReturn(final boolean rollbackOnReturn) {
this.rollbackOnReturn = rollbackOnReturn;
}
/**
* 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.
*
* @param 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.
* @see #getSoftMinEvictableIdleTimeMillis
* @since 2.10.0
*/
public synchronized void setSoftMinEvictableIdle(final Duration softMinEvictableIdleTimeMillis) {
this.softMinEvictableIdleDuration = softMinEvictableIdleTimeMillis;
setConnectionPool(GenericObjectPool::setSoftMinEvictableIdleDuration, 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.
*
* @param 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.
* @see #getSoftMinEvictableIdleTimeMillis
* @deprecated Use {@link #setSoftMinEvictableIdle(Duration)}.
*/
@Deprecated
public synchronized void setSoftMinEvictableIdleTimeMillis(final long softMinEvictableIdleTimeMillis) {
setSoftMinEvictableIdle(Duration.ofMillis(softMinEvictableIdleTimeMillis));
}
/**
* Sets the {code testOnBorrow} property. This property determines whether or not the pool will validate objects
* before they are borrowed from the pool.
*
* @param testOnBorrow new value for testOnBorrow property
*/
public synchronized void setTestOnBorrow(final boolean testOnBorrow) {
this.testOnBorrow = testOnBorrow;
setConnectionPool(GenericObjectPool::setTestOnBorrow, Boolean.valueOf(testOnBorrow));
}
/**
* Sets the {code testOnCreate} property. This property determines whether or not the pool will validate objects
* immediately after they are created by the pool
*
* @param testOnCreate new value for testOnCreate property
*/
public synchronized void setTestOnCreate(final boolean testOnCreate) {
this.testOnCreate = testOnCreate;
setConnectionPool(GenericObjectPool::setTestOnCreate, Boolean.valueOf(testOnCreate));
}
/**
* Sets the {@code testOnReturn} property. This property determines whether or not the pool will validate
* objects before they are returned to the pool.
*
* @param testOnReturn new value for testOnReturn property
*/
public synchronized void setTestOnReturn(final boolean testOnReturn) {
this.testOnReturn = testOnReturn;
setConnectionPool(GenericObjectPool::setTestOnReturn, Boolean.valueOf(testOnReturn));
}
/**
* Sets the {@code testWhileIdle} property. This property determines whether or not the idle object evictor
* will validate connections.
*
* @param testWhileIdle new value for testWhileIdle property
*/
public synchronized void setTestWhileIdle(final boolean testWhileIdle) {
this.testWhileIdle = testWhileIdle;
setConnectionPool(GenericObjectPool::setTestWhileIdle, Boolean.valueOf(testWhileIdle));
}
/**
* Sets the {code durationBetweenEvictionRuns} property.
*
* @param timeBetweenEvictionRunsMillis the new time between evictor runs
* @see #setDurationBetweenEvictionRuns(Duration)
* @deprecated Use {@link #setDurationBetweenEvictionRuns(Duration)}.
*/
@Deprecated
public synchronized void setTimeBetweenEvictionRunsMillis(final long timeBetweenEvictionRunsMillis) {
setDurationBetweenEvictionRuns(Duration.ofMillis(timeBetweenEvictionRunsMillis));
}
/**
* Sets the {code connection string}.
* <p>
* 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: {@link #getConnection()}, {@link #setLogWriter(PrintWriter)},
* {@link #setLoginTimeout(int)}, {@link #getLoginTimeout()}, {@link #getLogWriter()}.
* </p>
*
* @param connectionString the new value for the JDBC connection connectionString
*/
public synchronized void setUrl(final String connectionString) {
this.connectionString = connectionString;
}
/**
* Sets the {code userName}.
* <p>
* 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: {@link #getConnection()}, {@link #setLogWriter(PrintWriter)},
* {@link #setLoginTimeout(int)}, {@link #getLoginTimeout()}, {@link #getLogWriter()}.
* </p>
*
* @param userName the new value for the JDBC connection user name
*/
public void setUsername(final String userName) {
this.userName = userName;
}
/**
* Sets the {code validationQuery}.
* <p>
* 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: {@link #getConnection()}, {@link #setLogWriter(PrintWriter)},
* {@link #setLoginTimeout(int)}, {@link #getLoginTimeout()}, {@link #getLogWriter()}.
* </p>
*
* @param validationQuery the new value for the validation query
*/
public void setValidationQuery(final String validationQuery) {
this.validationQuery = isEmpty(validationQuery) ? null : validationQuery;
}
/**
* 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.
* <p>
* 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: {@link #getConnection()}, {@link #setLogWriter(PrintWriter)},
* {@link #setLoginTimeout(int)}, {@link #getLoginTimeout()}, {@link #getLogWriter()}.
* </p>
*
* @param validationQueryTimeoutDuration new validation query timeout value in seconds
* @since 2.10.0
*/
public void setValidationQueryTimeout(final Duration validationQueryTimeoutDuration) {
this.validationQueryTimeoutDuration = validationQueryTimeoutDuration;
}
/**
* 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.
* <p>
* 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: {@link #getConnection()}, {@link #setLogWriter(PrintWriter)},
* {@link #setLoginTimeout(int)}, {@link #getLoginTimeout()}, {@link #getLogWriter()}.
* </p>
*
* @param validationQueryTimeoutSeconds new validation query timeout value in seconds
* @deprecated Use {@link #setValidationQueryTimeout(Duration)}.
*/
@Deprecated
public void setValidationQueryTimeout(final int validationQueryTimeoutSeconds) {
this.validationQueryTimeoutDuration = Duration.ofSeconds(validationQueryTimeoutSeconds);
}
/**
* Starts the datasource.
* <p>
* It is not necessary to call this method before using a newly created BasicDataSource instance, but
* calling it in that context causes the datasource to be immediately initialized (instead of waiting for
* the first {@link #getConnection()} request). Its primary use is to restart and reinitialize a
* datasource that has been closed.
* <p>
* When this method is called after {@link #close()}, connections checked out by clients
* before the datasource was stopped do not count in {@link #getMaxTotal()} or {@link #getNumActive()}.
* For example, if there are 3 connections checked out by clients when {@link #close()} is invoked and they are
* not returned before {@link #start()} is invoked, after this method is called, {@link #getNumActive()} will
* return 0. These connections will be physically closed when they are returned, but they will not count against
* the maximum allowed in the newly started datasource.
*
* @throws SQLException if an error occurs initializing the datasource
*/
@Override
public synchronized void start() throws SQLException {
closed = false;
createDataSource();
}
/**
* Starts the connection pool maintenance task, if configured.
*/
protected void startPoolMaintenance() {
if (connectionPool != null && durationBetweenEvictionRuns.compareTo(Duration.ZERO) > 0) {
connectionPool.setDurationBetweenEvictionRuns(durationBetweenEvictionRuns);
}
}
private Collector<String, ?, LinkedHashSet<String>> toLinkedHashSet() {
return Collectors.toCollection(LinkedHashSet::new);
}
@Override
public <T> T unwrap(final Class<T> iface) throws SQLException {
if (isWrapperFor(iface)) {
return iface.cast(this);
}
throw new SQLException(this + " is not a wrapper for " + iface);
}
private void updateJmxName(final GenericObjectPoolConfig<?> config) {
if (registeredJmxObjectName == null) {
return;
}
final StringBuilder base = new StringBuilder(registeredJmxObjectName.toString());
base.append(Constants.JMX_CONNECTION_POOL_BASE_EXT);
config.setJmxNameBase(base.toString());
config.setJmxNamePrefix(Constants.JMX_CONNECTION_POOL_PREFIX);
}
}