org.vibur.dbcp

Class ViburDBCPDataSource

java.lang.Object

org.vibur.dbcp.ViburConfig

org.vibur.dbcp.ViburDBCPDataSource

All Implemented Interfaces:

AutoCloseable, Wrapper, CommonDataSource, DataSource, ViburDataSource

public class ViburDBCPDataSource
extends ViburConfig
implements ViburDataSource

The main DataSource which needs to be configured/instantiated by the calling application and from which the JDBC Connections will be obtained via calling the getConnection() method. The lifecycle operations of this DataSource, as well as the other specific to it operations, are defined by the ViburDataSource interface.

Author:

Simeon Malchev

See Also:

DataSource, ConnectionFactory

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ViburDBCPDataSource.ConnectionInvalidator

Nested classes/interfaces inherited from interface org.vibur.dbcp.ViburDataSource

ViburDataSource.State

Field Summary

Fields inherited from class org.vibur.dbcp.ViburConfig

DEFAULT_PROPERTIES_CONFIG_FILE_NAME, DEFAULT_XML_CONFIG_FILE_NAME, IS_VALID_QUERY, SQLSTATE_CONN_INIT_ERROR, SQLSTATE_INTERRUPTED_ERROR, SQLSTATE_OBJECT_CLOSED_ERROR, SQLSTATE_POOL_CLOSED_ERROR, SQLSTATE_POOL_NOTSTARTED_ERROR, SQLSTATE_TIMEOUT_ERROR, SQLSTATE_WRAPPER_ERROR

Constructor Summary

Constructors

Constructor and Description
ViburDBCPDataSource() Default constructor for programmatic configuration via the ViburConfig setter methods.
ViburDBCPDataSource(Properties properties) Initialization via the given properties.
ViburDBCPDataSource(String configFileName) Initialization via properties file name.

Method Summary

Modifier and Type	Method and Description
void	close() A synonym for ViburDataSource.terminate().
Connection	getConnection()
Connection	getConnection(String username, String password)
int	getLoginTimeout()
PrintWriter	getLogWriter()
Connection	getNonPooledConnection() Returns a raw (non-pooled) JDBC Connection using the default username and password.
Connection	getNonPooledConnection(String username, String password) Returns a raw (non-pooled) JDBC Connection using the supplied username and password.
Logger	getParentLogger()
ViburDataSource.State	getState() Returns this DataSource current state.
TakenConnection[]	getTakenConnections() Returns an array of all taken proxy Connections.
String	getTakenConnectionsStackTraces() Generates information about all currently taken connections, including the stack traces of the threads that have taken them, plus the threads names and states.
boolean	isWrapperFor(Class<?> iface)
void	setLoginTimeout(int seconds)
void	setLogWriter(PrintWriter out)
void	severConnection(Connection connection) Severs the supplied connection which can either be a pooled connection retrieved via calling one of the ViburDataSource.getConnection() methods or a raw non-pooled connection retrieved via calling one of the ViburDataSource.getNonPooledConnection() methods.
void	start() Starts this DataSource.
void	terminate() Terminates this DataSource.
<T> T	unwrap(Class<T> iface)

Methods inherited from class org.vibur.dbcp.ViburConfig

getAcquireRetryAttempts, getAcquireRetryDelayInMs, getConcurrentCollection, getConnectionFactory, getConnectionIdleLimitInSeconds, getConnectionTimeoutInMs, getConnector, getConnHooks, getCriticalSQLStates, getDefaultAutoCommit, getDefaultCatalog, getDefaultReadOnly, getDefaultTransactionIsolation, getDefaultTransactionIsolationIntValue, getDriver, getDriverClassName, getDriverProperties, getExternalDataSource, getInitSQL, getInvocationHooks, getJdbcUrl, getJmxName, getLogConnectionLongerThanMs, getLoginTimeoutInSeconds, getLogLargeResultSet, getLogLineRegex, getLogQueryExecutionLongerThanMs, getName, getNetworkTimeoutExecutor, getPassword, getPool, getPoolInitialSize, getPoolMaxSize, getPoolReducer, getPoolReducerClass, getReducerSamples, getReducerTimeIntervalInSeconds, getStatementCache, getStatementCacheMaxSize, getTakenConnectionsFormatter, getTestConnectionQuery, getUsername, getValidateTimeoutInSeconds, isAllowConnectionAfterTermination, isAllowUnwrapping, isClearSQLWarnings, isEnableJMX, isIncludeQueryParameters, isLogAllStackTracesOnTimeout, isLogStackTraceForLargeResultSet, isLogStackTraceForLongConnection, isLogStackTraceForLongQueryExecution, isLogTakenConnectionsOnTimeout, isPoolEnableConnectionTracking, isPoolFair, isResetDefaultsAfterUse, isUseNetworkTimeout, setAcquireRetryAttempts, setAcquireRetryDelayInMs, setAllowConnectionAfterTermination, setAllowUnwrapping, setClearSQLWarnings, setConcurrentCollection, setConnectionFactory, setConnectionIdleLimitInSeconds, setConnectionTimeoutInMs, setConnector, setCriticalSQLStates, setDefaultAutoCommit, setDefaultCatalog, setDefaultReadOnly, setDefaultTransactionIsolation, setDefaultTransactionIsolationIntValue, setDriver, setDriverClassName, setDriverProperties, setEnableJMX, setExternalDataSource, setIncludeQueryParameters, setInitSQL, setJdbcUrl, setLogAllStackTracesOnTimeout, setLogConnectionLongerThanMs, setLoginTimeoutInSeconds, setLogLargeResultSet, setLogLineRegex, setLogQueryExecutionLongerThanMs, setLogStackTraceForLargeResultSet, setLogStackTraceForLongConnection, setLogStackTraceForLongQueryExecution, setLogTakenConnectionsOnTimeout, setName, setNetworkTimeoutExecutor, setPassword, setPool, setPoolEnableConnectionTracking, setPoolFair, setPoolInitialSize, setPoolMaxSize, setPoolReducer, setPoolReducerClass, setReducerSamples, setReducerTimeIntervalInSeconds, setResetDefaultsAfterUse, setStatementCache, setStatementCacheMaxSize, setTakenConnectionsFormatter, setTestConnectionQuery, setUseNetworkTimeout, setUsername, setValidateTimeoutInSeconds, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ViburDBCPDataSource

public ViburDBCPDataSource()

Default constructor for programmatic configuration via the ViburConfig setter methods.

ViburDBCPDataSource

public ViburDBCPDataSource(String configFileName)
                    throws ViburDBCPException

Initialization via properties file name. Must be either standard properties file or XML file which is complaint with "http://java.sun.com/dtd/properties.dtd".

configFileName can be null in which case the default resource file names ViburConfig.DEFAULT_XML_CONFIG_FILE_NAME or ViburConfig.DEFAULT_PROPERTIES_CONFIG_FILE_NAME will be loaded, in this order.

Parameters:

configFileName - the properties config file name

Throws:

ViburDBCPException - if cannot configure this DataSource successfully

ViburDBCPDataSource

public ViburDBCPDataSource(Properties properties)
                    throws ViburDBCPException

Initialization via the given properties.

Parameters:

properties - the given properties

Throws:

ViburDBCPException - if cannot configure this DataSource successfully

Method Detail

start

public void start()
           throws ViburDBCPException

Starts this DataSource. In order to be used, the implementing DataSource has to be first created via calling one of the available constructors, configured, and then started via calling this method. Any necessary validation of the configuration will be performed as part of this call.

Specified by:

start in interface ViburDataSource

Throws:

ViburDBCPException - if not in a NEW state when started; if a configuration error is found during start; if cannot start this DataSource successfully, that is, if cannot successfully initialize/configure the underlying SQL system, if cannot create the underlying SQL connections, if cannot initialize the configured/needed JDBC Driver, if cannot create the configured pool reducer, or if cannot initialize JMX

terminate

public void terminate()

Description copied from interface: ViburDataSource

Terminates this DataSource. Once terminated the DataSource cannot be more revived.

Specified by:

terminate in interface ViburDataSource

close

public void close()

Description copied from interface: ViburDataSource

A synonym for ViburDataSource.terminate(). Overrides the AutoCloseable's method in order to overrule the throwing of a checked Exception.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface ViburDataSource

getState

public ViburDataSource.State getState()

Description copied from interface: ViburDataSource

Returns this DataSource current state.

Specified by:

getState in interface ViburDataSource

getConnection

public Connection getConnection()
                         throws SQLException

Description copied from interface: ViburDataSource

Specified by:

getConnection in interface DataSource

Specified by:

getConnection in interface ViburDataSource

Throws:

SQLException

getConnection

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

Description copied from interface: ViburDataSource

This method will return a raw (non-pooled) JDBC Connection when called with credentials different than the configured default credentials.

Specified by:

getConnection in interface DataSource

Specified by:

getConnection in interface ViburDataSource

Throws:

SQLException

getNonPooledConnection

public Connection getNonPooledConnection()
                                  throws SQLException

Description copied from interface: ViburDataSource

Returns a raw (non-pooled) JDBC Connection using the default username and password.

Specified by:

getNonPooledConnection in interface ViburDataSource

Throws:

SQLException - if an error occurs while creating the connection

getNonPooledConnection

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

Description copied from interface: ViburDataSource

Returns a raw (non-pooled) JDBC Connection using the supplied username and password.

Specified by:

getNonPooledConnection in interface ViburDataSource

Parameters:

username - the database username

password - the database password

Throws:

SQLException - if an error occurs while creating the connection

severConnection

public void severConnection(Connection connection)
                     throws SQLException

Description copied from interface: ViburDataSource

Severs the supplied connection which can either be a pooled connection retrieved via calling one of the ViburDataSource.getConnection() methods or a raw non-pooled connection retrieved via calling one of the ViburDataSource.getNonPooledConnection() methods. If the supplied connection is pooled, it will be closed and removed from the pool and its underlying raw connection will be closed, too. In the case when the supplied connection is non-pooled, it will be just closed.

Calling this method on a pooled or non-pooled connection that is already closed is a no-op. When the severConnection method returns, the connection on which it is called will be marked as closed.

Specified by:

severConnection in interface ViburDataSource

Parameters:

connection - the connection to be severed

Throws:

SQLException - if an error occurs while closing/severing the connection

getTakenConnectionsStackTraces

public String getTakenConnectionsStackTraces()

Description copied from interface: ViburDataSource

Generates information about all currently taken connections, including the stack traces of the threads that have taken them, plus the threads names and states. This method implies that that the ViburConfig.poolEnableConnectionTracking option is enabled.

The exact format of the logged message is controlled by ViburConfig.takenConnectionsFormatter.

Also see ViburConfig.logTakenConnectionsOnTimeout and ViburDataSource.getTakenConnections().

Specified by:

getTakenConnectionsStackTraces in interface ViburDataSource

getTakenConnections

public TakenConnection[] getTakenConnections()

Description copied from interface: ViburDataSource

Returns an array of all taken proxy Connections. Note that this is just a snapshot of the taken Connections at the moment of the method call; the closed/restored state of some (or all) of the returned Connections may change immediately after this method returns. This method implies that that the ViburConfig.poolEnableConnectionTracking option is enabled.

Also see ViburDataSource.getTakenConnectionsStackTraces().

Specified by:

getTakenConnections in interface ViburDataSource

Returns:

an array of all taken proxy Connections

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)

Specified by:

setLoginTimeout in interface CommonDataSource

getLoginTimeout

public int getLoginTimeout()

Specified by:

getLoginTimeout in interface CommonDataSource

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)

Specified by:

isWrapperFor in interface Wrapper