org.apache.commons.dbcp2

Class PoolingDataSource<C extends java.sql.Connection>

java.lang.Object

org.apache.commons.dbcp2.PoolingDataSource<C>

Type Parameters:

C - The connection type

All Implemented Interfaces:

java.lang.AutoCloseable, java.sql.Wrapper, javax.sql.CommonDataSource, javax.sql.DataSource

Direct Known Subclasses:

ManagedDataSource

public class PoolingDataSource<C extends java.sql.Connection>
extends java.lang.Object
implements javax.sql.DataSource, java.lang.AutoCloseable

A simple DataSource implementation that obtains Connections from the specified ObjectPool.

Since:

2.0

Version:

$Id: PoolingDataSource.java 1677110 2015-05-01 11:15:22Z sebb $

Author:

Rodney Waldhoff, Glenn L. Nielsen, James House, Dirk Verbeeck

Constructor Summary

Constructors

Constructor and Description
PoolingDataSource(org.apache.commons.pool2.ObjectPool<C> pool)

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close and free all Connections from the pool.
java.sql.Connection	getConnection() Return a Connection from my pool, according to the contract specified by ObjectPool.borrowObject().
java.sql.Connection	getConnection(java.lang.String uname, java.lang.String passwd) Throws UnsupportedOperationException
int	getLoginTimeout() Throws UnsupportedOperationException.
java.io.PrintWriter	getLogWriter() Returns my log writer.
java.util.logging.Logger	getParentLogger()
boolean	isAccessToUnderlyingConnectionAllowed() Returns the value of the accessToUnderlyingConnectionAllowed property.
boolean	isWrapperFor(java.lang.Class<?> iface)
void	setAccessToUnderlyingConnectionAllowed(boolean allow) Sets the value of the accessToUnderlyingConnectionAllowed property.
void	setLoginTimeout(int seconds) Throws UnsupportedOperationException.
void	setLogWriter(java.io.PrintWriter out) Sets my log writer.
<T> T	unwrap(java.lang.Class<T> iface)

Methods inherited from class java.lang.Object

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

Constructor Detail

PoolingDataSource

public PoolingDataSource(org.apache.commons.pool2.ObjectPool<C> pool)

Method Detail

close

public void close()
           throws java.lang.Exception

Close and free all Connections from the pool.

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.lang.Exception

Since:

2.1

getConnection

public java.sql.Connection getConnection()
                                  throws java.sql.SQLException

Return a Connection from my pool, according to the contract specified by ObjectPool.borrowObject().

Specified by:

getConnection in interface javax.sql.DataSource

Throws:

java.sql.SQLException

getConnection

public java.sql.Connection getConnection(java.lang.String uname,
                                java.lang.String passwd)
                                  throws java.sql.SQLException

Throws UnsupportedOperationException

Specified by:

getConnection in interface javax.sql.DataSource

Throws:

java.lang.UnsupportedOperationException

java.sql.SQLException

getLoginTimeout

public int getLoginTimeout()

Throws UnsupportedOperationException.

Specified by:

getLoginTimeout in interface javax.sql.CommonDataSource

Throws:

java.lang.UnsupportedOperationException - As this implementation does not support this feature.

getLogWriter

public java.io.PrintWriter getLogWriter()

Returns my log writer.

Specified by:

getLogWriter in interface javax.sql.CommonDataSource

Returns:

my log writer

See Also:

CommonDataSource.getLogWriter()

getParentLogger

public java.util.logging.Logger getParentLogger()
                                         throws java.sql.SQLFeatureNotSupportedException

Specified by:

getParentLogger in interface javax.sql.CommonDataSource

Throws:

java.sql.SQLFeatureNotSupportedException

isAccessToUnderlyingConnectionAllowed

public boolean isAccessToUnderlyingConnectionAllowed()

Returns the value of the accessToUnderlyingConnectionAllowed property.

Returns:

true if access to the underlying Connection is allowed, false otherwise.

isWrapperFor

public boolean isWrapperFor(java.lang.Class<?> iface)
                     throws java.sql.SQLException

Specified by:

isWrapperFor in interface java.sql.Wrapper

Throws:

java.sql.SQLException

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)

Parameters:

allow - Access to the underlying connection is granted when true.

setLoginTimeout

public void setLoginTimeout(int seconds)

Throws UnsupportedOperationException.

Specified by:

setLoginTimeout in interface javax.sql.CommonDataSource

Throws:

java.lang.UnsupportedOperationException - As this implementation does not support this feature.

setLogWriter

public void setLogWriter(java.io.PrintWriter out)

Sets my log writer.

Specified by:

setLogWriter in interface javax.sql.CommonDataSource

See Also:

CommonDataSource.setLogWriter(java.io.PrintWriter)

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