Package org.apache.commons.dbcp2

Class PoolingDataSource<C extends java.sql.Connection>

  • 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 Description
      PoolingDataSource​(org.apache.commons.pool2.ObjectPool<C> pool)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method 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

      • Methods inherited from interface javax.sql.CommonDataSource

        createShardingKeyBuilder

      • Methods inherited from interface javax.sql.DataSource

        createConnectionBuilder

    • 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

      • isAccessToUnderlyingConnectionAllowed

        public boolean isAccessToUnderlyingConnectionAllowed()
        Returns the value of the accessToUnderlyingConnectionAllowed property.
        Returns:
        true if access to the underlying Connection 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​(java.lang.Class<?> iface)
                     throws java.sql.SQLException
        Specified by:
        isWrapperFor in interface java.sql.Wrapper
        Throws:
        java.sql.SQLException

      • 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

      • getParentLogger

        public java.util.logging.Logger getParentLogger()
                                         throws java.sql.SQLFeatureNotSupportedException
        Specified by:
        getParentLogger in interface javax.sql.CommonDataSource
        Throws:
        java.sql.SQLFeatureNotSupportedException

      • 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

      • getLogWriter

        public java.io.PrintWriter getLogWriter()
        Returns my log writer.
        Specified by:
        getLogWriter in interface javax.sql.CommonDataSource
        Specified by:
        getLogWriter in interface javax.sql.DataSource
        Returns:
        my log writer
        See Also:
        DataSource.getLogWriter()

      • getLoginTimeout

        public int getLoginTimeout()
        Throws UnsupportedOperationException.
        Specified by:
        getLoginTimeout in interface javax.sql.CommonDataSource
        Specified by:
        getLoginTimeout in interface javax.sql.DataSource
        Throws:
        java.lang.UnsupportedOperationException - As this implementation does not support this feature.

      • setLoginTimeout

        public void setLoginTimeout​(int seconds)
        Throws UnsupportedOperationException.
        Specified by:
        setLoginTimeout in interface javax.sql.CommonDataSource
        Specified by:
        setLoginTimeout in interface javax.sql.DataSource
        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
        Specified by:
        setLogWriter in interface javax.sql.DataSource
        See Also:
        DataSource.setLogWriter(java.io.PrintWriter)