AbstractDataSourceBean (Transactions JDBC 5.0.8 API)

java.lang.Object
- com.atomikos.jdbc.internal.AbstractDataSourceBean

All Implemented Interfaces:

ConnectionPoolProperties, OrderedLifecycleComponent, java.io.Serializable, java.sql.Wrapper, javax.naming.Referenceable, javax.sql.CommonDataSource, javax.sql.DataSource

Direct Known Subclasses:

AtomikosDataSourceBean, AtomikosNonXADataSourceBean
```
public abstract class AbstractDataSourceBean
extends java.lang.Object
implements javax.sql.DataSource, ConnectionPoolProperties, javax.naming.Referenceable, java.io.Serializable, OrderedLifecycleComponent
```
Abstract data source bean with generic functionality.

See Also:

Serialized Form

Field Summary
- Fields inherited from interface com.atomikos.datasource.pool.ConnectionPoolProperties
  DEFAULT_BORROW_CONNECTION_TIMEOUT, DEFAULT_ISOLATION_LEVEL_UNSET, DEFAULT_MAINTENANCE_INTERVAL, DEFAULT_MAX_IDLE_TIME, DEFAULT_MAX_LIFETIME, DEFAULT_POOL_SIZE, DEFAULT_REAP_TIMEOUT

Constructor Summary

Constructors
Constructor and Description

AbstractDataSourceBean()

Constructors
Constructor and Description
`AbstractDataSourceBean()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()`
`protected abstract void`	`doClose()`
`protected abstract ConnectionFactory<java.sql.Connection>`	`doInit()`
`int`	`getBorrowConnectionTimeout()` Get the maximum amount of time in seconds the pool will block waiting for a connection to become available in the pool when it is empty.
`boolean`	`getConcurrentConnectionValidation()`
`java.sql.Connection`	`getConnection()`
`java.sql.Connection`	`getConnection(java.lang.String username, java.lang.String password)`
`int`	`getDefaultIsolationLevel()` Gets the default isolation level for connections created by this datasource.
`boolean`	`getLocalTransactionMode()` Tests whether local transactions are allowed - defaults to false for JDBC.
`int`	`getLoginTimeout()`
`java.io.PrintWriter`	`getLogWriter()`
`int`	`getMaintenanceInterval()` Gets the maintenance interval as set.
`int`	`getMaxIdleTime()` Gets the maximum amount of time in seconds a connection can stay in the pool before being eligible for being closed during pool shrinking.
`int`	`getMaxLifetime()` Gets the maximum lifetime in seconds.
`int`	`getMaxPoolSize()` Get the maximum pool size.
`int`	`getMinPoolSize()` Gets the minimum size of the pool.
`java.util.logging.Logger`	`getParentLogger()` JDK 1.7 requirement.
`int`	`getReapTimeout()` Get the amount of time in seconds the connection pool will allow a connection to be borrowed before claiming it back.
`javax.naming.Reference`	`getReference()`
`java.lang.String`	`getTestQuery()` Gets the SQL query used to test a connection before returning it.
`java.lang.String`	`getUniqueResourceName()` Get the resource name.
`void`	`init()`
`protected abstract boolean`	`isAssignableFromWrappedVendorClass(java.lang.Class<?> iface)`
`boolean`	`isWrapperFor(java.lang.Class<?> iface)`
`int`	`poolAvailableSize()`
`int`	`poolTotalSize()`
`void`	`refreshPool()` Refreshes all available connections in the pool.
`void`	`setBorrowConnectionTimeout(int borrowConnectionTimeout)` Sets the maximum amount of time in seconds the pool will block waiting for a connection to become available in the pool when it is empty.
`void`	`setConcurrentConnectionValidation(boolean value)` Sets whether or not to use concurrent connection validation.
`void`	`setDefaultIsolationLevel(int defaultIsolationLevel)` Sets the default isolation level of connections returned by this datasource.
`void`	`setLoginTimeout(int seconds)`
`void`	`setLogWriter(java.io.PrintWriter out)`
`void`	`setMaintenanceInterval(int maintenanceInterval)` Sets the maintenance interval for the pool maintenance thread.
`void`	`setMaxIdleTime(int maxIdleTime)` Sets the maximum amount of seconds that unused excess connections should stay in the pool.
`void`	`setMaxLifetime(int maxLifetime)` Sets the maximum amount of seconds that a connection is kept in the pool before it is destroyed automatically.
`void`	`setMaxPoolSize(int maxPoolSize)` Sets the maximum pool size.
`void`	`setMinPoolSize(int minPoolSize)` Sets the minimum pool size.
`void`	`setPoolSize(int poolSize)` Sets both the minimal and maximal pool size.
`void`	`setReapTimeout(int reapTimeout)` Sets the amount of time (in seconds) that the connection pool will allow a connection to be in use, before claiming it back.
`void`	`setTestQuery(java.lang.String testQuery)` Sets the SQL query or statement used to validate a connection before returning it.
`void`	`setUniqueResourceName(java.lang.String resourceName)` Sets the resource name.
`protected void`	`throwAtomikosSQLException(java.lang.String msg)`
`java.lang.String`	`toString()`
`<T> T`	`unwrap(java.lang.Class<T> iface)`
`protected abstract java.lang.Object`	`unwrapVendorInstance()`

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

Methods inherited from interface com.atomikos.datasource.pool.ConnectionPoolProperties
getIgnoreJtaTransactions

- Constructor Detail
  - AbstractDataSourceBean
```
public AbstractDataSourceBean()
```
- Method Detail
  - throwAtomikosSQLException
```
protected void throwAtomikosSQLException(java.lang.String msg)
                                  throws AtomikosSQLException
```
    Throws:
    
    AtomikosSQLException
  - getMinPoolSize
```
public int getMinPoolSize()
```
    Gets the minimum size of the pool.
    
    Specified by:
    
    getMinPoolSize in interface ConnectionPoolProperties
  - setMinPoolSize
```
public void setMinPoolSize(int minPoolSize)
```
    Sets the minimum pool size. The amount of pooled connections won't go below that value. The pool will open this amount of connections during initialization. Optional, defaults to 1.
    
    Parameters:
    
    minPoolSize -
  - getMaxPoolSize
```
public int getMaxPoolSize()
```
    Get the maximum pool size.
    
    Specified by:
    
    getMaxPoolSize in interface ConnectionPoolProperties
  - setMaxPoolSize
```
public void setMaxPoolSize(int maxPoolSize)
```
    Sets the maximum pool size. The amount of pooled connections won't go above this value. Optional, defaults to 1.
    
    Parameters:
    
    maxPoolSize -
  - setPoolSize
```
public void setPoolSize(int poolSize)
```
    Sets both the minimal and maximal pool size. Required if the maxPoolSize is not set. Overrides any minPoolSize or maxPoolSize settings you might have configured before!
  - getBorrowConnectionTimeout
```
public int getBorrowConnectionTimeout()
```
    Get the maximum amount of time in seconds the pool will block waiting for a connection to become available in the pool when it is empty.
    
    Specified by:
    
    getBorrowConnectionTimeout in interface ConnectionPoolProperties
  - setBorrowConnectionTimeout
```
public void setBorrowConnectionTimeout(int borrowConnectionTimeout)
```
    Sets the maximum amount of time in seconds the pool will block waiting for a connection to become available in the pool when it is empty. Optional.
    
    Parameters:
    
    borrowConnectionTimeout - The time in seconds. Zero or negative means no waiting at all. Defaults to 30 seconds.
  - getReapTimeout
```
public int getReapTimeout()
```
    Get the amount of time in seconds the connection pool will allow a connection to be borrowed before claiming it back.
    
    Specified by:
    
    getReapTimeout in interface ConnectionPoolProperties
  - setReapTimeout
```
public void setReapTimeout(int reapTimeout)
```
    Sets the amount of time (in seconds) that the connection pool will allow a connection to be in use, before claiming it back. Optional.
    
    Parameters:
    
    reapTimeout - The timeout in seconds. Zero means unlimited. Note that this value is only an indication; the pool will check regularly as indicated by the maintenanceInteval property. Defaults to maxLifetime.
  - setMaintenanceInterval
```
public void setMaintenanceInterval(int maintenanceInterval)
```
    Sets the maintenance interval for the pool maintenance thread. Optional.
    
    Parameters:
    
    maintenanceInterval - The interval in seconds. If not set or not positive then the pool's default (60 secs) will be used.
  - getMaintenanceInterval
```
public int getMaintenanceInterval()
```
    Gets the maintenance interval as set.
    
    Specified by:
    
    getMaintenanceInterval in interface ConnectionPoolProperties
  - getMaxIdleTime
```
public int getMaxIdleTime()
```
    Gets the maximum amount of time in seconds a connection can stay in the pool before being eligible for being closed during pool shrinking.
    
    Specified by:
    
    getMaxIdleTime in interface ConnectionPoolProperties
  - setMaxIdleTime
```
public void setMaxIdleTime(int maxIdleTime)
```
    Sets the maximum amount of seconds that unused excess connections should stay in the pool. Optional. Note: excess connections are connections that are created above the minPoolSize limit.
    
    Parameters:
    
    maxIdleTime - The preferred idle time for unused excess connections. Note that this value is only an indication; the pool will check regularly as indicated by the maintenanceInteval property. The default is 60 seconds.
  - setMaxLifetime
```
public void setMaxLifetime(int maxLifetime)
```
    Sets the maximum amount of seconds that a connection is kept in the pool before it is destroyed automatically. Optional, defaults to 0 (no limit).
    
    Parameters:
    
    maxLifetime -
  - getMaxLifetime
```
public int getMaxLifetime()
```
    Gets the maximum lifetime in seconds.
    
    Specified by:
    
    getMaxLifetime in interface ConnectionPoolProperties
  - getTestQuery
```
public java.lang.String getTestQuery()
```
    Gets the SQL query used to test a connection before returning it.
    
    Specified by:
    
    getTestQuery in interface ConnectionPoolProperties
  - setTestQuery
```
public void setTestQuery(java.lang.String testQuery)
```
    Sets the SQL query or statement used to validate a connection before returning it. Optional.
    
    Parameters:
    
    testQuery - - The SQL query or statement to validate the connection with. Note that although you can specify updates here, these will NOT be part of any JTA transaction!
  - setConcurrentConnectionValidation
```
public void setConcurrentConnectionValidation(boolean value)
```
    Sets whether or not to use concurrent connection validation. Optional, defaults to true.
    
    Parameters:
    
    value -
  - getConcurrentConnectionValidation
```
public boolean getConcurrentConnectionValidation()
```
  - poolAvailableSize
```
public int poolAvailableSize()
```
  - poolTotalSize
```
public int poolTotalSize()
```
  - getLogWriter
```
public java.io.PrintWriter getLogWriter()
                                 throws java.sql.SQLException
```
    Specified by:
    
    getLogWriter in interface javax.sql.CommonDataSource
    
    Throws:
    
    java.sql.SQLException
  - getLoginTimeout
```
public int getLoginTimeout()
                    throws java.sql.SQLException
```
    Specified by:
    
    getLoginTimeout in interface javax.sql.CommonDataSource
    
    Throws:
    
    java.sql.SQLException
  - setLogWriter
```
public void setLogWriter(java.io.PrintWriter out)
                  throws java.sql.SQLException
```
    Specified by:
    
    setLogWriter in interface javax.sql.CommonDataSource
    
    Throws:
    
    java.sql.SQLException
  - setLoginTimeout
```
public void setLoginTimeout(int seconds)
                     throws java.sql.SQLException
```
    Specified by:
    
    setLoginTimeout in interface javax.sql.CommonDataSource
    
    Throws:
    
    java.sql.SQLException
  - init
```
public void init()
          throws AtomikosSQLException
```
    Specified by:
    
    init in interface OrderedLifecycleComponent
    
    Throws:
    
    AtomikosSQLException
  - close
```
public void close()
```
    Specified by:
    
    close in interface OrderedLifecycleComponent
  - doInit
```
protected abstract ConnectionFactory<java.sql.Connection> doInit()
                                                          throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - doClose
```
protected abstract void doClose()
```
  - getConnection
```
public java.sql.Connection getConnection()
                                  throws java.sql.SQLException
```
    Specified by:
    
    getConnection in interface javax.sql.DataSource
    
    Throws:
    
    java.sql.SQLException
  - getConnection
```
public java.sql.Connection getConnection(java.lang.String username,
                                         java.lang.String password)
                                  throws java.sql.SQLException
```
    Specified by:
    
    getConnection in interface javax.sql.DataSource
    
    Throws:
    
    java.sql.SQLException
  - getUniqueResourceName
```
public java.lang.String getUniqueResourceName()
```
    Get the resource name.
    
    Specified by:
    
    getUniqueResourceName in interface ConnectionPoolProperties
  - setUniqueResourceName
```
public void setUniqueResourceName(java.lang.String resourceName)
```
    Sets the resource name. Required.
    
    Parameters:
    
    resourceName - An arbitrary user-specified value that identifies this datasource. It must be unique for recovery purposes.
  - getLocalTransactionMode
```
public boolean getLocalTransactionMode()
```
    Tests whether local transactions are allowed - defaults to false for JDBC. This property is used by the pooling mechanism. If false, then attempting to use a JDBC connection without a JTA transaction for the calling thread will fail.
    
    Specified by:
    
    getLocalTransactionMode in interface ConnectionPoolProperties
  - getReference
```
public javax.naming.Reference getReference()
                                    throws javax.naming.NamingException
```
    Specified by:
    
    getReference in interface javax.naming.Referenceable
    
    Throws:
    
    javax.naming.NamingException
  - setDefaultIsolationLevel
```
public void setDefaultIsolationLevel(int defaultIsolationLevel)
```
    Sets the default isolation level of connections returned by this datasource. Optional, defaults to the vendor-specific JDBC or DBMS settings.
    
    Parameters:
    
    defaultIsolationLevel - The default isolation level. Negative values are ignored and result in vendor-specific JDBC driver or DBMS internal defaults.
  - getDefaultIsolationLevel
```
public int getDefaultIsolationLevel()
```
    Gets the default isolation level for connections created by this datasource.
    
    Specified by:
    
    getDefaultIsolationLevel in interface ConnectionPoolProperties
    
    Returns:
    
    The default isolation level, or -1 if no specific value was set.
  - isWrapperFor
```
public boolean isWrapperFor(java.lang.Class<?> iface)
```
    Specified by:
    
    isWrapperFor in interface java.sql.Wrapper
  - isAssignableFromWrappedVendorClass
```
protected abstract boolean isAssignableFromWrappedVendorClass(java.lang.Class<?> iface)
```
  - unwrap
```
public <T> T unwrap(java.lang.Class<T> iface)
             throws java.sql.SQLException
```
    Specified by:
    
    unwrap in interface java.sql.Wrapper
    
    Throws:
    
    java.sql.SQLException
  - unwrapVendorInstance
```
protected abstract java.lang.Object unwrapVendorInstance()
```
  - getParentLogger
```
public java.util.logging.Logger getParentLogger()
                                         throws java.sql.SQLFeatureNotSupportedException
```
    JDK 1.7 requirement.
    
    Specified by:
    
    getParentLogger in interface javax.sql.CommonDataSource
    
    Throws:
    
    java.sql.SQLFeatureNotSupportedException
  - refreshPool
```
public void refreshPool()
```
    Refreshes all available connections in the pool.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class AbstractDataSourceBean

Field Summary

Fields inherited from interface com.atomikos.datasource.pool.ConnectionPoolProperties

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.atomikos.datasource.pool.ConnectionPoolProperties

Constructor Detail

AbstractDataSourceBean

Method Detail

throwAtomikosSQLException

getMinPoolSize

setMinPoolSize

getMaxPoolSize

setMaxPoolSize

setPoolSize

getBorrowConnectionTimeout

setBorrowConnectionTimeout

getReapTimeout

setReapTimeout

setMaintenanceInterval

getMaintenanceInterval

getMaxIdleTime

setMaxIdleTime

setMaxLifetime

getMaxLifetime

getTestQuery

setTestQuery

setConcurrentConnectionValidation

getConcurrentConnectionValidation

poolAvailableSize

poolTotalSize

getLogWriter

getLoginTimeout

setLogWriter

setLoginTimeout

init

close

doInit

doClose

getConnection

getConnection

getUniqueResourceName

setUniqueResourceName

getLocalTransactionMode

getReference

setDefaultIsolationLevel

getDefaultIsolationLevel

isWrapperFor

isAssignableFromWrappedVendorClass

unwrap

unwrapVendorInstance

getParentLogger

refreshPool

toString