org.apache.commons.dbcp
Class PoolingDataSource

java.lang.Object
  org.apache.commons.dbcp.PoolingDataSource

All Implemented Interfaces:

Wrapper, CommonDataSource, DataSource

Direct Known Subclasses:

ManagedDataSource

public class PoolingDataSource
extends Object
implements DataSource

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

Version:

$Revision: 895844 $ $Date: 2010-01-04 20:50:04 -0500 (Mon, 04 Jan 2010) $

Author:

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

Field Summary

protected PrintWriter	_logWriter My log writer.
protected ObjectPool	_pool

Constructor Summary

PoolingDataSource()

PoolingDataSource(ObjectPool pool)

Method Summary

Connection	getConnection() Return a Connection from my pool, according to the contract specified by ObjectPool.borrowObject().
Connection	getConnection(String uname, String passwd) Throws UnsupportedOperationException
int	getLoginTimeout() Throws UnsupportedOperationException.
PrintWriter	getLogWriter() Returns my log writer.
boolean	isAccessToUnderlyingConnectionAllowed() Returns the value of the accessToUnderlyingConnectionAllowed property.
boolean	isWrapperFor(Class<?> iface)
void	setAccessToUnderlyingConnectionAllowed(boolean allow) Sets the value of the accessToUnderlyingConnectionAllowed property.
void	setLoginTimeout(int seconds) Throws UnsupportedOperationException.
void	setLogWriter(PrintWriter out) Sets my log writer.
void	setPool(ObjectPool pool)
<T> T	unwrap(Class<T> iface)

Methods inherited from class java.lang.Object

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

Field Detail

_logWriter

protected PrintWriter _logWriter

My log writer.

_pool

protected ObjectPool _pool

Constructor Detail

PoolingDataSource

public PoolingDataSource()

PoolingDataSource

public PoolingDataSource(ObjectPool pool)

Method Detail

setPool

public void setPool(ObjectPool pool)
             throws IllegalStateException,
                    NullPointerException

Throws:

IllegalStateException

NullPointerException

isAccessToUnderlyingConnectionAllowed

public boolean isAccessToUnderlyingConnectionAllowed()

Returns the value of the accessToUnderlyingConnectionAllowed property.

Returns:

true if access to the underlying 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)

Parameters:

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

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

getConnection

public Connection getConnection()
                         throws SQLException

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

Specified by:

getConnection in interface DataSource

Throws:

SQLException

getConnection

public Connection getConnection(String uname,
                                String passwd)
                         throws SQLException

Throws UnsupportedOperationException

Specified by:

getConnection in interface DataSource

Throws:

UnsupportedOperationException

SQLException

getLogWriter

public PrintWriter getLogWriter()

Returns my log writer.

Specified by:

getLogWriter in interface CommonDataSource

Returns:

my log writer

See Also:

CommonDataSource.getLogWriter()

getLoginTimeout

public int getLoginTimeout()

Throws UnsupportedOperationException.

Specified by:

getLoginTimeout in interface CommonDataSource

Throws:

UnsupportedOperationException - As this implementation does not support this feature.

setLoginTimeout

public void setLoginTimeout(int seconds)

Throws UnsupportedOperationException.

Specified by:

setLoginTimeout in interface CommonDataSource

Throws:

UnsupportedOperationException - As this implementation does not support this feature.

setLogWriter

public void setLogWriter(PrintWriter out)

Sets my log writer.

Specified by:

setLogWriter in interface CommonDataSource

See Also:

CommonDataSource.setLogWriter(java.io.PrintWriter)