br.com.anteros.dbcp

Class AnterosDBCPDataSource

java.lang.Object

br.com.anteros.dbcp.AnterosDBCPConfig

br.com.anteros.dbcp.AnterosDBCPDataSource

All Implemented Interfaces:

AnterosDBCPConfigMXBean, Closeable, AutoCloseable, Wrapper, CommonDataSource, DataSource

public class AnterosDBCPDataSource
extends AnterosDBCPConfig
implements DataSource, Closeable

The AnterosDBCPCP pooled DataSource.

Author:

Brett Wooldridge

Constructor Summary

Constructors

Constructor and Description
AnterosDBCPDataSource() Default constructor.
AnterosDBCPDataSource(AnterosDBCPConfig configuration) Construct a AnterosDBCPDataSource with the specified configuration.

Method Summary

Modifier and Type	Method and Description
void	close() Shutdown the DataSource and its associated pool.
void	evictConnection(Connection connection) Evict a connection from the pool.
AnterosDBCPConfigMXBean	getAnterosDBCPConfigMXBean() Get the AnterosDBCPConfigMXBean for this AnterosDBCPDataSource instance.
AnterosDBCPPoolMXBean	getAnterosDBCPPoolMXBean() Get the AnterosDBCPPoolMXBean for this AnterosDBCPDataSource instance.
Connection	getConnection()
Connection	getConnection(String username, String password)
int	getLoginTimeout()
PrintWriter	getLogWriter()
Logger	getParentLogger()
boolean	isClosed() Determine whether the AnterosDBCPDataSource has been closed.
boolean	isRunning() Returns true if the pool as been started and is not suspended or shutdown.
boolean	isWrapperFor(Class<?> iface)
void	setHealthCheckRegistry(Object healthCheckRegistry) Set the HealthCheckRegistry that will be used for registration of health checks by AnterosDBCPCP.
void	setLoginTimeout(int seconds)
void	setLogWriter(PrintWriter out)
void	setMetricRegistry(Object metricRegistry) Set a MetricRegistry instance to use for registration of metrics used by AnterosDBCPCP.
void	setMetricsTrackerFactory(MetricsTrackerFactory metricsTrackerFactory)
String	toString()
<T> T	unwrap(Class<T> iface)

Methods inherited from class br.com.anteros.dbcp.AnterosDBCPConfig

addDataSourceProperty, addHealthCheckProperty, copyStateTo, getCatalog, getConnectionInitSql, getConnectionTestQuery, getConnectionTimeout, getDataSource, getDataSourceClassName, getDataSourceJNDI, getDataSourceProperties, getDriverClassName, getHealthCheckProperties, getHealthCheckRegistry, getIdleTimeout, getInitializationFailTimeout, getJdbcUrl, getLeakDetectionThreshold, getMaximumPoolSize, getMaxLifetime, getMetricRegistry, getMetricsTrackerFactory, getMinimumIdle, getPassword, getPoolName, getScheduledExecutor, getSchema, getThreadFactory, getTransactionIsolation, getUsername, getValidationTimeout, isAllowPoolSuspension, isAutoCommit, isIsolateInternalQueries, isReadOnly, isRegisterMbeans, setAllowPoolSuspension, setAutoCommit, setCatalog, setConnectionInitSql, setConnectionTestQuery, setConnectionTimeout, setDataSource, setDataSourceClassName, setDataSourceJNDI, setDataSourceProperties, setDriverClassName, setHealthCheckProperties, setIdleTimeout, setInitializationFailTimeout, setIsolateInternalQueries, setJdbcUrl, setLeakDetectionThreshold, setMaximumPoolSize, setMaxLifetime, setMinimumIdle, setPassword, setPoolName, setReadOnly, setRegisterMbeans, setScheduledExecutor, setSchema, setThreadFactory, setTransactionIsolation, setUsername, setValidationTimeout, validate

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AnterosDBCPDataSource

public AnterosDBCPDataSource()

Default constructor. Setters are used to configure the pool. Using this constructor vs. AnterosDBCPDataSource(AnterosDBCPConfig) will result in getConnection() performance that is slightly lower due to lazy initialization checks. The first call to getConnection() starts the pool. Once the pool is started, the configuration is "sealed" and no further configuration changes are possible -- except via AnterosDBCPConfigMXBean methods.

AnterosDBCPDataSource

public AnterosDBCPDataSource(AnterosDBCPConfig configuration)

Construct a AnterosDBCPDataSource with the specified configuration. The AnterosDBCPConfig is copied and the pool is started by invoking this constructor. The AnterosDBCPConfig can be modified without affecting the AnterosDBCPDataSource and used to initialize another AnterosDBCPDataSource instance.

Parameters:

configuration - a AnterosDBCPConfig instance

Method Detail

getConnection

public Connection getConnection()
                         throws SQLException

Specified by:

getConnection in interface DataSource

Throws:

SQLException

getConnection

public Connection getConnection(String username,
                                String password)
                         throws SQLException

Specified by:

getConnection in interface DataSource

Throws:

SQLException

getLogWriter

public PrintWriter getLogWriter()
                         throws SQLException

Specified by:

getLogWriter in interface CommonDataSource

Throws:

SQLException

setLogWriter

public void setLogWriter(PrintWriter out)
                  throws SQLException

Specified by:

setLogWriter in interface CommonDataSource

Throws:

SQLException

setLoginTimeout

public void setLoginTimeout(int seconds)
                     throws SQLException

Specified by:

setLoginTimeout in interface CommonDataSource

Throws:

SQLException

getLoginTimeout

public int getLoginTimeout()
                    throws SQLException

Specified by:

getLoginTimeout in interface CommonDataSource

Throws:

SQLException

getParentLogger

public Logger getParentLogger()
                       throws SQLFeatureNotSupportedException

Specified by:

getParentLogger in interface CommonDataSource

Throws:

SQLFeatureNotSupportedException

unwrap

public <T> T unwrap(Class<T> iface)
             throws SQLException

Specified by:

unwrap in interface Wrapper

Throws:

SQLException

isWrapperFor

public boolean isWrapperFor(Class<?> iface)
                     throws SQLException

Specified by:

isWrapperFor in interface Wrapper

Throws:

SQLException

setMetricRegistry

public void setMetricRegistry(Object metricRegistry)

Set a MetricRegistry instance to use for registration of metrics used by AnterosDBCPCP.

Overrides:

setMetricRegistry in class AnterosDBCPConfig

Parameters:

metricRegistry - the MetricRegistry instance to use

setMetricsTrackerFactory

public void setMetricsTrackerFactory(MetricsTrackerFactory metricsTrackerFactory)

Overrides:

setMetricsTrackerFactory in class AnterosDBCPConfig

setHealthCheckRegistry

public void setHealthCheckRegistry(Object healthCheckRegistry)

Set the HealthCheckRegistry that will be used for registration of health checks by AnterosDBCPCP. Currently only Codahale/DropWizard is supported for health checks. Default is null.

Overrides:

setHealthCheckRegistry in class AnterosDBCPConfig

Parameters:

healthCheckRegistry - the HealthCheckRegistry to be used

isRunning

public boolean isRunning()

Returns true if the pool as been started and is not suspended or shutdown.

Returns:

true if the pool as been started and is not suspended or shutdown.

getAnterosDBCPPoolMXBean

public AnterosDBCPPoolMXBean getAnterosDBCPPoolMXBean()

Get the AnterosDBCPPoolMXBean for this AnterosDBCPDataSource instance. If this method is called on a AnterosDBCPDataSource that has been constructed without a AnterosDBCPConfig instance, and before an initial call to #getConnection(), the return value will be null.

Returns:

the AnterosDBCPPoolMXBean instance, or null.

getAnterosDBCPConfigMXBean

public AnterosDBCPConfigMXBean getAnterosDBCPConfigMXBean()

Get the AnterosDBCPConfigMXBean for this AnterosDBCPDataSource instance.

Returns:

the AnterosDBCPConfigMXBean instance.

evictConnection

public void evictConnection(Connection connection)

Evict a connection from the pool. If the connection has already been closed (returned to the pool) this may result in a "soft" eviction; the connection will be evicted sometime in the future if it is currently in use. If the connection has not been closed, the eviction is immediate.

Parameters:

connection - the connection to evict from the pool

close

public void close()

Shutdown the DataSource and its associated pool.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

isClosed

public boolean isClosed()

Determine whether the AnterosDBCPDataSource has been closed.

Returns:

true if the AnterosDBCPDataSource has been closed, false otherwise

toString

public String toString()

Overrides:

toString in class Object