Class InstanceKeyDataSource
- java.lang.Object
-
- org.apache.tomcat.dbcp.dbcp2.datasources.InstanceKeyDataSource
-
- All Implemented Interfaces:
Serializable,AutoCloseable,Wrapper,Referenceable,CommonDataSource,DataSource
- Direct Known Subclasses:
PerUserPoolDataSource,SharedPoolDataSource
public abstract class InstanceKeyDataSource extends Object implements DataSource, Referenceable, Serializable, AutoCloseable
The base class for
SharedPoolDataSourceandPerUserPoolDataSource. Many of the configuration properties are shared and defined here. This class is declared public in order to allow particular usage with commons-beanutils; do not make direct use of it outside of commons-dbcp2.A J2EE container will normally provide some method of initializing the
DataSourcewhose attributes are presented as bean getters/setters and then deploying it via JNDI. It is then available to an application as a source of pooled logical connections to the database. The pool needs a source of physical connections. This source is in the form of aConnectionPoolDataSourcethat can be specified via thesetDataSourceName(String)used to lookup the source via JNDI.Although normally used within a JNDI environment, A DataSource can be instantiated and initialized as any bean. In this case the
ConnectionPoolDataSourcewill likely be instantiated in a similar manner. This class allows the physical source of connections to be attached directly to this pool using thesetConnectionPoolDataSource(ConnectionPoolDataSource)method.The dbcp package contains an adapter,
DriverAdapterCPDS, that can be used to allow the use ofDataSource's based on this class with JDBC driver implementations that do not supply aConnectionPoolDataSource, but still provide aDriverimplementation.The package documentation contains an example using Apache Tomcat and JNDI and it also contains a non-JNDI example.
- Since:
- 2.0
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected static intUNKNOWN_TRANSACTIONISOLATIONInternal constant to indicate the level is not set.
-
Constructor Summary
Constructors Constructor Description InstanceKeyDataSource()Default no-arg constructor for Serialization.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected voidassertInitializationAllowed()Throws an IllegalStateException, if a PooledConnection has already been requested.abstract voidclose()Closes the connection pool being maintained by this datasource.ConnectiongetConnection()Attempts to establish a database connection.ConnectiongetConnection(String userName, String userPassword)Attempts to retrieve a database connection usinggetPooledConnectionAndInfo(String, String)with the provided user name and password.protected abstract org.apache.tomcat.dbcp.dbcp2.datasources.PooledConnectionManagergetConnectionManager(org.apache.tomcat.dbcp.dbcp2.datasources.UserPassKey upkey)ConnectionPoolDataSourcegetConnectionPoolDataSource()Gets the value of connectionPoolDataSource.StringgetDataSourceName()Gets the name of the ConnectionPoolDataSource which backs this pool.booleangetDefaultBlockWhenExhausted()Gets the default value forBaseObjectPoolConfig.getBlockWhenExhausted()for each per user pool.DurationgetDefaultDurationBetweenEvictionRuns()Gets the default value forBaseGenericObjectPool.getDurationBetweenEvictionRuns()for each per user pool.StringgetDefaultEvictionPolicyClassName()Gets the default value forBaseObjectPoolConfig.getEvictionPolicyClassName()for each per user pool.booleangetDefaultLifo()Gets the default value forBaseObjectPoolConfig.getLifo()for each per user pool.intgetDefaultMaxIdle()Gets the default value forGenericKeyedObjectPoolConfig.getMaxIdlePerKey()for each per user pool.intgetDefaultMaxTotal()Gets the default value forGenericKeyedObjectPoolConfig.getMaxTotalPerKey()for each per user pool.DurationgetDefaultMaxWait()Gets the default value forBaseObjectPoolConfig.getMaxWaitDuration()for each per user pool.longgetDefaultMaxWaitMillis()Deprecated.UsegetDefaultMaxWait().DurationgetDefaultMinEvictableIdleDuration()Gets the default value forBaseObjectPoolConfig.getMinEvictableIdleDuration()for each per user pool.longgetDefaultMinEvictableIdleTimeMillis()Deprecated.intgetDefaultMinIdle()Gets the default value forGenericKeyedObjectPoolConfig.getMinIdlePerKey()for each per user pool.intgetDefaultNumTestsPerEvictionRun()Gets the default value forBaseObjectPoolConfig.getNumTestsPerEvictionRun()for each per user pool.DurationgetDefaultSoftMinEvictableIdleDuration()Gets the default value forGenericObjectPool#getSoftMinEvictableIdleTimeMillis()for each per user pool.longgetDefaultSoftMinEvictableIdleTimeMillis()Deprecated.booleangetDefaultTestOnBorrow()Gets the default value forGenericObjectPool#getTestOnBorrow()for each per user pool.booleangetDefaultTestOnCreate()Gets the default value forGenericObjectPool#getTestOnCreate()for each per user pool.booleangetDefaultTestOnReturn()Gets the default value forGenericObjectPool#getTestOnReturn()for each per user pool.booleangetDefaultTestWhileIdle()Gets the default value forGenericObjectPool#getTestWhileIdle()for each per user pool.longgetDefaultTimeBetweenEvictionRunsMillis()Deprecated.intgetDefaultTransactionIsolation()Gets the value of defaultTransactionIsolation, which defines the state of connections handed out from this pool.StringgetDescription()Gets the description.protected StringgetInstanceKey()Gets the instance key.StringgetJndiEnvironment(String key)Gets the value of jndiEnvironment which is used when instantiating a JNDI InitialContext.intgetLoginTimeout()Deprecated.DurationgetLoginTimeoutDuration()Gets the value of loginTimeout.PrintWritergetLogWriter()Gets the value of logWriter.DurationgetMaxConnDuration()Gets the maximum permitted lifetime of a connection.DurationgetMaxConnLifetime()Deprecated.UsegetMaxConnDuration().longgetMaxConnLifetimeMillis()Deprecated.UsegetMaxConnLifetime().LoggergetParentLogger()protected abstract org.apache.tomcat.dbcp.dbcp2.datasources.PooledConnectionAndInfogetPooledConnectionAndInfo(String userName, String userPassword)This method is protected but can only be implemented in this package because PooledConnectionAndInfo is a package private type.StringgetValidationQuery()Gets the SQL query that will be used to validate connections from this pool before returning them to the caller.intgetValidationQueryTimeout()Deprecated.DurationgetValidationQueryTimeoutDuration()Returns the timeout Duration before the validation query fails.BooleanisDefaultAutoCommit()Gets the value of defaultAutoCommit, which defines the state of connections handed out from this pool.BooleanisDefaultReadOnly()Gets the value of defaultReadOnly, which defines the state of connections handed out from this pool.booleanisRollbackAfterValidation()Whether a rollback will be issued after executing the SQL query that will be used to validate connections from this pool before returning them to the caller.booleanisWrapperFor(Class<?> iface)voidsetConnectionPoolDataSource(ConnectionPoolDataSource dataSource)Sets the back end ConnectionPoolDataSource.voidsetDataSourceName(String dataSourceName)Sets the name of the ConnectionPoolDataSource which backs this pool.voidsetDefaultAutoCommit(Boolean defaultAutoCommit)Sets the value of defaultAutoCommit, which defines the state of connections handed out from this pool.voidsetDefaultBlockWhenExhausted(boolean blockWhenExhausted)Sets the default value forBaseObjectPoolConfig.getBlockWhenExhausted()for each per user pool.voidsetDefaultDurationBetweenEvictionRuns(Duration defaultDurationBetweenEvictionRuns)Sets the default value for()for each per user pool.voidsetDefaultEvictionPolicyClassName(String evictionPolicyClassName)Sets the default value forBaseObjectPoolConfig.getEvictionPolicyClassName()for each per user pool.voidsetDefaultLifo(boolean lifo)Sets the default value forBaseObjectPoolConfig.getLifo()for each per user pool.voidsetDefaultMaxIdle(int maxIdle)Sets the default value forGenericKeyedObjectPoolConfig.getMaxIdlePerKey()for each per user pool.voidsetDefaultMaxTotal(int maxTotal)Sets the default value forGenericKeyedObjectPoolConfig.getMaxTotalPerKey()for each per user pool.voidsetDefaultMaxWait(Duration maxWaitMillis)Sets the default value forBaseObjectPoolConfig.getMaxWaitDuration()for each per user pool.voidsetDefaultMaxWaitMillis(long maxWaitMillis)Deprecated.voidsetDefaultMinEvictableIdle(Duration defaultMinEvictableIdleDuration)Sets the default value forBaseObjectPoolConfig.getMinEvictableIdleDuration()for each per user pool.voidsetDefaultMinEvictableIdleTimeMillis(long minEvictableIdleTimeMillis)Deprecated.voidsetDefaultMinIdle(int minIdle)Sets the default value forGenericKeyedObjectPoolConfig.getMinIdlePerKey()for each per user pool.voidsetDefaultNumTestsPerEvictionRun(int numTestsPerEvictionRun)Sets the default value forBaseObjectPoolConfig.getNumTestsPerEvictionRun()for each per user pool.voidsetDefaultReadOnly(Boolean defaultReadOnly)Sets the value of defaultReadOnly, which defines the state of connections handed out from this pool.voidsetDefaultSoftMinEvictableIdle(Duration defaultSoftMinEvictableIdleDuration)Sets the default value forGenericObjectPool#getSoftMinEvictableIdleTimeMillis()for each per user pool.voidsetDefaultSoftMinEvictableIdleTimeMillis(long softMinEvictableIdleTimeMillis)Deprecated.voidsetDefaultTestOnBorrow(boolean testOnBorrow)Sets the default value forGenericObjectPool#getTestOnBorrow()for each per user pool.voidsetDefaultTestOnCreate(boolean testOnCreate)Sets the default value forGenericObjectPool#getTestOnCreate()for each per user pool.voidsetDefaultTestOnReturn(boolean testOnReturn)Sets the default value forGenericObjectPool#getTestOnReturn()for each per user pool.voidsetDefaultTestWhileIdle(boolean testWhileIdle)Sets the default value forGenericObjectPool#getTestWhileIdle()for each per user pool.voidsetDefaultTimeBetweenEvictionRunsMillis(long timeBetweenEvictionRunsMillis)Deprecated.voidsetDefaultTransactionIsolation(int defaultTransactionIsolation)Sets the value of defaultTransactionIsolation, which defines the state of connections handed out from this pool.voidsetDescription(String description)Sets the description.voidsetJndiEnvironment(String key, String value)Sets the value of the given JNDI environment property to be used when instantiating a JNDI InitialContext.voidsetLoginTimeout(int loginTimeout)Deprecated.voidsetLoginTimeout(Duration loginTimeout)Sets the value of loginTimeout.voidsetLogWriter(PrintWriter logWriter)Sets the value of logWriter.voidsetMaxConnLifetime(Duration maxConnLifetimeMillis)Sets the maximum permitted lifetime of a connection.voidsetMaxConnLifetimeMillis(long maxConnLifetimeMillis)Deprecated.voidsetRollbackAfterValidation(boolean rollbackAfterValidation)Whether a rollback will be issued after executing the SQL query that will be used to validate connections from this pool before returning them to the caller.protected abstract voidsetupDefaults(Connection connection, String userName)voidsetValidationQuery(String validationQuery)Sets the SQL query that will be used to validate connections from this pool before returning them to the caller.voidsetValidationQueryTimeout(int validationQueryTimeoutSeconds)Deprecated.voidsetValidationQueryTimeout(Duration validationQueryTimeoutDuration)Sets the timeout duration before the validation query fails.protected ConnectionPoolDataSourcetestCPDS(String userName, String userPassword)StringtoString()protected voidtoStringFields(StringBuilder builder)<T> Tunwrap(Class<T> iface)-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface javax.sql.CommonDataSource
createShardingKeyBuilder
-
Methods inherited from interface javax.sql.DataSource
createConnectionBuilder
-
Methods inherited from interface javax.naming.Referenceable
getReference
-
-
-
-
Field Detail
-
UNKNOWN_TRANSACTIONISOLATION
protected static final int UNKNOWN_TRANSACTIONISOLATION
Internal constant to indicate the level is not set.- See Also:
- Constant Field Values
-
-
Method Detail
-
assertInitializationAllowed
protected void assertInitializationAllowed() throws IllegalStateExceptionThrows an IllegalStateException, if a PooledConnection has already been requested.- Throws:
IllegalStateException- Thrown if a PooledConnection has already been requested.
-
close
public abstract void close() throws SQLExceptionCloses the connection pool being maintained by this datasource.- Specified by:
closein interfaceAutoCloseable- Throws:
SQLException
-
getConnection
public Connection getConnection() throws SQLException
Attempts to establish a database connection.- Specified by:
getConnectionin interfaceDataSource- Throws:
SQLException
-
getConnection
public Connection getConnection(String userName, String userPassword) throws SQLException
Attempts to retrieve a database connection usinggetPooledConnectionAndInfo(String, String)with the provided user name and password. The password on thePooledConnectionAndInfoinstance returned bygetPooledConnectionAndInfois compared to thepasswordparameter. If the comparison fails, a database connection using the supplied user name and password is attempted. If the connection attempt fails, an SQLException is thrown, indicating that the given password did not match the password used to create the pooled connection. If the connection attempt succeeds, this means that the database password has been changed. In this case, thePooledConnectionAndInfoinstance retrieved with the old password is destroyed and thegetPooledConnectionAndInfois repeatedly invoked until aPooledConnectionAndInfoinstance with the new password is returned.- Specified by:
getConnectionin interfaceDataSource- Throws:
SQLException
-
getConnectionManager
protected abstract org.apache.tomcat.dbcp.dbcp2.datasources.PooledConnectionManager getConnectionManager(org.apache.tomcat.dbcp.dbcp2.datasources.UserPassKey upkey)
-
getConnectionPoolDataSource
public ConnectionPoolDataSource getConnectionPoolDataSource()
Gets the value of connectionPoolDataSource. This method will return null, if the backing data source is being accessed via JNDI.- Returns:
- value of connectionPoolDataSource.
-
getDataSourceName
public String getDataSourceName()
Gets the name of the ConnectionPoolDataSource which backs this pool. This name is used to look up the data source from a JNDI service provider.- Returns:
- value of dataSourceName.
-
getDefaultBlockWhenExhausted
public boolean getDefaultBlockWhenExhausted()
Gets the default value forBaseObjectPoolConfig.getBlockWhenExhausted()for each per user pool.- Returns:
- The default value for
BaseObjectPoolConfig.getBlockWhenExhausted()for each per user pool.
-
getDefaultDurationBetweenEvictionRuns
public Duration getDefaultDurationBetweenEvictionRuns()
Gets the default value forBaseGenericObjectPool.getDurationBetweenEvictionRuns()for each per user pool.- Returns:
- The default value for
BaseGenericObjectPool.getDurationBetweenEvictionRuns()for each per user pool. - Since:
- 2.10.0
-
getDefaultEvictionPolicyClassName
public String getDefaultEvictionPolicyClassName()
Gets the default value forBaseObjectPoolConfig.getEvictionPolicyClassName()for each per user pool.- Returns:
- The default value for
BaseObjectPoolConfig.getEvictionPolicyClassName()for each per user pool.
-
getDefaultLifo
public boolean getDefaultLifo()
Gets the default value forBaseObjectPoolConfig.getLifo()for each per user pool.- Returns:
- The default value for
BaseObjectPoolConfig.getLifo()for each per user pool.
-
getDefaultMaxIdle
public int getDefaultMaxIdle()
Gets the default value forGenericKeyedObjectPoolConfig.getMaxIdlePerKey()for each per user pool.- Returns:
- The default value for
GenericKeyedObjectPoolConfig.getMaxIdlePerKey()for each per user pool.
-
getDefaultMaxTotal
public int getDefaultMaxTotal()
Gets the default value forGenericKeyedObjectPoolConfig.getMaxTotalPerKey()for each per user pool.- Returns:
- The default value for
GenericKeyedObjectPoolConfig.getMaxTotalPerKey()for each per user pool.
-
getDefaultMaxWait
public Duration getDefaultMaxWait()
Gets the default value forBaseObjectPoolConfig.getMaxWaitDuration()for each per user pool.- Returns:
- The default value for
BaseObjectPoolConfig.getMaxWaitDuration()for each per user pool. - Since:
- 2.9.0
-
getDefaultMaxWaitMillis
@Deprecated public long getDefaultMaxWaitMillis()
Deprecated.UsegetDefaultMaxWait().Gets the default value forBaseObjectPoolConfig.getMaxWaitDuration()for each per user pool.- Returns:
- The default value for
BaseObjectPoolConfig.getMaxWaitDuration()for each per user pool.
-
getDefaultMinEvictableIdleDuration
public Duration getDefaultMinEvictableIdleDuration()
Gets the default value forBaseObjectPoolConfig.getMinEvictableIdleDuration()for each per user pool.- Returns:
- The default value for
BaseObjectPoolConfig.getMinEvictableIdleDuration()for each per user pool. - Since:
- 2.10.0
-
getDefaultMinEvictableIdleTimeMillis
@Deprecated public long getDefaultMinEvictableIdleTimeMillis()
Deprecated.Gets the default value forBaseObjectPoolConfig.getMinEvictableIdleDuration()for each per user pool.- Returns:
- The default value for
BaseObjectPoolConfig.getMinEvictableIdleDuration()for each per user pool.
-
getDefaultMinIdle
public int getDefaultMinIdle()
Gets the default value forGenericKeyedObjectPoolConfig.getMinIdlePerKey()for each per user pool.- Returns:
- The default value for
GenericKeyedObjectPoolConfig.getMinIdlePerKey()for each per user pool.
-
getDefaultNumTestsPerEvictionRun
public int getDefaultNumTestsPerEvictionRun()
Gets the default value forBaseObjectPoolConfig.getNumTestsPerEvictionRun()for each per user pool.- Returns:
- The default value for
BaseObjectPoolConfig.getNumTestsPerEvictionRun()for each per user pool.
-
getDefaultSoftMinEvictableIdleDuration
public Duration getDefaultSoftMinEvictableIdleDuration()
Gets the default value forGenericObjectPool#getSoftMinEvictableIdleTimeMillis()for each per user pool.- Returns:
- The default value for
GenericObjectPool#getSoftMinEvictableIdleTimeMillis()for each per user pool. - Since:
- 2.10.0
-
getDefaultSoftMinEvictableIdleTimeMillis
@Deprecated public long getDefaultSoftMinEvictableIdleTimeMillis()
Deprecated.Gets the default value forGenericObjectPool#getSoftMinEvictableIdleTimeMillis()for each per user pool.- Returns:
- The default value for
GenericObjectPool#getSoftMinEvictableIdleTimeMillis()for each per user pool.
-
getDefaultTestOnBorrow
public boolean getDefaultTestOnBorrow()
Gets the default value forGenericObjectPool#getTestOnBorrow()for each per user pool.- Returns:
- The default value for
GenericObjectPool#getTestOnBorrow()for each per user pool.
-
getDefaultTestOnCreate
public boolean getDefaultTestOnCreate()
Gets the default value forGenericObjectPool#getTestOnCreate()for each per user pool.- Returns:
- The default value for
GenericObjectPool#getTestOnCreate()for each per user pool.
-
getDefaultTestOnReturn
public boolean getDefaultTestOnReturn()
Gets the default value forGenericObjectPool#getTestOnReturn()for each per user pool.- Returns:
- The default value for
GenericObjectPool#getTestOnReturn()for each per user pool.
-
getDefaultTestWhileIdle
public boolean getDefaultTestWhileIdle()
Gets the default value forGenericObjectPool#getTestWhileIdle()for each per user pool.- Returns:
- The default value for
GenericObjectPool#getTestWhileIdle()for each per user pool.
-
getDefaultTimeBetweenEvictionRunsMillis
@Deprecated public long getDefaultTimeBetweenEvictionRunsMillis()
Deprecated.Gets the default value for()for each per user pool.- Returns:
- The default value for
()for each per user pool.
-
getDefaultTransactionIsolation
public int getDefaultTransactionIsolation()
Gets the value of defaultTransactionIsolation, which defines the state of connections handed out from this pool. The value can be changed on the Connection using Connection.setTransactionIsolation(int). If this method returns -1, the default is JDBC driver dependent.- Returns:
- value of defaultTransactionIsolation.
-
getDescription
public String getDescription()
Gets the description. This property is defined by JDBC as for use with GUI (or other) tools that might deploy the datasource. It serves no internal purpose.- Returns:
- value of description.
-
getInstanceKey
protected String getInstanceKey()
Gets the instance key.- Returns:
- the instance key.
-
getJndiEnvironment
public String getJndiEnvironment(String key)
Gets the value of jndiEnvironment which is used when instantiating a JNDI InitialContext. This InitialContext is used to locate the back end ConnectionPoolDataSource.- Parameters:
key- JNDI environment key.- Returns:
- value of jndiEnvironment.
-
getLoginTimeout
@Deprecated public int getLoginTimeout()
Deprecated.Gets the value of loginTimeout.- Specified by:
getLoginTimeoutin interfaceCommonDataSource- Specified by:
getLoginTimeoutin interfaceDataSource- Returns:
- value of loginTimeout.
-
getLoginTimeoutDuration
public Duration getLoginTimeoutDuration()
Gets the value of loginTimeout.- Returns:
- value of loginTimeout.
- Since:
- 2.10.0
-
getLogWriter
public PrintWriter getLogWriter()
Gets the value of logWriter.- Specified by:
getLogWriterin interfaceCommonDataSource- Specified by:
getLogWriterin interfaceDataSource- Returns:
- value of logWriter.
-
getMaxConnDuration
public Duration getMaxConnDuration()
Gets the maximum permitted lifetime of a connection. A value of zero or less indicates an infinite lifetime.- Returns:
- The maximum permitted lifetime of a connection. A value of zero or less indicates an infinite lifetime.
- Since:
- 2.10.0
-
getMaxConnLifetime
@Deprecated public Duration getMaxConnLifetime()
Deprecated.UsegetMaxConnDuration().Gets the maximum permitted lifetime of a connection. A value of zero or less indicates an infinite lifetime.- Returns:
- The maximum permitted lifetime of a connection. A value of zero or less indicates an infinite lifetime.
-
getMaxConnLifetimeMillis
@Deprecated public long getMaxConnLifetimeMillis()
Deprecated.UsegetMaxConnLifetime().Gets the maximum permitted lifetime of a connection in milliseconds. A value of zero or less indicates an infinite lifetime.- Returns:
- The maximum permitted lifetime of a connection in milliseconds. A value of zero or less indicates an infinite lifetime.
-
getParentLogger
public Logger getParentLogger() throws SQLFeatureNotSupportedException
- Specified by:
getParentLoggerin interfaceCommonDataSource- Throws:
SQLFeatureNotSupportedException
-
getPooledConnectionAndInfo
protected abstract org.apache.tomcat.dbcp.dbcp2.datasources.PooledConnectionAndInfo getPooledConnectionAndInfo(String userName, String userPassword) throws SQLException
This method is protected but can only be implemented in this package because PooledConnectionAndInfo is a package private type.- Parameters:
userName- The user name.userPassword- The user password.- Returns:
- Matching PooledConnectionAndInfo.
- Throws:
SQLException- Connection or registration failure.
-
getValidationQuery
public String getValidationQuery()
Gets the SQL query that will be used to validate connections from this pool before returning them to the caller. If specified, this query MUST be an SQL SELECT statement that returns at least one row. If not specified,Connection.isValid(int)will be used to validate connections.- Returns:
- The SQL query that will be used to validate connections from this pool before returning them to the caller.
-
getValidationQueryTimeout
@Deprecated public int getValidationQueryTimeout()
Deprecated.Returns the timeout in seconds before the validation query fails.- Returns:
- The timeout in seconds before the validation query fails.
-
getValidationQueryTimeoutDuration
public Duration getValidationQueryTimeoutDuration()
Returns the timeout Duration before the validation query fails.- Returns:
- The timeout Duration before the validation query fails.
-
isDefaultAutoCommit
public Boolean isDefaultAutoCommit()
Gets the value of defaultAutoCommit, which defines the state of connections handed out from this pool. The value can be changed on the Connection using Connection.setAutoCommit(boolean). The default isnullwhich will use the default value for the drive.- Returns:
- value of defaultAutoCommit.
-
isDefaultReadOnly
public Boolean isDefaultReadOnly()
Gets the value of defaultReadOnly, which defines the state of connections handed out from this pool. The value can be changed on the Connection using Connection.setReadOnly(boolean). The default isnullwhich will use the default value for the drive.- Returns:
- value of defaultReadOnly.
-
isRollbackAfterValidation
public boolean isRollbackAfterValidation()
Whether a rollback will be issued after executing the SQL query that will be used to validate connections from this pool before returning them to the caller.- Returns:
- true if a rollback will be issued after executing the validation query
-
isWrapperFor
public boolean isWrapperFor(Class<?> iface) throws SQLException
- Specified by:
isWrapperForin interfaceWrapper- Throws:
SQLException
-
setConnectionPoolDataSource
public void setConnectionPoolDataSource(ConnectionPoolDataSource dataSource)
Sets the back end ConnectionPoolDataSource. This property should not be set if using JNDI to access the data source.- Parameters:
dataSource- Value to assign to connectionPoolDataSource.
-
setDataSourceName
public void setDataSourceName(String dataSourceName)
Sets the name of the ConnectionPoolDataSource which backs this pool. This name is used to look up the data source from a JNDI service provider.- Parameters:
dataSourceName- Value to assign to dataSourceName.
-
setDefaultAutoCommit
public void setDefaultAutoCommit(Boolean defaultAutoCommit)
Sets the value of defaultAutoCommit, which defines the state of connections handed out from this pool. The value can be changed on the Connection using Connection.setAutoCommit(boolean). The default isnullwhich will use the default value for the drive.- Parameters:
defaultAutoCommit- Value to assign to defaultAutoCommit.
-
setDefaultBlockWhenExhausted
public void setDefaultBlockWhenExhausted(boolean blockWhenExhausted)
Sets the default value forBaseObjectPoolConfig.getBlockWhenExhausted()for each per user pool.- Parameters:
blockWhenExhausted- The default value forBaseObjectPoolConfig.getBlockWhenExhausted()for each per user pool.
-
setDefaultDurationBetweenEvictionRuns
public void setDefaultDurationBetweenEvictionRuns(Duration defaultDurationBetweenEvictionRuns)
Sets the default value for()for each per user pool.- Parameters:
defaultDurationBetweenEvictionRuns- The default value for()for each per user pool.- Since:
- 2.10.0
-
setDefaultEvictionPolicyClassName
public void setDefaultEvictionPolicyClassName(String evictionPolicyClassName)
Sets the default value forBaseObjectPoolConfig.getEvictionPolicyClassName()for each per user pool.- Parameters:
evictionPolicyClassName- The default value forBaseObjectPoolConfig.getEvictionPolicyClassName()for each per user pool.
-
setDefaultLifo
public void setDefaultLifo(boolean lifo)
Sets the default value forBaseObjectPoolConfig.getLifo()for each per user pool.- Parameters:
lifo- The default value forBaseObjectPoolConfig.getLifo()for each per user pool.
-
setDefaultMaxIdle
public void setDefaultMaxIdle(int maxIdle)
Sets the default value forGenericKeyedObjectPoolConfig.getMaxIdlePerKey()for each per user pool.- Parameters:
maxIdle- The default value forGenericKeyedObjectPoolConfig.getMaxIdlePerKey()for each per user pool.
-
setDefaultMaxTotal
public void setDefaultMaxTotal(int maxTotal)
Sets the default value forGenericKeyedObjectPoolConfig.getMaxTotalPerKey()for each per user pool.- Parameters:
maxTotal- The default value forGenericKeyedObjectPoolConfig.getMaxTotalPerKey()for each per user pool.
-
setDefaultMaxWait
public void setDefaultMaxWait(Duration maxWaitMillis)
Sets the default value forBaseObjectPoolConfig.getMaxWaitDuration()for each per user pool.- Parameters:
maxWaitMillis- The default value forBaseObjectPoolConfig.getMaxWaitDuration()for each per user pool.- Since:
- 2.9.0
-
setDefaultMaxWaitMillis
@Deprecated public void setDefaultMaxWaitMillis(long maxWaitMillis)
Deprecated.Sets the default value forBaseObjectPoolConfig.getMaxWaitMillis()for each per user pool.- Parameters:
maxWaitMillis- The default value forBaseObjectPoolConfig.getMaxWaitMillis()for each per user pool.
-
setDefaultMinEvictableIdle
public void setDefaultMinEvictableIdle(Duration defaultMinEvictableIdleDuration)
Sets the default value forBaseObjectPoolConfig.getMinEvictableIdleDuration()for each per user pool.- Parameters:
defaultMinEvictableIdleDuration- The default value forBaseObjectPoolConfig.getMinEvictableIdleDuration()for each per user pool.- Since:
- 2.10.0
-
setDefaultMinEvictableIdleTimeMillis
@Deprecated public void setDefaultMinEvictableIdleTimeMillis(long minEvictableIdleTimeMillis)
Deprecated.Sets the default value forBaseObjectPoolConfig.getMinEvictableIdleDuration()for each per user pool.- Parameters:
minEvictableIdleTimeMillis- The default value forBaseObjectPoolConfig.getMinEvictableIdleDuration()for each per user pool.
-
setDefaultMinIdle
public void setDefaultMinIdle(int minIdle)
Sets the default value forGenericKeyedObjectPoolConfig.getMinIdlePerKey()for each per user pool.- Parameters:
minIdle- The default value forGenericKeyedObjectPoolConfig.getMinIdlePerKey()for each per user pool.
-
setDefaultNumTestsPerEvictionRun
public void setDefaultNumTestsPerEvictionRun(int numTestsPerEvictionRun)
Sets the default value forBaseObjectPoolConfig.getNumTestsPerEvictionRun()for each per user pool.- Parameters:
numTestsPerEvictionRun- The default value forBaseObjectPoolConfig.getNumTestsPerEvictionRun()for each per user pool.
-
setDefaultReadOnly
public void setDefaultReadOnly(Boolean defaultReadOnly)
Sets the value of defaultReadOnly, which defines the state of connections handed out from this pool. The value can be changed on the Connection using Connection.setReadOnly(boolean). The default isnullwhich will use the default value for the drive.- Parameters:
defaultReadOnly- Value to assign to defaultReadOnly.
-
setDefaultSoftMinEvictableIdle
public void setDefaultSoftMinEvictableIdle(Duration defaultSoftMinEvictableIdleDuration)
Sets the default value forGenericObjectPool#getSoftMinEvictableIdleTimeMillis()for each per user pool.- Parameters:
defaultSoftMinEvictableIdleDuration- The default value forGenericObjectPool#getSoftMinEvictableIdleTimeMillis()for each per user pool.- Since:
- 2.10.0
-
setDefaultSoftMinEvictableIdleTimeMillis
@Deprecated public void setDefaultSoftMinEvictableIdleTimeMillis(long softMinEvictableIdleTimeMillis)
Deprecated.Sets the default value forGenericObjectPool#getSoftMinEvictableIdleTimeMillis()for each per user pool.- Parameters:
softMinEvictableIdleTimeMillis- The default value forGenericObjectPool#getSoftMinEvictableIdleTimeMillis()for each per user pool.
-
setDefaultTestOnBorrow
public void setDefaultTestOnBorrow(boolean testOnBorrow)
Sets the default value forGenericObjectPool#getTestOnBorrow()for each per user pool.- Parameters:
testOnBorrow- The default value forGenericObjectPool#getTestOnBorrow()for each per user pool.
-
setDefaultTestOnCreate
public void setDefaultTestOnCreate(boolean testOnCreate)
Sets the default value forGenericObjectPool#getTestOnCreate()for each per user pool.- Parameters:
testOnCreate- The default value forGenericObjectPool#getTestOnCreate()for each per user pool.
-
setDefaultTestOnReturn
public void setDefaultTestOnReturn(boolean testOnReturn)
Sets the default value forGenericObjectPool#getTestOnReturn()for each per user pool.- Parameters:
testOnReturn- The default value forGenericObjectPool#getTestOnReturn()for each per user pool.
-
setDefaultTestWhileIdle
public void setDefaultTestWhileIdle(boolean testWhileIdle)
Sets the default value forGenericObjectPool#getTestWhileIdle()for each per user pool.- Parameters:
testWhileIdle- The default value forGenericObjectPool#getTestWhileIdle()for each per user pool.
-
setDefaultTimeBetweenEvictionRunsMillis
@Deprecated public void setDefaultTimeBetweenEvictionRunsMillis(long timeBetweenEvictionRunsMillis)
Deprecated.Sets the default value forBaseGenericObjectPool.getDurationBetweenEvictionRuns()for each per user pool.- Parameters:
timeBetweenEvictionRunsMillis- The default value forBaseGenericObjectPool.getDurationBetweenEvictionRuns()for each per user pool.
-
setDefaultTransactionIsolation
public void setDefaultTransactionIsolation(int defaultTransactionIsolation)
Sets the value of defaultTransactionIsolation, which defines the state of connections handed out from this pool. The value can be changed on the Connection using Connection.setTransactionIsolation(int). The default is JDBC driver dependent.- Parameters:
defaultTransactionIsolation- Value to assign to defaultTransactionIsolation
-
setDescription
public void setDescription(String description)
Sets the description. This property is defined by JDBC as for use with GUI (or other) tools that might deploy the datasource. It serves no internal purpose.- Parameters:
description- Value to assign to description.
-
setJndiEnvironment
public void setJndiEnvironment(String key, String value)
Sets the value of the given JNDI environment property to be used when instantiating a JNDI InitialContext. This InitialContext is used to locate the back end ConnectionPoolDataSource.- Parameters:
key- the JNDI environment property to set.value- the value assigned to specified JNDI environment property.
-
setLoginTimeout
public void setLoginTimeout(Duration loginTimeout)
Sets the value of loginTimeout.- Parameters:
loginTimeout- Value to assign to loginTimeout.- Since:
- 2.10.0
-
setLoginTimeout
@Deprecated public void setLoginTimeout(int loginTimeout)
Deprecated.Sets the value of loginTimeout.- Specified by:
setLoginTimeoutin interfaceCommonDataSource- Specified by:
setLoginTimeoutin interfaceDataSource- Parameters:
loginTimeout- Value to assign to loginTimeout.
-
setLogWriter
public void setLogWriter(PrintWriter logWriter)
Sets the value of logWriter.- Specified by:
setLogWriterin interfaceCommonDataSource- Specified by:
setLogWriterin interfaceDataSource- Parameters:
logWriter- Value to assign to logWriter.
-
setMaxConnLifetime
public void setMaxConnLifetime(Duration maxConnLifetimeMillis)
Sets the maximum permitted lifetime of a connection. A value of zero or less indicates an infinite lifetime.
Note: this method currently has no effect once the pool has been initialized. The pool is initialized the first time one of the following methods is invoked:
getConnection, setLogwriter, setLoginTimeout, getLoginTimeout, getLogWriter.- Parameters:
maxConnLifetimeMillis- The maximum permitted lifetime of a connection. A value of zero or less indicates an infinite lifetime.- Since:
- 2.9.0
-
setMaxConnLifetimeMillis
@Deprecated public void setMaxConnLifetimeMillis(long maxConnLifetimeMillis)
Deprecated.Sets the maximum permitted lifetime of a connection in milliseconds. A value of zero or less indicates an infinite lifetime.
Note: this method currently has no effect once the pool has been initialized. The pool is initialized the first time one of the following methods is invoked:
getConnection, setLogwriter, setLoginTimeout, getLoginTimeout, getLogWriter.- Parameters:
maxConnLifetimeMillis- The maximum permitted lifetime of a connection in milliseconds. A value of zero or less indicates an infinite lifetime.
-
setRollbackAfterValidation
public void setRollbackAfterValidation(boolean rollbackAfterValidation)
Whether a rollback will be issued after executing the SQL query that will be used to validate connections from this pool before returning them to the caller. Default behavior is NOT to issue a rollback. The setting will only have an effect if a validation query is set- Parameters:
rollbackAfterValidation- new property value
-
setupDefaults
protected abstract void setupDefaults(Connection connection, String userName) throws SQLException
- Throws:
SQLException
-
setValidationQuery
public void setValidationQuery(String validationQuery)
Sets the SQL query that will be used to validate connections from this pool before returning them to the caller. If specified, this query MUST be an SQL SELECT statement that returns at least one row. If not specified, connections will be validated usingConnection.isValid(int).- Parameters:
validationQuery- The SQL query that will be used to validate connections from this pool before returning them to the caller.
-
setValidationQueryTimeout
public void setValidationQueryTimeout(Duration validationQueryTimeoutDuration)
Sets the timeout duration before the validation query fails.- Parameters:
validationQueryTimeoutDuration- The new timeout duration.
-
setValidationQueryTimeout
@Deprecated public void setValidationQueryTimeout(int validationQueryTimeoutSeconds)
Deprecated.Sets the timeout in seconds before the validation query fails.- Parameters:
validationQueryTimeoutSeconds- The new timeout in seconds
-
testCPDS
protected ConnectionPoolDataSource testCPDS(String userName, String userPassword) throws NamingException, SQLException
- Throws:
NamingExceptionSQLException
-
toStringFields
protected void toStringFields(StringBuilder builder)
-
unwrap
public <T> T unwrap(Class<T> iface) throws SQLException
- Specified by:
unwrapin interfaceWrapper- Throws:
SQLException
-
-