Interface ConnectionPool

All Known Implementing Classes:
DefaultConnectionPool, JNDIConnectionPool

public interface ConnectionPool
An interface used to build wrapper classes around existing Connection Pool libraries. Title: ConnectionPool

Version:
1.0
Author:
John Gentilin
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    Start downsizeing the pool, this usally happens right after the pool has been marked as Inactive and we are removing connections that are not currently inuse.
    Retrive a database connection from the pool
    boolean
    Provide an indicator to the PoolManager when the Pool can be removed from the Pool Table.
    boolean
    Determine if a Connection Pool has been disabled.
    void
    Return a connection to the pool, the connection may be closed if the pool is inactive or has exceeded the max number of free connections
    void
    Provide a mechinism to return a connection to the pool on Error.
    void
    The Driver and URL are the only required parmeters.
    void
    Set tne minimum number of connections that are to be maintained in the pool.
    void
    The rest of the protocol parameters can eiter be passed in as just Username and Password or as a property collection.
    void
    setPoolEnabled(boolean flag)
    The Pool can be Enabled and Disabled.
    void
    Used to pass in extra configuration options during the database connect phase.
    void
     
    void
     
    boolean
    Test to see if the connection info is valid to make a real connection to the database.
  • Method Details

    • isEnabled

      boolean isEnabled()
      Determine if a Connection Pool has been disabled. If a Connection pool is disabled, then it will only manage connections that are in use.
    • setDriver

      void setDriver(String d)
      The Driver and URL are the only required parmeters.
      Parameters:
      d -
    • setURL

      void setURL(String url)
      Parameters:
      url -
    • freeUnused

      void freeUnused()
      Start downsizeing the pool, this usally happens right after the pool has been marked as Inactive and we are removing connections that are not currently inuse.
    • hasActiveConnections

      boolean hasActiveConnections()
      Provide an indicator to the PoolManager when the Pool can be removed from the Pool Table.
    • setPassword

      void setPassword(String p)
      The rest of the protocol parameters can eiter be passed in as just Username and Password or as a property collection. If the property collection is used, then the sperate username and password may be ignored, it is up to the wrapper implementation to handle the situation. If the connection information changes while after the pool has been established, the wrapper implementation should ignore the change and throw an error.
      Parameters:
      p -
    • setUser

      void setUser(String u)
      Parameters:
      u -
    • setMinConnections

      void setMinConnections(int n)
      Set tne minimum number of connections that are to be maintained in the pool.
      Parameters:
      n -
    • testConnection

      boolean testConnection()
      Test to see if the connection info is valid to make a real connection to the database. This method may cause the pool to be crated and filled with min connections.
    • getConnection

      Connection getConnection() throws SQLException
      Retrive a database connection from the pool
      Throws:
      SQLException
    • releaseConnection

      void releaseConnection(Connection con) throws SQLException
      Return a connection to the pool, the connection may be closed if the pool is inactive or has exceeded the max number of free connections
      Parameters:
      con -
      Throws:
      SQLException
    • releaseConnectionOnError

      void releaseConnectionOnError(Connection con) throws SQLException
      Provide a mechinism to return a connection to the pool on Error. A good default behaviour is to close this connection and build a new one to replace it. Some JDBC impl's won't allow you to reuse a connection after an error occurs.
      Parameters:
      con -
      Throws:
      SQLException
    • setPoolEnabled

      void setPoolEnabled(boolean flag)
      The Pool can be Enabled and Disabled. Disabling the pool closes all the outstanding Unused connections and any new connections will be closed upon release.
      Parameters:
      flag - Control the Connection Pool. If it is enabled then Connections will actuall be held around. If disabled then all unused connections will be instantly closed and as connections are released they are closed and removed from the pool.
    • setProtocol

      void setProtocol(Properties p)
      Used to pass in extra configuration options during the database connect phase.