org.apache.commons.dbcp
Class PoolingDriver

java.lang.Object
  extended by org.apache.commons.dbcp.PoolingDriver
All Implemented Interfaces:
Driver

public class PoolingDriver
extends Object
implements Driver

A Driver implementation that obtains Connections from a registered ObjectPool.

Version:
$Revision: 892307 $ $Date: 2013-12-31 23:27:28 +0000 (Tue, 31 Dec 2013) $
Author:
Rodney Waldhoff, Dirk Verbeeck

Field Summary
protected static HashMap _pools
          The map of registered pools.
protected static int MAJOR_VERSION
           
protected static int MINOR_VERSION
           
protected static String URL_PREFIX
          My URL prefix
protected static int URL_PREFIX_LEN
           
 
Constructor Summary
PoolingDriver()
           
 
Method Summary
 boolean acceptsURL(String url)
           
 void closePool(String name)
           
 Connection connect(String url, Properties info)
           
 ObjectPool getConnectionPool(String name)
           
 int getMajorVersion()
           
 int getMinorVersion()
           
 ObjectPool getPool(String name)
          Deprecated. This will be removed in a future version of DBCP.
 String[] getPoolNames()
           
 DriverPropertyInfo[] getPropertyInfo(String url, Properties info)
           
 void invalidateConnection(Connection conn)
          Invalidates the given connection.
static boolean isAccessToUnderlyingConnectionAllowed()
          Returns the value of the accessToUnderlyingConnectionAllowed property.
 boolean jdbcCompliant()
           
 void registerPool(String name, ObjectPool pool)
           
static void setAccessToUnderlyingConnectionAllowed(boolean allow)
          Sets the value of the accessToUnderlyingConnectionAllowed property.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

_pools

protected static final HashMap _pools
The map of registered pools.


URL_PREFIX

protected static final String URL_PREFIX
My URL prefix

See Also:
Constant Field Values

URL_PREFIX_LEN

protected static final int URL_PREFIX_LEN

MAJOR_VERSION

protected static final int MAJOR_VERSION
See Also:
Constant Field Values

MINOR_VERSION

protected static final int MINOR_VERSION
See Also:
Constant Field Values
Constructor Detail

PoolingDriver

public PoolingDriver()
Method Detail

isAccessToUnderlyingConnectionAllowed

public static boolean isAccessToUnderlyingConnectionAllowed()
Returns the value of the accessToUnderlyingConnectionAllowed property.

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

setAccessToUnderlyingConnectionAllowed

public static 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.

getPool

public ObjectPool getPool(String name)
Deprecated. This will be removed in a future version of DBCP.

WARNING: This method throws DbcpExceptions (RuntimeExceptions) and will be replaced by the protected getConnectionPool method.


getConnectionPool

public ObjectPool getConnectionPool(String name)
                             throws SQLException
Throws:
SQLException

registerPool

public void registerPool(String name,
                         ObjectPool pool)

closePool

public void closePool(String name)
               throws SQLException
Throws:
SQLException

getPoolNames

public String[] getPoolNames()

acceptsURL

public boolean acceptsURL(String url)
                   throws SQLException
Specified by:
acceptsURL in interface Driver
Throws:
SQLException

connect

public Connection connect(String url,
                          Properties info)
                   throws SQLException
Specified by:
connect in interface Driver
Throws:
SQLException

invalidateConnection

public void invalidateConnection(Connection conn)
                          throws SQLException
Invalidates the given connection.

Parameters:
conn - connection to invalidate
Throws:
SQLException - if the connection is not a PoolGuardConnectionWrapper or an error occurs invalidating the connection
Since:
1.2.2

getMajorVersion

public int getMajorVersion()
Specified by:
getMajorVersion in interface Driver

getMinorVersion

public int getMinorVersion()
Specified by:
getMinorVersion in interface Driver

jdbcCompliant

public boolean jdbcCompliant()
Specified by:
jdbcCompliant in interface Driver

getPropertyInfo

public DriverPropertyInfo[] getPropertyInfo(String url,
                                            Properties info)
Specified by:
getPropertyInfo in interface Driver


Copyright © 2001-2010 The Apache Software Foundation. All Rights Reserved.