BasicDataSource (DataNucleus RDBMS plugin 4.1.19-SNAPSHOT API)

java.lang.Object
- org.datanucleus.store.rdbms.datasource.dbcp.BasicDataSource

All Implemented Interfaces:

Wrapper, CommonDataSource, DataSource

Direct Known Subclasses:

BasicManagedDataSource
```
public class BasicDataSource
extends Object
implements DataSource
```
Basic implementation of javax.sql.DataSource that is configured via JavaBeans properties.

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`closed`
`protected List`	`connectionInitSqls` These SQL statements run once after a Connection is created.
`protected GenericObjectPool`	`connectionPool` The object pool that internally manages our connections.
`protected Properties`	`connectionProperties` The connection properties that will be sent to our JDBC driver when establishing new connections.
`protected DataSource`	`dataSource` The data source we will use to manage connections.
`protected boolean`	`defaultAutoCommit` The default auto-commit state of connections created by this pool.
`protected String`	`defaultCatalog` The default "catalog" of connections created by this pool.
`protected Boolean`	`defaultReadOnly` The default read-only state of connections created by this pool.
`protected int`	`defaultTransactionIsolation` The default TransactionIsolation state of connections created by this pool.
`protected ClassLoader`	`driverClassLoader`
`protected String`	`driverClassName` The fully qualified Java class name of the JDBC driver to be used.
`protected int`	`initialSize`
`protected PrintWriter`	`logWriter` The PrintWriter to which log messages should be directed.
`protected int`	`maxActive`
`protected int`	`maxIdle`
`protected int`	`maxOpenPreparedStatements` The maximum number of open statements that can be allocated from the statement pool at the same time, or non-positive for no limit.
`protected long`	`maxWait`
`protected long`	`minEvictableIdleTimeMillis` The minimum amount of time an object may sit idle in the pool before it is eligable for eviction by the idle object evictor (if any).
`protected int`	`minIdle`
`protected int`	`numTestsPerEvictionRun` The number of objects to examine during each run of the idle object evictor thread (if any).
`protected String`	`password` The connection password to be passed to our JDBC driver to establish a connection.
`protected boolean`	`poolPreparedStatements` Prepared statement pooling for this pool.
`protected boolean`	`testOnBorrow` The indication of whether objects will be validated before being borrowed from the pool.
`protected boolean`	`testOnReturn` The indication of whether objects will be validated before being returned to the pool.
`protected boolean`	`testWhileIdle` The indication of whether objects will be validated by the idle object evictor (if any).
`protected long`	`timeBetweenEvictionRunsMillis` The number of milliseconds to sleep between runs of the idle object evictor thread.
`protected String`	`url` The connection URL to be passed to our JDBC driver to establish a connection.
`protected String`	`username` The connection username to be passed to our JDBC driver to establish a connection.
`protected String`	`validationQuery` The SQL query that will be used to validate connections from this pool before returning them to the caller.
`protected int`	`validationQueryTimeout` Timeout in seconds before connection validation queries fail.

Constructor Summary

Constructors
Constructor and Description

BasicDataSource()

Constructors
Constructor and Description
`BasicDataSource()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addConnectionProperty(String name, String value)`
`void`	`close()`
`protected ConnectionFactory`	`createConnectionFactory()`
`protected void`	`createConnectionPool()`
`protected DataSource`	`createDataSource()`
`protected void`	`createDataSourceInstance()`
`protected void`	`createPoolableConnectionFactory(ConnectionFactory driverConnectionFactory, KeyedObjectPoolFactory statementPoolFactory, AbandonedConfig configuration)`
`Connection`	`getConnection()` Create (if necessary) and return a connection to the database.
`Connection`	`getConnection(String user, String pass)`
`Collection`	`getConnectionInitSqls()` Returns the list of SQL statements executed when a physical connection is first created.
`boolean`	`getDefaultAutoCommit()` Returns the default auto-commit property.
`String`	`getDefaultCatalog()` Returns the default catalog.
`boolean`	`getDefaultReadOnly()` Returns the default readOnly property.
`int`	`getDefaultTransactionIsolation()` Returns the default transaction isolation state of returned connections.
`ClassLoader`	`getDriverClassLoader()`
`String`	`getDriverClassName()` Returns the jdbc driver class name.
`int`	`getInitialSize()`
`boolean`	`getLogAbandoned()`
`int`	`getLoginTimeout()`
`PrintWriter`	`getLogWriter()`
`int`	`getMaxActive()`
`int`	`getMaxIdle()`
`int`	`getMaxOpenPreparedStatements()` Gets the value of the `maxOpenPreparedStatements` property.
`long`	`getMaxWait()` Returns the maximum number of milliseconds that the pool will wait for a connection to be returned before throwing an exception.
`long`	`getMinEvictableIdleTimeMillis()` Returns the `minEvictableIdleTimeMillis` property.
`int`	`getMinIdle()`
`int`	`getNumActive()` [Read Only] The current number of active connections that have been allocated from this data source.
`int`	`getNumIdle()` [Read Only] The current number of idle connections that are waiting to be allocated from this data source.
`int`	`getNumTestsPerEvictionRun()` Returns the value of the `numTestsPerEvictionRun` property.
`Logger`	`getParentLogger()`
`String`	`getPassword()` Returns the password passed to the JDBC driver to establish connections.
`boolean`	`getRemoveAbandoned()`
`int`	`getRemoveAbandonedTimeout()`
`boolean`	`getTestOnBorrow()` Returns the `testOnBorrow` property.
`boolean`	`getTestOnReturn()` Returns the value of the `testOnReturn` property.
`boolean`	`getTestWhileIdle()` Returns the value of the `testWhileIdle` property.
`long`	`getTimeBetweenEvictionRunsMillis()` Returns the value of the `timeBetweenEvictionRunsMillis` property.
`String`	`getUrl()` Returns the JDBC connection `url` property.
`String`	`getUsername()` Returns the JDBC connection `username` property.
`String`	`getValidationQuery()` Returns the validation query used to validate connections before returning them.
`int`	`getValidationQueryTimeout()` Returns the validation query timeout.
`boolean`	`isAccessToUnderlyingConnectionAllowed()` Returns the value of the accessToUnderlyingConnectionAllowed property.
`boolean`	`isClosed()`
`boolean`	`isPoolPreparedStatements()` Returns true if we are pooling statements.
`boolean`	`isWrapperFor(Class<?> iface)`
`protected void`	`log(String message)`
`void`	`removeConnectionProperty(String name)`
`void`	`setAccessToUnderlyingConnectionAllowed(boolean allow)` Sets the value of the accessToUnderlyingConnectionAllowed property.
`void`	`setConnectionInitSqls(Collection connectionInitSqls)` Sets the list of SQL statements to be executed when a physical connection is first created.
`void`	`setConnectionProperties(String connectionProperties)`
`void`	`setDefaultAutoCommit(boolean defaultAutoCommit)` Sets default auto-commit state of connections returned by this datasource.
`void`	`setDefaultCatalog(String defaultCatalog)` Sets the default catalog.
`void`	`setDefaultReadOnly(boolean defaultReadOnly)` Sets defaultReadonly property.
`void`	`setDefaultTransactionIsolation(int defaultTransactionIsolation)` Sets the default transaction isolation state for returned connections.
`void`	`setDriverClassLoader(ClassLoader driverClassLoader)`
`void`	`setDriverClassName(String driverClassName)` Sets the jdbc driver class name.
`void`	`setInitialSize(int initialSize)`
`void`	`setLogAbandoned(boolean logAbandoned)`
`void`	`setLoginTimeout(int loginTimeout)`
`void`	`setLogWriter(PrintWriter logWriter)`
`void`	`setMaxActive(int maxActive)`
`void`	`setMaxIdle(int maxIdle)`
`void`	`setMaxOpenPreparedStatements(int maxOpenStatements)` Sets the value of the `maxOpenPreparedStatements` property.
`void`	`setMaxWait(long maxWait)` Sets the maxWait property.
`void`	`setMinEvictableIdleTimeMillis(long minEvictableIdleTimeMillis)` Sets the `minEvictableIdleTimeMillis` property.
`void`	`setMinIdle(int minIdle)`
`void`	`setNumTestsPerEvictionRun(int numTestsPerEvictionRun)` Sets the value of the `numTestsPerEvictionRun` property.
`void`	`setPassword(String password)` Sets the `password`.
`void`	`setPoolPreparedStatements(boolean poolingStatements)` Sets whether to pool statements or not.
`void`	`setRemoveAbandoned(boolean removeAbandoned)`
`void`	`setRemoveAbandonedTimeout(int removeAbandonedTimeout)`
`void`	`setTestOnBorrow(boolean testOnBorrow)` Sets the `testOnBorrow` property.
`void`	`setTestOnReturn(boolean testOnReturn)` Sets the `testOnReturn` property.
`void`	`setTestWhileIdle(boolean testWhileIdle)` Sets the `testWhileIdle` property.
`void`	`setTimeBetweenEvictionRunsMillis(long timeBetweenEvictionRunsMillis)` Sets the `timeBetweenEvictionRunsMillis` property.
`void`	`setUrl(String url)` Sets the `url`.
`void`	`setUsername(String username)` Sets the `username`.
`void`	`setValidationQuery(String validationQuery)` Sets the `validationQuery`.
`void`	`setValidationQueryTimeout(int timeout)` Sets the validation query timeout, the amount of time, in seconds, that connection validation will wait for a response from the database when executing a validation query.
`<T> T`	`unwrap(Class<T> iface)`
`protected static void`	`validateConnectionFactory(PoolableConnectionFactory connectionFactory)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - defaultAutoCommit
```
protected volatile boolean defaultAutoCommit
```
    The default auto-commit state of connections created by this pool.
  - defaultReadOnly
```
protected transient Boolean defaultReadOnly
```
    The default read-only state of connections created by this pool.
  - defaultTransactionIsolation
```
protected volatile int defaultTransactionIsolation
```
    The default TransactionIsolation state of connections created by this pool.
  - defaultCatalog
```
protected volatile String defaultCatalog
```
    The default "catalog" of connections created by this pool.
  - driverClassName
```
protected String driverClassName
```
    The fully qualified Java class name of the JDBC driver to be used.
  - driverClassLoader
```
protected ClassLoader driverClassLoader
```
  - maxActive
```
protected int maxActive
```
  - maxIdle
```
protected int maxIdle
```
  - minIdle
```
protected int minIdle
```
  - initialSize
```
protected int initialSize
```
  - maxWait
```
protected long maxWait
```
  - poolPreparedStatements
```
protected boolean poolPreparedStatements
```
    Prepared statement pooling for this pool. When this property is set to true both PreparedStatements and CallableStatements are pooled.
  - maxOpenPreparedStatements
```
protected int maxOpenPreparedStatements
```
    The maximum number of open statements that can be allocated from the statement pool at the same time, or non-positive for no limit. Since a connection usually only uses one or two statements at a time, this is mostly used to help detect resource leaks.
    
    Note: As of version 1.3, CallableStatements (those produced by Connection.prepareCall(java.lang.String)) are pooled along with PreparedStatements (produced by Connection.prepareStatement(java.lang.String)) and maxOpenPreparedStatements limits the total number of prepared or callable statements that may be in use at a given time.
  - testOnBorrow
```
protected boolean testOnBorrow
```
    The indication of whether objects will be validated before being borrowed from the pool. If the object fails to validate, it will be dropped from the pool, and we will attempt to borrow another.
  - testOnReturn
```
protected boolean testOnReturn
```
    The indication of whether objects will be validated before being returned to the pool.
  - timeBetweenEvictionRunsMillis
```
protected long timeBetweenEvictionRunsMillis
```
    The number of milliseconds to sleep between runs of the idle object evictor thread. When non-positive, no idle object evictor thread will be run.
  - numTestsPerEvictionRun
```
protected int numTestsPerEvictionRun
```
    The number of objects to examine during each run of the idle object evictor thread (if any).
  - minEvictableIdleTimeMillis
```
protected long minEvictableIdleTimeMillis
```
    The minimum amount of time an object may sit idle in the pool before it is eligable for eviction by the idle object evictor (if any).
  - testWhileIdle
```
protected boolean testWhileIdle
```
    The indication of whether objects will be validated by the idle object evictor (if any). If an object fails to validate, it will be dropped from the pool.
  - password
```
protected volatile String password
```
    The connection password to be passed to our JDBC driver to establish a connection.
  - url
```
protected String url
```
    The connection URL to be passed to our JDBC driver to establish a connection.
  - username
```
protected String username
```
    The connection username to be passed to our JDBC driver to establish a connection.
  - validationQuery
```
protected volatile String validationQuery
```
    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.
  - validationQueryTimeout
```
protected volatile int validationQueryTimeout
```
    Timeout in seconds before connection validation queries fail.
    
    Since:
    
    1.3
  - connectionInitSqls
```
protected volatile List connectionInitSqls
```
    These SQL statements run once after a Connection is created.
    This property can be used for example to run ALTER SESSION SET NLS_SORT=XCYECH in an Oracle Database only once after connection creation.
    
    Since:
    
    1.3
  - connectionPool
```
protected volatile GenericObjectPool connectionPool
```
    The object pool that internally manages our connections.
  - connectionProperties
```
protected Properties connectionProperties
```
    The connection properties that will be sent to our JDBC driver when establishing new connections. NOTE - The "user" and "password" properties will be passed explicitly, so they do not need to be included here.
  - dataSource
```
protected volatile DataSource dataSource
```
    The data source we will use to manage connections. This object should be acquired ONLY by calls to the createDataSource() method.
  - logWriter
```
protected PrintWriter logWriter
```
    The PrintWriter to which log messages should be directed.
  - closed
```
protected boolean closed
```
- Constructor Detail
  - BasicDataSource
```
public BasicDataSource()
```
- Method Detail
  - getDefaultAutoCommit
```
public boolean getDefaultAutoCommit()
```
    Returns the default auto-commit property.
    
    Returns:
    
    true if default auto-commit is enabled
  - setDefaultAutoCommit
```
public void setDefaultAutoCommit(boolean defaultAutoCommit)
```
    Sets default auto-commit state of connections returned by this datasource.
    
    Note: this method currently has no effect once the pool has been initialized. The pool is initialized the first time one of the following methods is invoked: getConnection, setLogwriter, setLoginTimeout, getLoginTimeout, getLogWriter.
    
    Parameters:
    
    defaultAutoCommit - default auto-commit value
  - getDefaultReadOnly
```
public boolean getDefaultReadOnly()
```
    Returns the default readOnly property.
    
    Returns:
    
    true if connections are readOnly by default
  - setDefaultReadOnly
```
public void setDefaultReadOnly(boolean defaultReadOnly)
```
    Sets defaultReadonly property.
    
    Note: this method currently has no effect once the pool has been initialized. The pool is initialized the first time one of the following methods is invoked: getConnection, setLogwriter, setLoginTimeout, getLoginTimeout, getLogWriter.
    
    Parameters:
    
    defaultReadOnly - default read-only value
  - getDefaultTransactionIsolation
```
public int getDefaultTransactionIsolation()
```
    Returns the default transaction isolation state of returned connections.
    
    Returns:
    
    the default value for transaction isolation state
    
    See Also:
    
    Connection.getTransactionIsolation()
  - setDefaultTransactionIsolation
```
public void setDefaultTransactionIsolation(int defaultTransactionIsolation)
```
    Sets the default transaction isolation state for returned connections.
    
    Note: this method currently has no effect once the pool has been initialized. The pool is initialized the first time one of the following methods is invoked: getConnection, setLogwriter, setLoginTimeout, getLoginTimeout, getLogWriter.
    
    Parameters:
    
    defaultTransactionIsolation - the default transaction isolation state
    
    See Also:
    
    Connection.getTransactionIsolation()
  - getDefaultCatalog
```
public String getDefaultCatalog()
```
    Returns the default catalog.
    
    Returns:
    
    the default catalog
  - setDefaultCatalog
```
public void setDefaultCatalog(String defaultCatalog)
```
    Sets the default catalog.
    
    Note: this method currently has no effect once the pool has been initialized. The pool is initialized the first time one of the following methods is invoked: getConnection, setLogwriter, setLoginTimeout, getLoginTimeout, getLogWriter.
    
    Parameters:
    
    defaultCatalog - the default catalog
  - getDriverClassName
```
public String getDriverClassName()
```
    Returns the jdbc driver class name.
    
    Returns:
    
    the jdbc driver class name
  - setDriverClassName
```
public void setDriverClassName(String driverClassName)
```
    Sets the jdbc driver class name.
    
    Note: this method currently has no effect once the pool has been initialized. The pool is initialized the first time one of the following methods is invoked: getConnection, setLogwriter, setLoginTimeout, getLoginTimeout, getLogWriter.
    
    Parameters:
    
    driverClassName - the class name of the jdbc driver
  - getDriverClassLoader
```
public ClassLoader getDriverClassLoader()
```
  - setDriverClassLoader
```
public void setDriverClassLoader(ClassLoader driverClassLoader)
```
  - getMaxActive
```
public int getMaxActive()
```
  - setMaxActive
```
public void setMaxActive(int maxActive)
```
  - getMaxIdle
```
public int getMaxIdle()
```
  - setMaxIdle
```
public void setMaxIdle(int maxIdle)
```
  - getMinIdle
```
public int getMinIdle()
```
  - setMinIdle
```
public void setMinIdle(int minIdle)
```
  - getInitialSize
```
public int getInitialSize()
```
  - setInitialSize
```
public void setInitialSize(int initialSize)
```
  - getMaxWait
```
public long getMaxWait()
```
    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.
    
    Returns:
    
    the maxWait property value
  - setMaxWait
```
public void setMaxWait(long maxWait)
```
    Sets the maxWait property.
    
    Use -1 to make the pool wait indefinitely.
    
    Parameters:
    
    maxWait - the new value for maxWait
    
    See Also:
    
    getMaxWait()
  - isPoolPreparedStatements
```
public boolean isPoolPreparedStatements()
```
    Returns true if we are pooling statements.
    
    Returns:
    
    true if prepared and callable statements are pooled
  - setPoolPreparedStatements
```
public void setPoolPreparedStatements(boolean poolingStatements)
```
    Sets whether to pool statements or not.
    
    Note: this method currently has no effect once the pool has been initialized. The pool is initialized the first time one of the following methods is invoked: getConnection, setLogwriter, setLoginTimeout, getLoginTimeout, getLogWriter.
    
    Parameters:
    
    poolingStatements - pooling on or off
  - getMaxOpenPreparedStatements
```
public int getMaxOpenPreparedStatements()
```
    Gets the value of the maxOpenPreparedStatements property.
    
    Returns:
    
    the maximum number of open statements
    
    See Also:
    
    maxOpenPreparedStatements
  - setMaxOpenPreparedStatements
```
public void setMaxOpenPreparedStatements(int maxOpenStatements)
```
    Sets the value of the maxOpenPreparedStatements property.
    
    Note: this method currently has no effect once the pool has been initialized. The pool is initialized the first time one of the following methods is invoked: getConnection, setLogwriter, setLoginTimeout, getLoginTimeout, getLogWriter.
    
    Parameters:
    
    maxOpenStatements - the new maximum number of prepared statements
    
    See Also:
    
    maxOpenPreparedStatements
  - getTestOnBorrow
```
public boolean getTestOnBorrow()
```
    Returns the testOnBorrow property.
    
    Returns:
    
    true if objects are validated before being borrowed from the pool
    
    See Also:
    
    testOnBorrow
  - setTestOnBorrow
```
public void setTestOnBorrow(boolean testOnBorrow)
```
    Sets the testOnBorrow property. This property determines whether or not the pool will validate objects before they are borrowed from the pool. For a true value to have any effect, the validationQuery property must be set to a non-null string.
    
    Parameters:
    
    testOnBorrow - new value for testOnBorrow property
  - getTestOnReturn
```
public boolean getTestOnReturn()
```
    Returns the value of the testOnReturn property.
    
    Returns:
    
    true if objects are validated before being returned to the pool
    
    See Also:
    
    testOnReturn
  - setTestOnReturn
```
public void setTestOnReturn(boolean testOnReturn)
```
    Sets the testOnReturn property. This property determines whether or not the pool will validate objects before they are returned to the pool. For a true value to have any effect, the validationQuery property must be set to a non-null string.
    
    Parameters:
    
    testOnReturn - new value for testOnReturn property
  - getTimeBetweenEvictionRunsMillis
```
public long getTimeBetweenEvictionRunsMillis()
```
    Returns the value of the timeBetweenEvictionRunsMillis property.
    
    Returns:
    
    the time (in miliseconds) between evictor runs
    
    See Also:
    
    timeBetweenEvictionRunsMillis
  - setTimeBetweenEvictionRunsMillis
```
public void setTimeBetweenEvictionRunsMillis(long timeBetweenEvictionRunsMillis)
```
    Sets the timeBetweenEvictionRunsMillis property.
    
    Parameters:
    
    timeBetweenEvictionRunsMillis - the new time between evictor runs
    
    See Also:
    
    timeBetweenEvictionRunsMillis
  - getNumTestsPerEvictionRun
```
public int getNumTestsPerEvictionRun()
```
    Returns the value of the numTestsPerEvictionRun property.
    
    Returns:
    
    the number of objects to examine during idle object evictor runs
    
    See Also:
    
    numTestsPerEvictionRun
  - setNumTestsPerEvictionRun
```
public void setNumTestsPerEvictionRun(int numTestsPerEvictionRun)
```
    Sets the value of the numTestsPerEvictionRun property.
    
    Parameters:
    
    numTestsPerEvictionRun - the new numTestsPerEvictionRun value
    
    See Also:
    
    numTestsPerEvictionRun
  - getMinEvictableIdleTimeMillis
```
public long getMinEvictableIdleTimeMillis()
```
    Returns the minEvictableIdleTimeMillis property.
    
    Returns:
    
    the value of the minEvictableIdleTimeMillis property
    
    See Also:
    
    minEvictableIdleTimeMillis
  - setMinEvictableIdleTimeMillis
```
public void setMinEvictableIdleTimeMillis(long minEvictableIdleTimeMillis)
```
    Sets the minEvictableIdleTimeMillis property.
    
    Parameters:
    
    minEvictableIdleTimeMillis - the minimum amount of time an object may sit idle in the pool
    
    See Also:
    
    minEvictableIdleTimeMillis
  - getTestWhileIdle
```
public boolean getTestWhileIdle()
```
    Returns the value of the testWhileIdle property.
    
    Returns:
    
    true if objects examined by the idle object evictor are validated
    
    See Also:
    
    testWhileIdle
  - setTestWhileIdle
```
public void setTestWhileIdle(boolean testWhileIdle)
```
    Sets the testWhileIdle property. This property determines whether or not the idle object evictor will validate connections. For a true value to have any effect, the validationQuery property must be set to a non-null string.
    
    Parameters:
    
    testWhileIdle - new value for testWhileIdle property
  - getNumActive
```
public int getNumActive()
```
    [Read Only] The current number of active connections that have been allocated from this data source.
    
    Returns:
    
    the current number of active connections
  - getNumIdle
```
public int getNumIdle()
```
    [Read Only] The current number of idle connections that are waiting to be allocated from this data source.
    
    Returns:
    
    the current number of idle connections
  - getPassword
```
public String getPassword()
```
    Returns the password passed to the JDBC driver to establish connections.
    
    Returns:
    
    the connection password
  - setPassword
```
public void setPassword(String password)
```
    Sets the password.
    
    Note: this method currently has no effect once the pool has been initialized. The pool is initialized the first time one of the following methods is invoked: getConnection, setLogwriter, setLoginTimeout, getLoginTimeout, getLogWriter.
    
    Parameters:
    
    password - new value for the password
  - getUrl
```
public String getUrl()
```
    Returns the JDBC connection url property.
    
    Returns:
    
    the url passed to the JDBC driver to establish connections
  - setUrl
```
public void setUrl(String url)
```
    Sets the url.
    
    Note: this method currently has no effect once the pool has been initialized. The pool is initialized the first time one of the following methods is invoked: getConnection, setLogwriter, setLoginTimeout, getLoginTimeout, getLogWriter.
    
    Parameters:
    
    url - the new value for the JDBC connection url
  - getUsername
```
public String getUsername()
```
    Returns the JDBC connection username property.
    
    Returns:
    
    the username passed to the JDBC driver to establish connections
  - setUsername
```
public void setUsername(String username)
```
    Sets the username.
    
    Note: this method currently has no effect once the pool has been initialized. The pool is initialized the first time one of the following methods is invoked: getConnection, setLogwriter, setLoginTimeout, getLoginTimeout, getLogWriter.
    
    Parameters:
    
    username - the new value for the JDBC connection username
  - getValidationQuery
```
public String getValidationQuery()
```
    Returns the validation query used to validate connections before returning them.
    
    Returns:
    
    the SQL validation query
    
    See Also:
    
    validationQuery
  - setValidationQuery
```
public void setValidationQuery(String validationQuery)
```
    Sets the validationQuery.
    
    Note: this method currently has no effect once the pool has been initialized. The pool is initialized the first time one of the following methods is invoked: getConnection, setLogwriter, setLoginTimeout, getLoginTimeout, getLogWriter.
    
    Parameters:
    
    validationQuery - the new value for the validation query
  - getValidationQueryTimeout
```
public int getValidationQueryTimeout()
```
    Returns the validation query timeout.
    
    Returns:
    
    the timeout in seconds before connection validation queries fail.
    
    Since:
    
    1.3
  - setValidationQueryTimeout
```
public 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. 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:
    
    timeout - new validation query timeout value in seconds
    
    Since:
    
    1.3
  - getConnectionInitSqls
```
public Collection 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
    
    Since:
    
    1.3
  - setConnectionInitSqls
```
public void setConnectionInitSqls(Collection 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
  - isAccessToUnderlyingConnectionAllowed
```
public boolean isAccessToUnderlyingConnectionAllowed()
```
    Returns the value of the accessToUnderlyingConnectionAllowed property.
    
    Returns:
    
    true if access to the underlying connection is allowed, false otherwise.
  - setAccessToUnderlyingConnectionAllowed
```
public void setAccessToUnderlyingConnectionAllowed(boolean allow)
```
    Sets the value of the accessToUnderlyingConnectionAllowed property. It controls if the PoolGuard allows access to the underlying connection. (Default: false)
    
    Note: this method currently has no effect once the pool has been initialized. The pool is initialized the first time one of the following methods is invoked: getConnection, setLogwriter, setLoginTimeout, getLoginTimeout, getLogWriter.
    
    Parameters:
    
    allow - Access to the underlying connection is granted when true.
  - getConnection
```
public Connection getConnection()
                         throws SQLException
```
    Create (if necessary) and return a connection to the database.
    
    Specified by:
    
    getConnection in interface DataSource
    
    Returns:
    
    a database connection
    
    Throws:
    
    SQLException - if a database access error occurs
  - getConnection
```
public Connection getConnection(String user,
                                String pass)
                         throws SQLException
```
    Specified by:
    
    getConnection in interface DataSource
    
    Throws:
    
    SQLException
  - getLoginTimeout
```
public int getLoginTimeout()
                    throws SQLException
```
    Specified by:
    
    getLoginTimeout in interface CommonDataSource
    
    Throws:
    
    SQLException
  - getLogWriter
```
public PrintWriter getLogWriter()
                         throws SQLException
```
    Specified by:
    
    getLogWriter in interface CommonDataSource
    
    Throws:
    
    SQLException
  - setLoginTimeout
```
public void setLoginTimeout(int loginTimeout)
                     throws SQLException
```
    Specified by:
    
    setLoginTimeout in interface CommonDataSource
    
    Throws:
    
    SQLException
  - setLogWriter
```
public void setLogWriter(PrintWriter logWriter)
                  throws SQLException
```
    Specified by:
    
    setLogWriter in interface CommonDataSource
    
    Throws:
    
    SQLException
  - getRemoveAbandoned
```
public boolean getRemoveAbandoned()
```
  - setRemoveAbandoned
```
public void setRemoveAbandoned(boolean removeAbandoned)
```
  - getRemoveAbandonedTimeout
```
public int getRemoveAbandonedTimeout()
```
  - setRemoveAbandonedTimeout
```
public void setRemoveAbandonedTimeout(int removeAbandonedTimeout)
```
  - getLogAbandoned
```
public boolean getLogAbandoned()
```
  - setLogAbandoned
```
public void setLogAbandoned(boolean logAbandoned)
```
  - addConnectionProperty
```
public void addConnectionProperty(String name,
                                  String value)
```
  - removeConnectionProperty
```
public void removeConnectionProperty(String name)
```
  - setConnectionProperties
```
public void setConnectionProperties(String connectionProperties)
```
  - close
```
public void close()
           throws SQLException
```
    Throws:
    
    SQLException
  - isClosed
```
public boolean isClosed()
```
  - isWrapperFor
```
public boolean isWrapperFor(Class<?> iface)
                     throws SQLException
```
    Specified by:
    
    isWrapperFor in interface Wrapper
    
    Throws:
    
    SQLException
  - unwrap
```
public <T> T unwrap(Class<T> iface)
             throws SQLException
```
    Specified by:
    
    unwrap in interface Wrapper
    
    Throws:
    
    SQLException
  - createDataSource
```
protected DataSource createDataSource()
                               throws SQLException
```
    Throws:
    
    SQLException
  - createConnectionFactory
```
protected ConnectionFactory createConnectionFactory()
                                             throws SQLException
```
    Throws:
    
    SQLException
  - createConnectionPool
```
protected void createConnectionPool()
```
  - createDataSourceInstance
```
protected void createDataSourceInstance()
```
  - createPoolableConnectionFactory
```
protected void createPoolableConnectionFactory(ConnectionFactory driverConnectionFactory,
                                               KeyedObjectPoolFactory statementPoolFactory,
                                               AbandonedConfig configuration)
                                        throws SQLException
```
    Throws:
    
    SQLException
  - validateConnectionFactory
```
protected static void validateConnectionFactory(PoolableConnectionFactory connectionFactory)
                                         throws Exception
```
    Throws:
    
    Exception
  - log
```
protected void log(String message)
```
  - getParentLogger
```
public Logger getParentLogger()
                       throws SQLFeatureNotSupportedException
```
    Specified by:
    
    getParentLogger in interface CommonDataSource
    
    Throws:
    
    SQLFeatureNotSupportedException

Class BasicDataSource

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

defaultAutoCommit

defaultReadOnly

defaultTransactionIsolation

defaultCatalog

driverClassName

driverClassLoader

maxActive

maxIdle

minIdle

initialSize

maxWait

poolPreparedStatements

maxOpenPreparedStatements

testOnBorrow

testOnReturn

timeBetweenEvictionRunsMillis

numTestsPerEvictionRun

minEvictableIdleTimeMillis

testWhileIdle

password

url

username

validationQuery

validationQueryTimeout

connectionInitSqls

connectionPool

connectionProperties

dataSource

logWriter

closed

Constructor Detail

BasicDataSource

Method Detail

getDefaultAutoCommit

setDefaultAutoCommit

getDefaultReadOnly

setDefaultReadOnly

getDefaultTransactionIsolation

setDefaultTransactionIsolation

getDefaultCatalog

setDefaultCatalog

getDriverClassName

setDriverClassName

getDriverClassLoader

setDriverClassLoader

getMaxActive

setMaxActive

getMaxIdle

setMaxIdle

getMinIdle

setMinIdle

getInitialSize

setInitialSize

getMaxWait

setMaxWait

isPoolPreparedStatements

setPoolPreparedStatements

getMaxOpenPreparedStatements

setMaxOpenPreparedStatements

getTestOnBorrow

setTestOnBorrow

getTestOnReturn

setTestOnReturn

getTimeBetweenEvictionRunsMillis

setTimeBetweenEvictionRunsMillis

getNumTestsPerEvictionRun

setNumTestsPerEvictionRun

getMinEvictableIdleTimeMillis

setMinEvictableIdleTimeMillis

getTestWhileIdle

setTestWhileIdle

getNumActive

getNumIdle

getPassword