Interface IDBConnectionPool


  • public interface IDBConnectionPool
    Interface used to retrieve a connection from a connection pool.
    Author:
    Christopher Mindus
    • Field Detail

      • FLAVOR_UNKNOWN

        static final int FLAVOR_UNKNOWN
        Unknown flavor for JDBC Driver.
        See Also:
        Constant Field Values
      • FLAVOR_SQLSERVER

        static final int FLAVOR_SQLSERVER
        Flavor for JDBC: SQL Server.
        See Also:
        Constant Field Values
      • PN_DESCRIPTION

        static final java.lang.String PN_DESCRIPTION
        Property name: description.
        See Also:
        Constant Field Values
      • PN_CLASS_PATH

        static final java.lang.String PN_CLASS_PATH
        Property name: class path, comma separated. Specify comma twice for a single comma.
        See Also:
        Constant Field Values
      • PN_DRIVER_CLASS_NAME

        static final java.lang.String PN_DRIVER_CLASS_NAME
        Property name: driver class name.
        See Also:
        Constant Field Values
      • PN_USER_NAME

        static final java.lang.String PN_USER_NAME
        Property name: user name.
        See Also:
        Constant Field Values
      • PN_PASSWORD

        static final java.lang.String PN_PASSWORD
        Property name: password.
        See Also:
        Constant Field Values
      • PN_DEFAULT_AUTO_COMMIT

        static final java.lang.String PN_DEFAULT_AUTO_COMMIT
        Property name: default auto-commit flag.
        See Also:
        Constant Field Values
    • Method Detail

      • getConnection

        java.sql.Connection getConnection()
                                   throws java.sql.SQLException
        Gets a connection from the pool.
        Throws:
        java.sql.SQLException - For SQL errors.
      • getName

        java.lang.String getName()
        Gets the name of the connection pool.
        Returns:
        The name of the connection pool.
      • dispose

        void dispose()
              throws java.sql.SQLException
        Disposes of the pool.

        Closes and releases all idle connections that are currently stored in the connection pool associated with this data source.

        Connections that are checked out to clients when this method is invoked are not affected. When client applications subsequently invoke Connection.close() to return these connections to the pool, the underlying JDBC connections are closed.

        Attempts to acquire connections using getConnection() after this method has been invoked result in SQLExceptions.

        This method is idempotent - i.e., closing an already closed BasicDataSource has no effect and does not generate exceptions.

        Throws:
        java.sql.SQLException - If an error occurs closing idle connections
      • isDisposed

        boolean isDisposed()
        Checks if the connection pool is disposed of.
        Returns:
        true for disposed of, false if not disposed of and ready.