Class BasicDataSource
- java.lang.Object
- 
- org.apache.tomcat.dbcp.dbcp2.BasicDataSource
 
- 
- All Implemented Interfaces:
- java.lang.AutoCloseable,- java.sql.Wrapper,- javax.management.MBeanRegistration,- javax.sql.CommonDataSource,- javax.sql.DataSource,- BasicDataSourceMXBean,- DataSourceMXBean
 
 public class BasicDataSource extends java.lang.Object implements javax.sql.DataSource, BasicDataSourceMXBean, javax.management.MBeanRegistration, java.lang.AutoCloseable Basic implementation ofjavax.sql.DataSourcethat is configured via JavaBeans properties.This is not the only way to combine the commons-dbcp2 and commons-pool2 packages, but provides a one-stop solution for basic requirements. - Since:
- 2.0
 
- 
- 
Constructor SummaryConstructors Constructor Description BasicDataSource()
 - 
Method SummaryAll Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description voidaddConnectionProperty(java.lang.String name, java.lang.String value)Adds a custom connection property to the set that will be passed to our JDBC driver.voidclose()Closes and releases all idle connections that are currently stored in the connection pool associated with this data source.protected ConnectionFactorycreateConnectionFactory()Creates a JDBC connection factory for this data source.protected voidcreateConnectionPool(PoolableConnectionFactory factory)Creates a connection pool for this datasource.protected javax.sql.DataSourcecreateDataSource()Creates (if necessary) and return the internal data source we are using to manage our connections.protected javax.sql.DataSourcecreateDataSourceInstance()Creates the actual data source instance.protected GenericObjectPool<PoolableConnection>createObjectPool(PoolableConnectionFactory factory, GenericObjectPoolConfig<PoolableConnection> poolConfig, AbandonedConfig abandonedConfig)Creates an object pool used to provide pooling support forJDBC connections.protected PoolableConnectionFactorycreatePoolableConnectionFactory(ConnectionFactory driverConnectionFactory)Creates the PoolableConnectionFactory and attaches it to the connection pool.voidevict()Manually evicts idle connectionsjava.io.PrintWritergetAbandonedLogWriter()Gets the print writer used by this configuration to log information on abandoned objects.booleangetAbandonedUsageTracking()If the connection pool implementsUsageTracking, 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?booleangetAutoCommitOnReturn()Returns the value of the flag that controls whether or not connections being returned to the pool will be checked and configured withConnection.setAutoCommit(true)if the auto commit setting isfalsewhen the connection is returned.booleangetCacheState()Returns the state caching flag.java.sql.ConnectiongetConnection()Creates (if necessary) and return a connection to the database.java.sql.ConnectiongetConnection(java.lang.String user, java.lang.String pass)BasicDataSource does NOT support this method.java.lang.StringgetConnectionFactoryClassName()Returns the ConnectionFactoryClassName that has been configured for use by this pool.java.util.List<java.lang.String>getConnectionInitSqls()Returns the list of SQL statements executed when a physical connection is first created.java.lang.String[]getConnectionInitSqlsAsArray()Provides the same data asgetConnectionInitSqls()but in an array so it is accessible via JMX.protected GenericObjectPool<PoolableConnection>getConnectionPool()java.lang.BooleangetDefaultAutoCommit()Returns the default auto-commit property.java.lang.StringgetDefaultCatalog()Returns the default catalog.java.lang.IntegergetDefaultQueryTimeout()Gets the default query timeout that will be used forStatements created from this connection.java.lang.BooleangetDefaultReadOnly()Returns the default readOnly property.java.lang.StringgetDefaultSchema()Returns the default schema.intgetDefaultTransactionIsolation()Returns the default transaction isolation state of returned connections.java.util.Set<java.lang.String>getDisconnectionSqlCodes()Returns the set of SQL_STATE codes considered to signal fatal conditions.java.lang.String[]getDisconnectionSqlCodesAsArray()Provides the same data asgetDisconnectionSqlCodes()but in an array so it is accessible via JMX.java.sql.DrivergetDriver()Returns the JDBC Driver that has been configured for use by this pool.java.lang.ClassLoadergetDriverClassLoader()Returns the class loader specified for loading the JDBC driver.java.lang.StringgetDriverClassName()Returns the JDBC driver class name.booleangetEnableAutoCommitOnReturn()Deprecated.java.lang.StringgetEvictionPolicyClassName()Gets the EvictionPolicy implementation in use with this connection pool.booleangetFastFailValidation()True means that validation will fail immediately for connections that have previously thrown SQLExceptions with SQL_STATE indicating fatal disconnection errors.intgetInitialSize()Returns the initial size of the connection pool.java.lang.StringgetJmxName()Returns the JMX name that has been requested for this DataSource.booleangetLifo()Returns the LIFO property.booleangetLogAbandoned()Flag to log stack traces for application code which abandoned a Statement or Connection.booleangetLogExpiredConnections()WhengetMaxConnLifetimeMillis()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.intgetLoginTimeout()BasicDataSource does NOT support this method.java.io.PrintWritergetLogWriter()Returns the log writer being used by this data source.longgetMaxConnLifetimeMillis()Returns the maximum permitted lifetime of a connection in milliseconds.intgetMaxIdle()Returns the maximum number of connections that can remain idle in the pool.intgetMaxOpenPreparedStatements()Gets the value of themaxOpenPreparedStatementsproperty.intgetMaxTotal()Returns the maximum number of active connections that can be allocated at the same time.longgetMaxWaitMillis()Returns the maximum number of milliseconds that the pool will wait for a connection to be returned before throwing an exception.longgetMinEvictableIdleTimeMillis()Returns theminEvictableIdleTimeMillisproperty.intgetMinIdle()Returns the minimum number of idle connections in the pool.intgetNumActive()[Read Only] The current number of active connections that have been allocated from this data source.intgetNumIdle()[Read Only] The current number of idle connections that are waiting to be allocated from this data source.intgetNumTestsPerEvictionRun()Returns the value of thenumTestsPerEvictionRunproperty.java.util.logging.LoggergetParentLogger()java.lang.StringgetPassword()Returns the password passed to the JDBC driver to establish connections.protected javax.management.ObjectNamegetRegisteredJmxName()booleangetRemoveAbandonedOnBorrow()Flag to remove abandoned connections if they exceed the removeAbandonedTimeout when borrowObject is invoked.booleangetRemoveAbandonedOnMaintenance()Flag to remove abandoned connections if they exceed the removeAbandonedTimeout during pool maintenance.intgetRemoveAbandonedTimeout()Timeout in seconds before an abandoned connection can be removed.booleangetRollbackOnReturn()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.longgetSoftMinEvictableIdleTimeMillis()Returns the minimum amount of time a connection may sit idle in the pool before it is eligible for eviction by the idle object evictor, with the extra condition that at least "minIdle" connections remain in the pool.booleangetTestOnBorrow()Returns thetestOnBorrowproperty.booleangetTestOnCreate()Returns thetestOnCreateproperty.booleangetTestOnReturn()Returns the value of thetestOnReturnproperty.booleangetTestWhileIdle()Returns the value of thetestWhileIdleproperty.longgetTimeBetweenEvictionRunsMillis()Returns the value of thetimeBetweenEvictionRunsMillisproperty.java.lang.StringgetUrl()Returns the JDBC connectionurlproperty.java.lang.StringgetUsername()Returns the JDBC connectionuserNameproperty.java.lang.StringgetValidationQuery()Returns the validation query used to validate connections before returning them.intgetValidationQueryTimeout()Returns the validation query timeout.voidinvalidateConnection(java.sql.Connection connection)Manually invalidates a connection, effectively requesting the pool to try to close it, remove it from the pool and reclaim pool capacity.booleanisAccessToUnderlyingConnectionAllowed()Returns the value of the accessToUnderlyingConnectionAllowed property.booleanisClearStatementPoolOnReturn()Returns true if the statement pool is cleared when the connection is returned to its pool.booleanisClosed()If true, this data source is closed and no more connections can be retrieved from this data source.booleanisPoolPreparedStatements()Returns true if we are pooling statements.booleanisWrapperFor(java.lang.Class<?> iface)protected voidlog(java.lang.String message)protected voidlog(java.lang.String message, java.lang.Throwable throwable)Logs the given throwable.voidpostDeregister()voidpostRegister(java.lang.Boolean registrationDone)voidpreDeregister()javax.management.ObjectNamepreRegister(javax.management.MBeanServer server, javax.management.ObjectName objectName)voidremoveConnectionProperty(java.lang.String name)Removes a custom connection property.voidrestart()Restarts the datasource.voidsetAbandonedLogWriter(java.io.PrintWriter logWriter)Sets the print writer to be used by this configuration to log information on abandoned objects.voidsetAbandonedUsageTracking(boolean usageTracking)If the connection pool implementsUsageTracking, 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.voidsetAccessToUnderlyingConnectionAllowed(boolean allow)Sets the value of the accessToUnderlyingConnectionAllowed property.voidsetAutoCommitOnReturn(boolean autoCommitOnReturn)Sets the value of the flag that controls whether or not connections being returned to the pool will be checked and configured withConnection.setAutoCommit(true)if the auto commit setting isfalsewhen the connection is returned.voidsetCacheState(boolean cacheState)Sets the state caching flag.voidsetClearStatementPoolOnReturn(boolean clearStatementPoolOnReturn)Sets whether the pool of statements (which was enabled withsetPoolPreparedStatements(boolean)) should be cleared when the connection is returned to its pool.voidsetConnectionFactoryClassName(java.lang.String connectionFactoryClassName)Sets the ConnectionFactory class name.voidsetConnectionInitSqls(java.util.Collection<java.lang.String> connectionInitSqls)Sets the list of SQL statements to be executed when a physical connection is first created.voidsetConnectionProperties(java.lang.String connectionProperties)Sets the connection properties passed to driver.connect(...).voidsetDefaultAutoCommit(java.lang.Boolean defaultAutoCommit)Sets default auto-commit state of connections returned by this datasource.voidsetDefaultCatalog(java.lang.String defaultCatalog)Sets the default catalog.voidsetDefaultQueryTimeout(java.lang.Integer defaultQueryTimeoutSeconds)Sets the default query timeout that will be used forStatements created from this connection.voidsetDefaultReadOnly(java.lang.Boolean defaultReadOnly)Sets defaultReadonly property.voidsetDefaultSchema(java.lang.String defaultSchema)Sets the default schema.voidsetDefaultTransactionIsolation(int defaultTransactionIsolation)Sets the default transaction isolation state for returned connections.voidsetDisconnectionSqlCodes(java.util.Collection<java.lang.String> disconnectionSqlCodes)Sets the SQL_STATE codes considered to signal fatal conditions.voidsetDriver(java.sql.Driver driver)Sets the JDBC Driver instance to use for this pool.voidsetDriverClassLoader(java.lang.ClassLoader driverClassLoader)Sets the class loader to be used to load the JDBC driver.voidsetDriverClassName(java.lang.String driverClassName)Sets the JDBC driver class name.voidsetEnableAutoCommitOnReturn(boolean autoCommitOnReturn)Deprecated.voidsetEvictionPolicyClassName(java.lang.String evictionPolicyClassName)Sets the EvictionPolicy implementation to use with this connection pool.voidsetFastFailValidation(boolean fastFailValidation)voidsetInitialSize(int initialSize)Sets the initial size of the connection pool.voidsetJmxName(java.lang.String jmxName)Sets the JMX name that has been requested for this DataSource.voidsetLifo(boolean lifo)Sets the LIFO property.voidsetLogAbandoned(boolean logAbandoned)voidsetLogExpiredConnections(boolean logExpiredConnections)WhengetMaxConnLifetimeMillis()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.voidsetLoginTimeout(int loginTimeout)BasicDataSource does NOT support this method.voidsetLogWriter(java.io.PrintWriter logWriter)Sets the log writer being used by this data source.voidsetMaxConnLifetimeMillis(long maxConnLifetimeMillis)Sets the maximum permitted lifetime of a connection in milliseconds.voidsetMaxIdle(int maxIdle)Sets the maximum number of connections that can remain idle in the pool.voidsetMaxOpenPreparedStatements(int maxOpenStatements)Sets the value of themaxOpenPreparedStatementsproperty.voidsetMaxTotal(int maxTotal)Sets the maximum total number of idle and borrows connections that can be active at the same time.voidsetMaxWaitMillis(long maxWaitMillis)Sets the MaxWaitMillis property.voidsetMinEvictableIdleTimeMillis(long minEvictableIdleTimeMillis)Sets theminEvictableIdleTimeMillisproperty.voidsetMinIdle(int minIdle)Sets the minimum number of idle connections in the pool.voidsetNumTestsPerEvictionRun(int numTestsPerEvictionRun)Sets the value of thenumTestsPerEvictionRunproperty.voidsetPassword(java.lang.String password)Sets thepassword.voidsetPoolPreparedStatements(boolean poolingStatements)Sets whether to pool statements or not.voidsetRemoveAbandonedOnBorrow(boolean removeAbandonedOnBorrow)voidsetRemoveAbandonedOnMaintenance(boolean removeAbandonedOnMaintenance)voidsetRemoveAbandonedTimeout(int removeAbandonedTimeout)Sets the timeout in seconds before an abandoned connection can be removed.voidsetRollbackOnReturn(boolean rollbackOnReturn)Sets the flag that controls if a connection will be rolled back when it is returned to the pool if auto commit is not enabled and the connection is not read only.voidsetSoftMinEvictableIdleTimeMillis(long softMinEvictableIdleTimeMillis)Sets the minimum amount of time a connection may sit idle in the pool before it is eligible for eviction by the idle object evictor, with the extra condition that at least "minIdle" connections remain in the pool.voidsetTestOnBorrow(boolean testOnBorrow)Sets thetestOnBorrowproperty.voidsetTestOnCreate(boolean testOnCreate)Sets thetestOnCreateproperty.voidsetTestOnReturn(boolean testOnReturn)Sets thetestOnReturnproperty.voidsetTestWhileIdle(boolean testWhileIdle)Sets thetestWhileIdleproperty.voidsetTimeBetweenEvictionRunsMillis(long timeBetweenEvictionRunsMillis)Sets thetimeBetweenEvictionRunsMillisproperty.voidsetUrl(java.lang.String url)Sets theurl.voidsetUsername(java.lang.String userName)Sets theuserName.voidsetValidationQuery(java.lang.String validationQuery)Sets thevalidationQuery.voidsetValidationQueryTimeout(int validationQueryTimeoutSeconds)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.voidstart()Starts the datasource.protected voidstartPoolMaintenance()Starts the connection pool maintenance task, if configured.<T> Tunwrap(java.lang.Class<T> iface)protected static voidvalidateConnectionFactory(PoolableConnectionFactory connectionFactory)
 
- 
- 
- 
Method Detail- 
validateConnectionFactoryprotected static void validateConnectionFactory(PoolableConnectionFactory connectionFactory) throws java.lang.Exception - Throws:
- java.lang.Exception
 
 - 
addConnectionPropertypublic void addConnectionProperty(java.lang.String name, java.lang.String value)Adds a custom connection property to the set that will be passed to our JDBC driver. This MUST be called before the first connection is retrieved (along with all the other configuration property setters). Calls to this method after the connection pool has been initialized have no effect.- Parameters:
- name- Name of the custom connection property
- value- Value of the custom connection property
 
 - 
closepublic void close() throws java.sql.SQLExceptionCloses and releases all idle connections that are currently stored in the connection pool associated with this data source. Connections that are checked out to clients when this method is invoked are not affected. When client applications subsequently invoke Connection.close()to return these connections to the pool, the underlying JDBC connections are closed.Attempts to acquire connections using getConnection()after this method has been invoked result in SQLExceptions. To reopen a datasource that has been closed using this method, usestart().This method is idempotent - i.e., closing an already closed BasicDataSource has no effect and does not generate exceptions. - Specified by:
- closein interface- java.lang.AutoCloseable
- Throws:
- java.sql.SQLException- if an error occurs closing idle connections
 
 - 
createConnectionFactoryprotected ConnectionFactory createConnectionFactory() throws java.sql.SQLException Creates a JDBC connection factory for this data source. The JDBC driver is loaded using the following algorithm:- If a Driver instance has been specified via setDriver(Driver)use it
- If no Driver instance was specified and driverClassNameis specified that class is loaded using theClassLoaderof this class or, ifdriverClassLoaderis set,driverClassNameis loaded with the specifiedClassLoader.
- If driverClassNameis specified and the previous attempt fails, the class is loaded using the context class loader of the current thread.
- If a driver still isn't loaded one is loaded via the DriverManagerusing the specifiedurl.
 This method exists so subclasses can replace the implementation class. - Returns:
- A new connection factory.
- Throws:
- java.sql.SQLException- If the connection factory cannot be created
 
- If a Driver instance has been specified via 
 - 
createConnectionPoolprotected void createConnectionPool(PoolableConnectionFactory factory) Creates a connection pool for this datasource. This method only exists so subclasses can replace the implementation class.This implementation configures all pool properties other than timeBetweenEvictionRunsMillis. Setting that property is deferred to startPoolMaintenance(), since setting timeBetweenEvictionRunsMillis to a positive value causesGenericObjectPool's eviction timer to be started.- Parameters:
- factory- The factory to use to create new connections for this pool.
 
 - 
createDataSourceprotected javax.sql.DataSource createDataSource() throws java.sql.SQLExceptionCreates (if necessary) and return the internal data source we are using to manage our connections. - Returns:
- The current internal DataSource or a newly created instance if it has not yet been created.
- Throws:
- java.sql.SQLException- if the object pool cannot be created.
 
 - 
createDataSourceInstanceprotected javax.sql.DataSource createDataSourceInstance() throws java.sql.SQLExceptionCreates the actual data source instance. This method only exists so that subclasses can replace the implementation class.- Returns:
- A new DataSource instance
- Throws:
- java.sql.SQLException- if unable to create a datasource instance
 
 - 
createObjectPoolprotected GenericObjectPool<PoolableConnection> createObjectPool(PoolableConnectionFactory factory, GenericObjectPoolConfig<PoolableConnection> poolConfig, AbandonedConfig abandonedConfig) Creates an object pool used to provide pooling support forJDBC connections.- Parameters:
- factory- the object factory
- poolConfig- the object pool configuration
- abandonedConfig- the abandoned objects configuration
- Returns:
- a non-null instance
 
 - 
createPoolableConnectionFactoryprotected PoolableConnectionFactory createPoolableConnectionFactory(ConnectionFactory driverConnectionFactory) throws java.sql.SQLException Creates the PoolableConnectionFactory and attaches it to the connection pool. This method only exists so subclasses can replace the default implementation.- Parameters:
- driverConnectionFactory- JDBC connection factory
- Returns:
- A new PoolableConnectionFactory configured with the current configuration of this BasicDataSource
- Throws:
- java.sql.SQLException- if an error occurs creating the PoolableConnectionFactory
 
 - 
evictpublic void evict() throws java.lang.ExceptionManually evicts idle connections- Throws:
- java.lang.Exception- when there is a problem evicting idle objects.
 
 - 
getAbandonedLogWriterpublic java.io.PrintWriter getAbandonedLogWriter() Gets the print writer used by this configuration to log information on abandoned objects.- Returns:
- The print writer used by this configuration to log information on abandoned objects.
 
 - 
getAbandonedUsageTrackingpublic boolean getAbandonedUsageTracking() If the connection pool implementsUsageTracking, 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?- Specified by:
- getAbandonedUsageTrackingin interface- DataSourceMXBean
- Returns:
- trueif usage tracking is enabled
 
 - 
getAutoCommitOnReturnpublic boolean getAutoCommitOnReturn() Returns the value of the flag that controls whether or not connections being returned to the pool will be checked and configured withConnection.setAutoCommit(true)if the auto commit setting isfalsewhen the connection is returned. It istrueby default.- Returns:
- Whether or not connections being returned to the pool will be checked and configured with auto-commit.
 
 - 
getCacheStatepublic boolean getCacheState() Returns the state caching flag.- Specified by:
- getCacheStatein interface- DataSourceMXBean
- Returns:
- the state caching flag
 
 - 
getConnectionpublic java.sql.Connection getConnection() throws java.sql.SQLExceptionCreates (if necessary) and return a connection to the database.- Specified by:
- getConnectionin interface- javax.sql.DataSource
- Returns:
- a database connection
- Throws:
- java.sql.SQLException- if a database access error occurs
 
 - 
getConnectionpublic java.sql.Connection getConnection(java.lang.String user, java.lang.String pass) throws java.sql.SQLExceptionBasicDataSource does NOT support this method.- Specified by:
- getConnectionin interface- javax.sql.DataSource
- Parameters:
- user- Database user on whose behalf the Connection is being made
- pass- The database user's password
- Returns:
- nothing - always throws UnsupportedOperationException
- Throws:
- java.lang.UnsupportedOperationException- always thrown.
- java.sql.SQLException- if a database access error occurs
 
 - 
getConnectionFactoryClassNamepublic java.lang.String getConnectionFactoryClassName() Returns the ConnectionFactoryClassName that has been configured for use by this pool.Note: This getter only returns the last value set by a call to setConnectionFactoryClassName(String).- Returns:
- the ConnectionFactoryClassName that has been configured for use by this pool.
- Since:
- 2.7.0
 
 - 
getConnectionInitSqlspublic java.util.List<java.lang.String> getConnectionInitSqls() Returns the list of SQL statements executed when a physical connection is first created. Returns an empty list if there are no initialization statements configured.- Returns:
- initialization SQL statements
 
 - 
getConnectionInitSqlsAsArraypublic java.lang.String[] getConnectionInitSqlsAsArray() Provides the same data asgetConnectionInitSqls()but in an array so it is accessible via JMX.- Specified by:
- getConnectionInitSqlsAsArrayin interface- DataSourceMXBean
- Returns:
- getConnectionInitSqlsAsArray().
 
 - 
getConnectionPoolprotected GenericObjectPool<PoolableConnection> getConnectionPool() 
 - 
getDefaultAutoCommitpublic java.lang.Boolean getDefaultAutoCommit() Returns the default auto-commit property.- Specified by:
- getDefaultAutoCommitin interface- DataSourceMXBean
- Returns:
- true if default auto-commit is enabled
 
 - 
getDefaultCatalogpublic java.lang.String getDefaultCatalog() Returns the default catalog.- Specified by:
- getDefaultCatalogin interface- DataSourceMXBean
- Returns:
- the default catalog
 
 - 
getDefaultQueryTimeoutpublic java.lang.Integer getDefaultQueryTimeout() Gets the default query timeout that will be used forStatements created from this connection.nullmeans that the driver default will be used.- Returns:
- The default query timeout in seconds.
 
 - 
getDefaultReadOnlypublic java.lang.Boolean getDefaultReadOnly() Returns the default readOnly property.- Specified by:
- getDefaultReadOnlyin interface- DataSourceMXBean
- Returns:
- true if connections are readOnly by default
 
 - 
getDefaultSchemapublic java.lang.String getDefaultSchema() Returns the default schema.- Specified by:
- getDefaultSchemain interface- DataSourceMXBean
- Returns:
- the default schema.
- Since:
- 2.5.0
 
 - 
getDefaultTransactionIsolationpublic int getDefaultTransactionIsolation() Returns the default transaction isolation state of returned connections.- Specified by:
- getDefaultTransactionIsolationin interface- DataSourceMXBean
- Returns:
- the default value for transaction isolation state
- See Also:
- Connection.getTransactionIsolation()
 
 - 
getDisconnectionSqlCodespublic java.util.Set<java.lang.String> getDisconnectionSqlCodes() Returns the set of SQL_STATE codes considered to signal fatal conditions.- Returns:
- fatal disconnection state codes
- Since:
- 2.1
- See Also:
- setDisconnectionSqlCodes(Collection)
 
 - 
getDisconnectionSqlCodesAsArraypublic java.lang.String[] getDisconnectionSqlCodesAsArray() Provides the same data asgetDisconnectionSqlCodes()but in an array so it is accessible via JMX.- Specified by:
- getDisconnectionSqlCodesAsArrayin interface- DataSourceMXBean
- Returns:
- getDisconnectionSqlCodesAsArray().
- Since:
- 2.1
 
 - 
getDriverpublic java.sql.Driver getDriver() Returns the JDBC Driver that has been configured for use by this pool.Note: This getter only returns the last value set by a call to setDriver(Driver). It does not return any driver instance that may have been created from the value set viasetDriverClassName(String).- Returns:
- the JDBC Driver that has been configured for use by this pool
 
 - 
getDriverClassLoaderpublic java.lang.ClassLoader getDriverClassLoader() Returns the class loader specified for loading the JDBC driver. Returnsnullif no class loader has been explicitly specified.Note: This getter only returns the last value set by a call to setDriverClassLoader(ClassLoader). It does not return the class loader of any driver that may have been set viasetDriver(Driver).- Returns:
- The class loader specified for loading the JDBC driver.
 
 - 
getDriverClassNamepublic java.lang.String getDriverClassName() Returns the JDBC driver class name.Note: This getter only returns the last value set by a call to setDriverClassName(String). It does not return the class name of any driver that may have been set viasetDriver(Driver).- Specified by:
- getDriverClassNamein interface- DataSourceMXBean
- Returns:
- the JDBC driver class name
 
 - 
getEnableAutoCommitOnReturn@Deprecated public boolean getEnableAutoCommitOnReturn() Deprecated.Returns the value of the flag that controls whether or not connections being returned to the pool will be checked and configured withConnection.setAutoCommit(true)if the auto commit setting isfalsewhen the connection is returned. It istrueby default.- Returns:
- Whether or not connections being returned to the pool will be checked and configured with auto-commit.
 
 - 
getEvictionPolicyClassNamepublic java.lang.String getEvictionPolicyClassName() Gets the EvictionPolicy implementation in use with this connection pool.- Returns:
- The EvictionPolicy implementation in use with this connection pool.
 
 - 
getFastFailValidationpublic boolean getFastFailValidation() True means that validation will fail immediately for connections that have previously thrown SQLExceptions with SQL_STATE indicating fatal disconnection errors.- Specified by:
- getFastFailValidationin interface- DataSourceMXBean
- Returns:
- true if connections created by this datasource will fast fail validation.
- Since:
- 2.1
- See Also:
- setDisconnectionSqlCodes(Collection)
 
 - 
getInitialSizepublic int getInitialSize() Returns the initial size of the connection pool.- Specified by:
- getInitialSizein interface- DataSourceMXBean
- Returns:
- the number of connections created when the pool is initialized
 
 - 
getJmxNamepublic java.lang.String getJmxName() Returns the JMX name that has been requested for this DataSource. If the requested name is not valid, an alternative may be chosen.- Returns:
- The JMX name that has been requested for this DataSource.
 
 - 
getLifopublic boolean getLifo() Returns the LIFO property.- Specified by:
- getLifoin interface- DataSourceMXBean
- Returns:
- true if connection pool behaves as a LIFO queue.
 
 - 
getLogAbandonedpublic boolean getLogAbandoned() Flag to log stack traces for application code which abandoned a Statement or Connection. Defaults to false. Logging of abandoned Statements and Connections adds overhead for every Connection open or new Statement because a stack trace has to be generated. - Specified by:
- getLogAbandonedin interface- DataSourceMXBean
- Returns:
- getLogAbandoned().
 
 - 
getLogExpiredConnectionspublic boolean getLogExpiredConnections() WhengetMaxConnLifetimeMillis()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.- Specified by:
- getLogExpiredConnectionsin interface- DataSourceMXBean
- Returns:
- getLogExpiredConnections().
- Since:
- 2.1
 
 - 
getLoginTimeoutpublic int getLoginTimeout() throws java.sql.SQLExceptionBasicDataSource does NOT support this method.Returns the login timeout (in seconds) for connecting to the database. Calls createDataSource(), so has the side effect of initializing the connection pool.- Specified by:
- getLoginTimeoutin interface- javax.sql.CommonDataSource
- Specified by:
- getLoginTimeoutin interface- javax.sql.DataSource
- Returns:
- login timeout in seconds
- Throws:
- java.sql.SQLException- if a database access error occurs
- java.lang.UnsupportedOperationException- If the DataSource implementation does not support the login timeout feature.
 
 - 
getLogWriterpublic java.io.PrintWriter getLogWriter() throws java.sql.SQLExceptionReturns the log writer being used by this data source. Calls createDataSource(), so has the side effect of initializing the connection pool.- Specified by:
- getLogWriterin interface- javax.sql.CommonDataSource
- Specified by:
- getLogWriterin interface- javax.sql.DataSource
- Returns:
- log writer in use
- Throws:
- java.sql.SQLException- if a database access error occurs
 
 - 
getMaxConnLifetimeMillispublic long getMaxConnLifetimeMillis() Returns the maximum permitted lifetime of a connection in milliseconds. A value of zero or less indicates an infinite lifetime.- Specified by:
- getMaxConnLifetimeMillisin interface- DataSourceMXBean
- Returns:
- getMaxConnLifetimeMillis().
 
 - 
getMaxIdlepublic int getMaxIdle() Returns the maximum number of connections that can remain idle in the pool. Excess idle connections are destroyed on return to the pool. A negative value indicates that there is no limit - Specified by:
- getMaxIdlein interface- DataSourceMXBean
- Returns:
- the maximum number of idle connections
 
 - 
getMaxOpenPreparedStatementspublic int getMaxOpenPreparedStatements() Gets the value of themaxOpenPreparedStatementsproperty.- Specified by:
- getMaxOpenPreparedStatementsin interface- DataSourceMXBean
- Returns:
- the maximum number of open statements
 
 - 
getMaxTotalpublic int getMaxTotal() Returns the maximum number of active connections that can be allocated at the same time. A negative number means that there is no limit. - Specified by:
- getMaxTotalin interface- DataSourceMXBean
- Returns:
- the maximum number of active connections
 
 - 
getMaxWaitMillispublic long getMaxWaitMillis() Returns the maximum number of milliseconds that the pool will wait for a connection to be returned before throwing an exception. A value less than or equal to zero means the pool is set to wait indefinitely.- Specified by:
- getMaxWaitMillisin interface- DataSourceMXBean
- Returns:
- the maxWaitMillis property value
 
 - 
getMinEvictableIdleTimeMillispublic long getMinEvictableIdleTimeMillis() Returns theminEvictableIdleTimeMillisproperty.- Specified by:
- getMinEvictableIdleTimeMillisin interface- DataSourceMXBean
- Returns:
- the value of the minEvictableIdleTimeMillisproperty
- See Also:
- minEvictableIdleTimeMillis
 
 - 
getMinIdlepublic int getMinIdle() Returns 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 unlesstimeBetweenEvictionRunsMillishas a positive value.- Specified by:
- getMinIdlein interface- DataSourceMXBean
- Returns:
- the minimum number of idle connections
- See Also:
- GenericObjectPool.getMinIdle()
 
 - 
getNumActivepublic int getNumActive() [Read Only] The current number of active connections that have been allocated from this data source.- Specified by:
- getNumActivein interface- DataSourceMXBean
- Returns:
- the current number of active connections
 
 - 
getNumIdlepublic int getNumIdle() [Read Only] The current number of idle connections that are waiting to be allocated from this data source.- Specified by:
- getNumIdlein interface- DataSourceMXBean
- Returns:
- the current number of idle connections
 
 - 
getNumTestsPerEvictionRunpublic int getNumTestsPerEvictionRun() Returns the value of thenumTestsPerEvictionRunproperty.- Specified by:
- getNumTestsPerEvictionRunin interface- DataSourceMXBean
- Returns:
- the number of objects to examine during idle object evictor runs
- See Also:
- numTestsPerEvictionRun
 
 - 
getParentLoggerpublic java.util.logging.Logger getParentLogger() throws java.sql.SQLFeatureNotSupportedException- Specified by:
- getParentLoggerin interface- javax.sql.CommonDataSource
- Throws:
- java.sql.SQLFeatureNotSupportedException
 
 - 
getPasswordpublic java.lang.String getPassword() Returns the password passed to the JDBC driver to establish connections.- Specified by:
- getPasswordin interface- BasicDataSourceMXBean
- Returns:
- the connection password
 
 - 
getRegisteredJmxNameprotected javax.management.ObjectName getRegisteredJmxName() 
 - 
getRemoveAbandonedOnBorrowpublic boolean getRemoveAbandonedOnBorrow() Flag to remove abandoned connections if they exceed the removeAbandonedTimeout when borrowObject is invoked. The default value is false. If set to true a connection is considered abandoned and eligible for removal if it has not been used for more than removeAbandonedTimeoutseconds.Abandoned connections are identified and removed when getConnection()is invoked and all of the following conditions hold:- Specified by:
- getRemoveAbandonedOnBorrowin interface- DataSourceMXBean
- Returns:
- getRemoveAbandonedOnBorrow().
- See Also:
- getRemoveAbandonedTimeout()
 
 - 
getRemoveAbandonedOnMaintenancepublic boolean getRemoveAbandonedOnMaintenance() Flag to remove abandoned connections if they exceed the removeAbandonedTimeout during pool maintenance. The default value is false. If set to true a connection is considered abandoned and eligible for removal if it has not been used for more than removeAbandonedTimeoutseconds.- Specified by:
- getRemoveAbandonedOnMaintenancein interface- DataSourceMXBean
- Returns:
- getRemoveAbandonedOnMaintenance().
- See Also:
- getRemoveAbandonedTimeout()
 
 - 
getRemoveAbandonedTimeoutpublic int getRemoveAbandonedTimeout() Timeout in seconds before an abandoned connection can be removed. Creating a Statement, PreparedStatement or CallableStatement or using one of these to execute a query (using one of the execute methods) resets the lastUsed property of the parent connection. Abandoned connection cleanup happens when: - getRemoveAbandonedOnBorrow()or- getRemoveAbandonedOnMaintenance()= true
- numIdle< 2
- numActive>- maxTotal- 3
 The default value is 300 seconds. - Specified by:
- getRemoveAbandonedTimeoutin interface- DataSourceMXBean
- Returns:
- getRemoveAbandonedTimeout().
 
 - 
getRollbackOnReturnpublic boolean getRollbackOnReturn() 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.- Returns:
- whether a connection will be rolled back when it is returned to the pool.
 
 - 
getSoftMinEvictableIdleTimeMillispublic long getSoftMinEvictableIdleTimeMillis() Returns the minimum amount of time a connection may sit idle in the pool before it is eligible for eviction by the idle object evictor, with the extra condition that at least "minIdle" connections remain in the pool. When minEvictableIdleTimeMillisis 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 againstminEvictableIdleTimeMillis(without considering the number of idle connections in the pool) and then againstsoftMinEvictableIdleTimeMillis, including theminIdle, constraint.- Specified by:
- getSoftMinEvictableIdleTimeMillisin interface- DataSourceMXBean
- Returns:
- 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
 
 - 
getTestOnBorrowpublic boolean getTestOnBorrow() Returns thetestOnBorrowproperty.- Specified by:
- getTestOnBorrowin interface- DataSourceMXBean
- Returns:
- true if objects are validated before being borrowed from the pool
- See Also:
- testOnBorrow
 
 - 
getTestOnCreatepublic boolean getTestOnCreate() Returns thetestOnCreateproperty.- Specified by:
- getTestOnCreatein interface- DataSourceMXBean
- Returns:
- true if objects are validated immediately after they are created by the pool
- See Also:
- testOnCreate
 
 - 
getTestOnReturnpublic boolean getTestOnReturn() Returns the value of thetestOnReturnproperty.- Returns:
- true if objects are validated before being returned to the pool
- See Also:
- testOnReturn
 
 - 
getTestWhileIdlepublic boolean getTestWhileIdle() Returns the value of thetestWhileIdleproperty.- Specified by:
- getTestWhileIdlein interface- DataSourceMXBean
- Returns:
- true if objects examined by the idle object evictor are validated
- See Also:
- testWhileIdle
 
 - 
getTimeBetweenEvictionRunsMillispublic long getTimeBetweenEvictionRunsMillis() Returns the value of thetimeBetweenEvictionRunsMillisproperty.- Specified by:
- getTimeBetweenEvictionRunsMillisin interface- DataSourceMXBean
- Returns:
- the time (in milliseconds) between evictor runs
- See Also:
- timeBetweenEvictionRunsMillis
 
 - 
getUrlpublic java.lang.String getUrl() Returns the JDBC connectionurlproperty.- Specified by:
- getUrlin interface- DataSourceMXBean
- Returns:
- the urlpassed to the JDBC driver to establish connections
 
 - 
getUsernamepublic java.lang.String getUsername() Returns the JDBC connectionuserNameproperty.- Specified by:
- getUsernamein interface- DataSourceMXBean
- Returns:
- the userNamepassed to the JDBC driver to establish connections
 
 - 
getValidationQuerypublic java.lang.String getValidationQuery() Returns the validation query used to validate connections before returning them.- Specified by:
- getValidationQueryin interface- DataSourceMXBean
- Returns:
- the SQL validation query
- See Also:
- validationQuery
 
 - 
getValidationQueryTimeoutpublic int getValidationQueryTimeout() Returns the validation query timeout.- Specified by:
- getValidationQueryTimeoutin interface- DataSourceMXBean
- Returns:
- the timeout in seconds before connection validation queries fail.
 
 - 
invalidateConnectionpublic void invalidateConnection(java.sql.Connection connection) throws java.lang.IllegalStateExceptionManually invalidates a connection, effectively requesting the pool to try to close it, remove it from the pool and reclaim pool capacity.- Parameters:
- connection- The Connection to invalidate.
- Throws:
- java.lang.IllegalStateException- if invalidating the connection failed.
- Since:
- 2.1
 
 - 
isAccessToUnderlyingConnectionAllowedpublic boolean isAccessToUnderlyingConnectionAllowed() Returns the value of the accessToUnderlyingConnectionAllowed property.- Specified by:
- isAccessToUnderlyingConnectionAllowedin interface- DataSourceMXBean
- Returns:
- true if access to the underlying connection is allowed, false otherwise.
 
 - 
isClearStatementPoolOnReturnpublic boolean isClearStatementPoolOnReturn() Returns true if the statement pool is cleared when the connection is returned to its pool.- Specified by:
- isClearStatementPoolOnReturnin interface- DataSourceMXBean
- Returns:
- true if the statement pool is cleared at connection return
- Since:
- 2.8.0
 
 - 
isClosedpublic boolean isClosed() If true, this data source is closed and no more connections can be retrieved from this data source.- Specified by:
- isClosedin interface- DataSourceMXBean
- Returns:
- true, if the data source is closed; false otherwise
 
 - 
isPoolPreparedStatementspublic boolean isPoolPreparedStatements() Returns true if we are pooling statements.- Specified by:
- isPoolPreparedStatementsin interface- DataSourceMXBean
- Returns:
- true if prepared and callable statements are pooled
 
 - 
isWrapperForpublic boolean isWrapperFor(java.lang.Class<?> iface) throws java.sql.SQLException- Specified by:
- isWrapperForin interface- java.sql.Wrapper
- Throws:
- java.sql.SQLException
 
 - 
logprotected void log(java.lang.String message) 
 - 
logprotected void log(java.lang.String message, java.lang.Throwable throwable)Logs the given throwable.- Parameters:
- message- TODO
- throwable- the throwable.
- Since:
- 2.7.0
 
 - 
postDeregisterpublic void postDeregister() - Specified by:
- postDeregisterin interface- javax.management.MBeanRegistration
 
 - 
postRegisterpublic void postRegister(java.lang.Boolean registrationDone) - Specified by:
- postRegisterin interface- javax.management.MBeanRegistration
 
 - 
preDeregisterpublic void preDeregister() throws java.lang.Exception- Specified by:
- preDeregisterin interface- javax.management.MBeanRegistration
- Throws:
- java.lang.Exception
 
 - 
preRegisterpublic javax.management.ObjectName preRegister(javax.management.MBeanServer server, javax.management.ObjectName objectName)- Specified by:
- preRegisterin interface- javax.management.MBeanRegistration
 
 - 
removeConnectionPropertypublic void removeConnectionProperty(java.lang.String name) Removes a custom connection property.- Parameters:
- name- Name of the custom connection property to remove
- See Also:
- addConnectionProperty(String, String)
 
 - 
restartpublic void restart() throws java.sql.SQLExceptionRestarts the datasource.This method calls close()andstart()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.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 Connection.close()to return these connections to the pool, the underlying JDBC connections are closed. These connections do not count ingetMaxTotal()orgetNumActive()after invoking this method. For example, if there are 3 connections checked out by clients whenrestart()is invoked, after this method is called,getNumActive()will return 0 and up togetMaxTotal()+ 3 connections may be open until the connections sourced from the original pool are returned.The new connection pool created by this method is initialized with currently set configuration properties. - Specified by:
- restartin interface- DataSourceMXBean
- Throws:
- java.sql.SQLException- if an error occurs initializing the datasource
 
 - 
setAbandonedLogWriterpublic void setAbandonedLogWriter(java.io.PrintWriter logWriter) Sets the print writer to be used by this configuration to log information on abandoned objects.- Parameters:
- logWriter- The new log writer
 
 - 
setAbandonedUsageTrackingpublic void setAbandonedUsageTracking(boolean usageTracking) If the connection pool implementsUsageTracking, 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.- Parameters:
- usageTracking- A value of- truewill enable the recording of a stack trace on every use of a pooled connection
 
 - 
setAccessToUnderlyingConnectionAllowedpublic void setAccessToUnderlyingConnectionAllowed(boolean allow) Sets the value of the accessToUnderlyingConnectionAllowed property. It controls if the PoolGuard allows access to the underlying connection. (Default: false) Note: this method currently has no effect once the pool has been initialized. The pool is initialized the first time one of the following methods is invoked: getConnection, setLogwriter, setLoginTimeout, getLoginTimeout, getLogWriter.- Parameters:
- allow- Access to the underlying connection is granted when true.
 
 - 
setAutoCommitOnReturnpublic void setAutoCommitOnReturn(boolean autoCommitOnReturn) Sets the value of the flag that controls whether or not connections being returned to the pool will be checked and configured withConnection.setAutoCommit(true)if the auto commit setting isfalsewhen the connection is returned. It istrueby default.- Parameters:
- autoCommitOnReturn- Whether or not connections being returned to the pool will be checked and configured with auto-commit.
- Since:
- 2.6.0
 
 - 
setCacheStatepublic void setCacheState(boolean cacheState) Sets the state caching flag.- Parameters:
- cacheState- The new value for the state caching flag
 
 - 
setClearStatementPoolOnReturnpublic void setClearStatementPoolOnReturn(boolean clearStatementPoolOnReturn) Sets whether the pool of statements (which was enabled withsetPoolPreparedStatements(boolean)) should be cleared when the connection is returned to its pool. Default is false.- Parameters:
- clearStatementPoolOnReturn- clear or not
- Since:
- 2.8.0
 
 - 
setConnectionFactoryClassNamepublic void setConnectionFactoryClassName(java.lang.String connectionFactoryClassName) Sets the ConnectionFactory class name.- Parameters:
- connectionFactoryClassName- A class name.
- Since:
- 2.7.0
 
 - 
setConnectionInitSqlspublic void setConnectionInitSqls(java.util.Collection<java.lang.String> connectionInitSqls) Sets the list of SQL statements to be executed when a physical connection is first created.Note: this method currently has no effect once the pool has been initialized. The pool is initialized the first time one of the following methods is invoked: getConnection, setLogwriter, setLoginTimeout, getLoginTimeout, getLogWriter.- Parameters:
- connectionInitSqls- Collection of SQL statements to execute on connection creation
 
 - 
setConnectionPropertiespublic void setConnectionProperties(java.lang.String connectionProperties) Sets the connection properties passed to driver.connect(...).Format of the string must be [propertyName=property;]* NOTE - The "user" and "password" properties will be added explicitly, so they do not need to be included here. - Parameters:
- connectionProperties- the connection properties used to create new connections
 
 - 
setDefaultAutoCommitpublic void setDefaultAutoCommit(java.lang.Boolean defaultAutoCommit) Sets default auto-commit state of connections returned by this datasource. Note: this method currently has no effect once the pool has been initialized. The pool is initialized the first time one of the following methods is invoked: getConnection, setLogwriter, setLoginTimeout, getLoginTimeout, getLogWriter.- Parameters:
- defaultAutoCommit- default auto-commit value
 
 - 
setDefaultCatalogpublic void setDefaultCatalog(java.lang.String defaultCatalog) Sets the default catalog. Note: this method currently has no effect once the pool has been initialized. The pool is initialized the first time one of the following methods is invoked: getConnection, setLogwriter, setLoginTimeout, getLoginTimeout, getLogWriter.- Parameters:
- defaultCatalog- the default catalog
 
 - 
setDefaultQueryTimeoutpublic void setDefaultQueryTimeout(java.lang.Integer defaultQueryTimeoutSeconds) Sets the default query timeout that will be used forStatements created from this connection.nullmeans that the driver default will be used.- Parameters:
- defaultQueryTimeoutSeconds- The default query timeout in seconds.
 
 - 
setDefaultReadOnlypublic void setDefaultReadOnly(java.lang.Boolean defaultReadOnly) Sets defaultReadonly property. Note: this method currently has no effect once the pool has been initialized. The pool is initialized the first time one of the following methods is invoked: getConnection, setLogwriter, setLoginTimeout, getLoginTimeout, getLogWriter.- Parameters:
- defaultReadOnly- default read-only value
 
 - 
setDefaultSchemapublic void setDefaultSchema(java.lang.String defaultSchema) Sets the default schema. 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:
- defaultSchema- the default catalog
- Since:
- 2.5.0
 
 - 
setDefaultTransactionIsolationpublic void setDefaultTransactionIsolation(int defaultTransactionIsolation) Sets the default transaction isolation state for returned connections. Note: this method currently has no effect once the pool has been initialized. The pool is initialized the first time one of the following methods is invoked: getConnection, setLogwriter, setLoginTimeout, getLoginTimeout, getLogWriter.- Parameters:
- defaultTransactionIsolation- the default transaction isolation state
- See Also:
- Connection.getTransactionIsolation()
 
 - 
setDisconnectionSqlCodespublic void setDisconnectionSqlCodes(java.util.Collection<java.lang.String> disconnectionSqlCodes) Sets the SQL_STATE codes considered to signal fatal conditions.Overrides the defaults in Utils.DISCONNECTION_SQL_CODES(plus anything starting withUtils.DISCONNECTION_SQL_CODE_PREFIX). If this property is non-null andgetFastFailValidation()istrue, whenever connections created by this datasource generate exceptions with SQL_STATE codes in this list, they will be marked as "fatally disconnected" and subsequent validations will fail fast (no attempt at isValid or validation query).If getFastFailValidation()isfalsesetting this property has no effect.Note: this method currently has no effect once the pool has been initialized. The pool is initialized the first time one of the following methods is invoked: getConnection, setLogwriter, setLoginTimeout, getLoginTimeout, getLogWriter.- Parameters:
- disconnectionSqlCodes- SQL_STATE codes considered to signal fatal conditions
- Since:
- 2.1
 
 - 
setDriverpublic void setDriver(java.sql.Driver driver) Sets the JDBC Driver instance to use for this pool.Note: this method currently has no effect once the pool has been initialized. The pool is initialized the first time one of the following methods is invoked: getConnection, setLogwriter, setLoginTimeout, getLoginTimeout, getLogWriter.- Parameters:
- driver- The JDBC Driver instance to use for this pool.
 
 - 
setDriverClassLoaderpublic void setDriverClassLoader(java.lang.ClassLoader driverClassLoader) Sets the class loader to be used to load the JDBC driver. Note: this method currently has no effect once the pool has been initialized. The pool is initialized the first time one of the following methods is invoked: getConnection, setLogwriter, setLoginTimeout, getLoginTimeout, getLogWriter.- Parameters:
- driverClassLoader- the class loader with which to load the JDBC driver
 
 - 
setDriverClassNamepublic void setDriverClassName(java.lang.String driverClassName) Sets the JDBC driver class name. Note: this method currently has no effect once the pool has been initialized. The pool is initialized the first time one of the following methods is invoked: getConnection, setLogwriter, setLoginTimeout, getLoginTimeout, getLogWriter.- Parameters:
- driverClassName- the class name of the JDBC driver
 
 - 
setEnableAutoCommitOnReturn@Deprecated public void setEnableAutoCommitOnReturn(boolean autoCommitOnReturn) Deprecated.Sets the value of the flag that controls whether or not connections being returned to the pool will be checked and configured withConnection.setAutoCommit(true)if the auto commit setting isfalsewhen the connection is returned. It istrueby default.- Parameters:
- autoCommitOnReturn- Whether or not connections being returned to the pool will be checked and configured with auto-commit.
 
 - 
setEvictionPolicyClassNamepublic void setEvictionPolicyClassName(java.lang.String evictionPolicyClassName) Sets the EvictionPolicy implementation to use with this connection pool.- Parameters:
- evictionPolicyClassName- The fully qualified class name of the EvictionPolicy implementation
 
 - 
setFastFailValidationpublic void setFastFailValidation(boolean fastFailValidation) - Parameters:
- fastFailValidation- true means connections created by this factory will fast fail validation
- Since:
- 2.1
- See Also:
- getFastFailValidation()
 
 - 
setInitialSizepublic void setInitialSize(int initialSize) Sets the initial size of the connection pool. Note: this method currently has no effect once the pool has been initialized. The pool is initialized the first time one of the following methods is invoked: getConnection, setLogwriter, setLoginTimeout, getLoginTimeout, getLogWriter.- Parameters:
- initialSize- the number of connections created when the pool is initialized
 
 - 
setJmxNamepublic void setJmxName(java.lang.String jmxName) 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.- Parameters:
- jmxName- The JMX name that has been requested for this DataSource
 
 - 
setLifopublic void setLifo(boolean lifo) Sets the LIFO property. True means the pool behaves as a LIFO queue; false means FIFO.- Parameters:
- lifo- the new value for the LIFO property
 
 - 
setLogAbandonedpublic void setLogAbandoned(boolean logAbandoned) - Parameters:
- logAbandoned- new logAbandoned property value
 
 - 
setLogExpiredConnectionspublic void setLogExpiredConnections(boolean logExpiredConnections) WhengetMaxConnLifetimeMillis()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.- Parameters:
- logExpiredConnections- Whether or not log messages are generated when the pool closes connections due to maximum lifetime exceeded.
 
 - 
setLoginTimeoutpublic void setLoginTimeout(int loginTimeout) throws java.sql.SQLExceptionBasicDataSource does NOT support this method.Set the login timeout (in seconds) for connecting to the database. Calls createDataSource(), so has the side effect of initializing the connection pool.- Specified by:
- setLoginTimeoutin interface- javax.sql.CommonDataSource
- Specified by:
- setLoginTimeoutin interface- javax.sql.DataSource
- Parameters:
- loginTimeout- The new login timeout, or zero for no timeout
- Throws:
- java.lang.UnsupportedOperationException- If the DataSource implementation does not support the login timeout feature.
- java.sql.SQLException- if a database access error occurs
 
 - 
setLogWriterpublic void setLogWriter(java.io.PrintWriter logWriter) throws java.sql.SQLExceptionSets the log writer being used by this data source. Calls createDataSource(), so has the side effect of initializing the connection pool.- Specified by:
- setLogWriterin interface- javax.sql.CommonDataSource
- Specified by:
- setLogWriterin interface- javax.sql.DataSource
- Parameters:
- logWriter- The new log writer
- Throws:
- java.sql.SQLException- if a database access error occurs
 
 - 
setMaxConnLifetimeMillispublic void setMaxConnLifetimeMillis(long maxConnLifetimeMillis) Sets the maximum permitted lifetime of a connection in milliseconds. A value of zero or less indicates an infinite lifetime. Note: this method currently has no effect once the pool has been initialized. The pool is initialized the first time one of the following methods is invoked: getConnection, setLogwriter, setLoginTimeout, getLoginTimeout, getLogWriter.- Parameters:
- maxConnLifetimeMillis- The maximum permitted lifetime of a connection in milliseconds.
 
 - 
setMaxIdlepublic void setMaxIdle(int maxIdle) Sets the maximum number of connections that can remain idle in the pool. Excess idle connections are destroyed on return to the pool.- Parameters:
- maxIdle- the new value for maxIdle
- See Also:
- getMaxIdle()
 
 - 
setMaxOpenPreparedStatementspublic void setMaxOpenPreparedStatements(int maxOpenStatements) Sets the value of the maxOpenPreparedStatementsproperty.Note: this method currently has no effect once the pool has been initialized. The pool is initialized the first time one of the following methods is invoked: getConnection, setLogwriter, setLoginTimeout, getLoginTimeout, getLogWriter.- Parameters:
- maxOpenStatements- the new maximum number of prepared statements
 
 - 
setMaxTotalpublic void setMaxTotal(int maxTotal) 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.- Parameters:
- maxTotal- the new value for maxTotal
- See Also:
- getMaxTotal()
 
 - 
setMaxWaitMillispublic void setMaxWaitMillis(long maxWaitMillis) Sets the MaxWaitMillis property. Use -1 to make the pool wait indefinitely.- Parameters:
- maxWaitMillis- the new value for MaxWaitMillis
- See Also:
- getMaxWaitMillis()
 
 - 
setMinEvictableIdleTimeMillispublic void setMinEvictableIdleTimeMillis(long minEvictableIdleTimeMillis) Sets theminEvictableIdleTimeMillisproperty.- Parameters:
- minEvictableIdleTimeMillis- the minimum amount of time an object may sit idle in the pool
- See Also:
- minEvictableIdleTimeMillis
 
 - 
setMinIdlepublic void setMinIdle(int minIdle) 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 unlesstimeBetweenEvictionRunsMillishas a positive value.- Parameters:
- minIdle- the new value for minIdle
- See Also:
- GenericObjectPool.setMinIdle(int)
 
 - 
setNumTestsPerEvictionRunpublic void setNumTestsPerEvictionRun(int numTestsPerEvictionRun) Sets the value of thenumTestsPerEvictionRunproperty.- Parameters:
- numTestsPerEvictionRun- the new- numTestsPerEvictionRunvalue
- See Also:
- numTestsPerEvictionRun
 
 - 
setPasswordpublic void setPassword(java.lang.String password) Sets the password.Note: this method currently has no effect once the pool has been initialized. The pool is initialized the first time one of the following methods is invoked: getConnection, setLogwriter, setLoginTimeout, getLoginTimeout, getLogWriter.- Parameters:
- password- new value for the password
 
 - 
setPoolPreparedStatementspublic void setPoolPreparedStatements(boolean poolingStatements) Sets whether to pool statements or not. Note: this method currently has no effect once the pool has been initialized. The pool is initialized the first time one of the following methods is invoked: getConnection, setLogwriter, setLoginTimeout, getLoginTimeout, getLogWriter.- Parameters:
- poolingStatements- pooling on or off
 
 - 
setRemoveAbandonedOnBorrowpublic void setRemoveAbandonedOnBorrow(boolean removeAbandonedOnBorrow) - Parameters:
- removeAbandonedOnBorrow- true means abandoned connections may be removed when connections are borrowed from the pool.
- See Also:
- getRemoveAbandonedOnBorrow()
 
 - 
setRemoveAbandonedOnMaintenancepublic void setRemoveAbandonedOnMaintenance(boolean removeAbandonedOnMaintenance) - Parameters:
- removeAbandonedOnMaintenance- true means abandoned connections may be removed on pool maintenance.
- See Also:
- getRemoveAbandonedOnMaintenance()
 
 - 
setRemoveAbandonedTimeoutpublic void setRemoveAbandonedTimeout(int removeAbandonedTimeout) Sets the timeout in seconds before an abandoned connection can be removed. Setting this property has no effect if getRemoveAbandonedOnBorrow()andgetRemoveAbandonedOnMaintenance()are false.- Parameters:
- removeAbandonedTimeout- new abandoned timeout in seconds
- See Also:
- getRemoveAbandonedTimeout(),- getRemoveAbandonedOnBorrow(),- getRemoveAbandonedOnMaintenance()
 
 - 
setRollbackOnReturnpublic void setRollbackOnReturn(boolean rollbackOnReturn) Sets the flag that controls if a connection will be rolled back when it is returned to the pool if auto commit is not enabled and the connection is not read only.- Parameters:
- rollbackOnReturn- whether a connection will be rolled back when it is returned to the pool.
 
 - 
setSoftMinEvictableIdleTimeMillispublic void setSoftMinEvictableIdleTimeMillis(long softMinEvictableIdleTimeMillis) Sets the minimum amount of time a connection may sit idle in the pool before it is eligible for eviction by the idle object evictor, with the extra condition that at least "minIdle" connections remain in the pool.- Parameters:
- 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 Also:
- getSoftMinEvictableIdleTimeMillis()
 
 - 
setTestOnBorrowpublic void setTestOnBorrow(boolean testOnBorrow) Sets thetestOnBorrowproperty. This property determines whether or not the pool will validate objects before they are borrowed from the pool.- Parameters:
- testOnBorrow- new value for testOnBorrow property
 
 - 
setTestOnCreatepublic void setTestOnCreate(boolean testOnCreate) Sets thetestOnCreateproperty. This property determines whether or not the pool will validate objects immediately after they are created by the pool- Parameters:
- testOnCreate- new value for testOnCreate property
 
 - 
setTestOnReturnpublic void setTestOnReturn(boolean testOnReturn) Sets thetestOnReturnproperty. This property determines whether or not the pool will validate objects before they are returned to the pool.- Parameters:
- testOnReturn- new value for testOnReturn property
 
 - 
setTestWhileIdlepublic void setTestWhileIdle(boolean testWhileIdle) Sets thetestWhileIdleproperty. This property determines whether or not the idle object evictor will validate connections.- Parameters:
- testWhileIdle- new value for testWhileIdle property
 
 - 
setTimeBetweenEvictionRunsMillispublic void setTimeBetweenEvictionRunsMillis(long timeBetweenEvictionRunsMillis) Sets thetimeBetweenEvictionRunsMillisproperty.- Parameters:
- timeBetweenEvictionRunsMillis- the new time between evictor runs
- See Also:
- timeBetweenEvictionRunsMillis
 
 - 
setUrlpublic void setUrl(java.lang.String url) Sets the url.Note: this method currently has no effect once the pool has been initialized. The pool is initialized the first time one of the following methods is invoked: getConnection, setLogwriter, setLoginTimeout, getLoginTimeout, getLogWriter.- Parameters:
- url- the new value for the JDBC connection url
 
 - 
setUsernamepublic void setUsername(java.lang.String userName) Sets the userName.Note: this method currently has no effect once the pool has been initialized. The pool is initialized the first time one of the following methods is invoked: getConnection, setLogwriter, setLoginTimeout, getLoginTimeout, getLogWriter.- Parameters:
- userName- the new value for the JDBC connection user name
 
 - 
setValidationQuerypublic void setValidationQuery(java.lang.String validationQuery) Sets the validationQuery.Note: this method currently has no effect once the pool has been initialized. The pool is initialized the first time one of the following methods is invoked: getConnection, setLogwriter, setLoginTimeout, getLoginTimeout, getLogWriter.- Parameters:
- validationQuery- the new value for the validation query
 
 - 
setValidationQueryTimeoutpublic void setValidationQueryTimeout(int validationQueryTimeoutSeconds) Sets the validation query timeout, the amount of time, in seconds, that connection validation will wait for a response from the database when executing a validation query. Use a value less than or equal to 0 for no timeout.Note: this method currently has no effect once the pool has been initialized. The pool is initialized the first time one of the following methods is invoked: getConnection, setLogwriter, setLoginTimeout, getLoginTimeout, getLogWriter.- Parameters:
- validationQueryTimeoutSeconds- new validation query timeout value in seconds
 
 - 
startpublic void start() throws java.sql.SQLExceptionStarts the datasource.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 getConnection()request). Its primary use is to restart and reinitialize a datasource that has been closed.When this method is called after close(), connections checked out by clients before the datasource was stopped do not count ingetMaxTotal()orgetNumActive(). For example, if there are 3 connections checked out by clients whenclose()is invoked and they are not returned beforestart()is invoked, after this method is called,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.- Specified by:
- startin interface- DataSourceMXBean
- Throws:
- java.sql.SQLException- if an error occurs initializing the datasource
 
 - 
startPoolMaintenanceprotected void startPoolMaintenance() Starts the connection pool maintenance task, if configured.
 - 
unwrappublic <T> T unwrap(java.lang.Class<T> iface) throws java.sql.SQLException- Specified by:
- unwrapin interface- java.sql.Wrapper
- Throws:
- java.sql.SQLException
 
 
- 
 
-