Java org.apache.commons.dbcp2 BasicDataSource fields, constructors, methods, implement or subclass

Introduction

In this page you can find the methods, fields and constructors for org.apache.commons.dbcp2 BasicDataSource.

The text is from its open source code.

Subclass

org.apache.commons.dbcp2.BasicDataSource has subclasses.
Click this link to see all its subclasses.

Constructor

	BasicDataSource

Method

void	addConnectionProperty(String name, String value) Add a custom connection property to the set that will be passed to our JDBC driver.
void	close() Closes and releases all idle connections that are currently stored in the connection pool associated with this data source. Connections that are checked out to clients when this method is invoked are not affected.
Class	getClass() Returns the runtime class of this Object .
Connection	getConnection() Create (if necessary) and return a connection to the database.
Integer	getDefaultQueryTimeout() Obtain the default query timeout that will be used for java.sql.Statement Statement s created from this connection.
Driver	getDriver() Returns the JDBC Driver that has been configured for use by this pool.
String	getDriverClassName() Returns the jdbc driver class name.
int	getInitialSize() Returns the initial size of the connection pool.
String	getJmxName() Returns the JMX name that has been requested for this DataSource.
long	getMaxConnLifetimeMillis() Returns the maximum permitted lifetime of a connection in milliseconds.
int	getMaxIdle() Returns the maximum number of connections that can remain idle in the pool.
int	getMaxTotal() Returns the maximum number of active connections that can be allocated at the same time.
long	getMinEvictableIdleTimeMillis() Returns the #minEvictableIdleTimeMillis property.
int	getMinIdle() Returns the minimum number of idle connections in the pool.
int	getNumActive() [Read Only] The current number of active connections that have been allocated from this data source.
int	getNumIdle() [Read Only] The current number of idle connections that are waiting to be allocated from this data source.
String	getPassword() Returns the password passed to the JDBC driver to establish connections.
String	getUrl() Returns the JDBC connection #url property.
String	getUsername() Returns the JDBC connection #username property.
String	getValidationQuery() Returns the validation query used to validate connections before returning them.
boolean	isPoolPreparedStatements() Returns true if we are pooling statements.
void	setAbandonedLogWriter(PrintWriter logWriter) Sets the log writer to be used by this configuration to log information on abandoned objects.
void	setAbandonedUsageTracking(boolean usageTracking) If the connection pool implements org.apache.commons.pool2.UsageTracking UsageTracking , configure whether the connection pool should record a stack trace every time a method is called on a pooled connection and retain the most recent stack trace to aid debugging of abandoned connections.
void	setAccessToUnderlyingConnectionAllowed(boolean allow) Sets the value of the accessToUnderlyingConnectionAllowed property.
void	setCacheState(boolean cacheState) Sets the state caching flag.
void	setConnectionInitSqls(Collection connectionInitSqls) Sets the list of SQL statements to be executed when a physical connection is first created.
void	setConnectionProperties(String connectionProperties) Sets the connection properties passed to driver.connect(...).
void	setDefaultAutoCommit(Boolean defaultAutoCommit) Sets default auto-commit state of connections returned by this datasource. Note: this method currently has no effect once the pool has been initialized.
void	setDefaultCatalog(String defaultCatalog) Sets the default catalog. Note: this method currently has no effect once the pool has been initialized.
void	setDefaultQueryTimeout(Integer defaultQueryTimeout) Set the default query timeout that will be used for java.sql.Statement Statement s created from this connection.
void	setDefaultReadOnly(Boolean defaultReadOnly) Sets defaultReadonly property. Note: this method currently has no effect once the pool has been initialized.
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.
void	setDisconnectionSqlCodes(Collection disconnectionSqlCodes) Sets the SQL_STATE codes considered to signal fatal conditions.
void	setDriver(Driver driver) Sets the JDBC Driver instance to use for this pool.
void	setDriverClassLoader(ClassLoader driverClassLoader) Sets the class loader to be used to load the JDBC driver. Note: this method currently has no effect once the pool has been initialized.
void	setDriverClassName(String driverClassName) Sets the jdbc driver class name. Note: this method currently has no effect once the pool has been initialized.
void	setEnableAutoCommitOnReturn(boolean enableAutoCommitOnReturn) Sets the value of the flag that controls whether or not connections being returned to the pool will be checked and configured with Connection#setAutoCommit(boolean) Connection.setAutoCommit(true) if the auto commit setting is false when the connection is returned.
void	setEvictionPolicyClassName(String evictionPolicyClassName) Sets the EvictionPolicy implementation to use with this connection pool.
void	setFastFailValidation(boolean fastFailValidation)
void	setInitialSize(int initialSize) Sets the initial size of the connection pool. Note: this method currently has no effect once the pool has been initialized.
void	setJmxName(String jmxName) Sets the JMX name that has been requested for this DataSource.
void	setLifo(boolean lifo) Sets the LIFO property.
void	setLogAbandoned(boolean logAbandoned)
void	setLogExpiredConnections(boolean logExpiredConnections) When #getMaxConnLifetimeMillis() is set to limit connection lifetime, this property determines whether or not log messages are generated when the pool closes connections due to maximum lifetime exceeded.
void	setLogWriter(PrintWriter logWriter) Sets the log writer being used by this data source. Calls #createDataSource() , so has the side effect of initializing the connection pool.
void	setMaxConnLifetimeMillis(long maxConnLifetimeMillis) Sets the maximum permitted lifetime of a connection in milliseconds.
void	setMaxIdle(int maxIdle) Sets the maximum number of connections that can remain idle in the pool.
void	setMaxOpenPreparedStatements(int maxOpenStatements) Sets the value of the `maxOpenPreparedStatements` property. Note: this method currently has no effect once the pool has been initialized.
void	setMaxTotal(int maxTotal) Sets the maximum total number of idle and borrows connections that can be active at the same time.
void	setMaxWaitMillis(long maxWaitMillis) Sets the MaxWaitMillis property.
void	setMinEvictableIdleTimeMillis(long minEvictableIdleTimeMillis) Sets the #minEvictableIdleTimeMillis property.
void	setMinIdle(int minIdle) Sets the minimum number of idle connections in the pool.
void	setNumTestsPerEvictionRun(int numTestsPerEvictionRun) Sets the value of the #numTestsPerEvictionRun property.
void	setPassword(String password) Sets the #password . Note: this method currently has no effect once the pool has been initialized.
void	setPoolPreparedStatements(boolean poolingStatements) Sets whether to pool statements or not. Note: this method currently has no effect once the pool has been initialized.
void	setRemoveAbandonedOnBorrow(boolean removeAbandonedOnBorrow)
void	setRemoveAbandonedOnMaintenance(boolean removeAbandonedOnMaintenance)
void	setRemoveAbandonedTimeout(int removeAbandonedTimeout) Sets the timeout in seconds before an abandoned connection can be removed. Setting this property has no effect if #getRemoveAbandonedOnBorrow() and #getRemoveAbandonedOnMaintenance() are false.
void	setRollbackOnReturn(boolean rollbackOnReturn) Sets the flag that controls if a connection will be rolled back when it is returned to the pool if auto commit is not enabled and the connection is not read only.
void	setSoftMinEvictableIdleTimeMillis(long softMinEvictableIdleTimeMillis) Sets the minimum amount of time a connection may sit idle in the pool before it is eligible for eviction by the idle object evictor, with the extra condition that at least "minIdle" connections remain in the pool.
void	setTestOnBorrow(boolean testOnBorrow) Sets the #testOnBorrow property.
void	setTestOnCreate(boolean testOnCreate) Sets the #testOnCreate property.
void	setTestOnReturn(boolean testOnReturn) Sets the `testOnReturn` property.
void	setTestWhileIdle(boolean testWhileIdle) Sets the `testWhileIdle` property.
void	setTimeBetweenEvictionRunsMillis(long timeBetweenEvictionRunsMillis) Sets the #timeBetweenEvictionRunsMillis property.
void	setUrl(String url) Sets the #url . Note: this method currently has no effect once the pool has been initialized.
void	setUsername(String username) Sets the #username . Note: this method currently has no effect once the pool has been initialized.
void	setValidationQuery(String validationQuery) Sets the #validationQuery . Note: this method currently has no effect once the pool has been initialized.
void	setValidationQueryTimeout(int timeout) Sets the validation query timeout, the amount of time, in seconds, that connection validation will wait for a response from the database when executing a validation query.
String	toString() Returns a string representation of the object.