Package com.gargoylesoftware.base.resource.jdbc

Class ConnectionWrapper

  • All Implemented Interfaces:
    ManagedResource, java.lang.AutoCloseable, java.sql.Connection, java.sql.Wrapper
    public final class ConnectionWrapper
extends java.lang.Object
implements java.sql.Connection, ManagedResource
    A wrapper for java.sql.Connection objects.

    The contract with JDBC says that result sets must be closed before statements and statements must be closed before connections but java does not enforce this contract. It is quite possible to close a connection while statements and result sets are still open. While some database drivers handle this condition nicely, others will start failing in undefined ways when this happens.

    This wrapper class is a solution to this problem. If the connection is only accessed through the wrapper then the wrapper will ensure that everything is closed in the correct order. It will also ensure that the various jdbc objects (connections, statements, result sets and metadata) cannot be used after they are closed.

    This class was created for the JDBCResourceFactory but can be used by itself.

    Version:
    $Revision: 1.4 $

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.sql.Connection delegate_  
      private boolean isOpen_  
      private java.util.List openDatabaseMetaData_  
      private java.util.List openStatements_  
      private java.lang.String resourceFactoryName_  

      • Fields inherited from interface java.sql.Connection

        TRANSACTION_NONE, TRANSACTION_READ_COMMITTED, TRANSACTION_READ_UNCOMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE

    • Constructor Summary

      Constructors 
      Constructor Description
      ConnectionWrapper​(java.sql.Connection connection)
      Create a new connection wrapper

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void abort​(java.util.concurrent.Executor executor)  
      private void checkConnection()
      Check to see if the connection is still open.
      void clearWarnings()
      Clears all warnings reported for this Connection object.
      void close()
      Releases a Connection's database and JDBC resources immediately instead of waiting for them to be automatically released.
      void closeAnyOpenMetaDatas()
      Close any open DatabaseMetaData objects
      void closeAnyOpenStatements()
      Close any open statements
      void commit()
      Makes all changes made since the previous commit/rollback permanent and releases any database locks currently held by the Connection.
      java.sql.Array createArrayOf​(java.lang.String typeName, java.lang.Object[] elements)  
      java.sql.Blob createBlob()  
      java.sql.Clob createClob()  
      java.sql.NClob createNClob()  
      java.sql.SQLXML createSQLXML()  
      java.sql.Statement createStatement()
      Creates a Statement object for sending SQL statements to the database.
      java.sql.Statement createStatement​(int resultSetType, int resultSetConcurrency)
      Creates a Statement object that will generate ResultSet objects with the given type and concurrency.
      java.sql.Statement createStatement​(int resultSetType, int resultSetConcurrency, int resultSetHoldability)
      Creates a Statement object that will generate ResultSet objects with the given type, concurrency, and holdability.
      java.sql.Struct createStruct​(java.lang.String typeName, java.lang.Object[] attributes)  
      boolean getAutoCommit()
      Gets the current auto-commit state.
      java.lang.String getCatalog()
      Returns the Connection's current catalog name.
      java.util.Properties getClientInfo()  
      java.lang.String getClientInfo​(java.lang.String name)  
      java.sql.Connection getDelegate()
      Return the wrapped connection
      int getHoldability()
      Retrieves the current holdability of ResultSet objects created using this Connection object.
      java.sql.DatabaseMetaData getMetaData()
      Gets the metadata regarding this connection's database.
      int getNetworkTimeout()  
      int getOpenStatementCount()
      Return the number of statements that are currently open.
      java.lang.String getResourceFactoryName()
      Return the name of the factory that allocated this connection
      java.lang.String getSchema()  
      int getTransactionIsolation()
      Gets this Connection's current transaction isolation level.
      java.util.Map getTypeMap()
      Gets the type map object associated with this connection.
      java.sql.SQLWarning getWarnings()
      Returns the first warning reported by calls on this Connection.
      boolean isClosed()
      Tests to see if a Connection is closed.
      boolean isReadOnly()
      Tests to see if the connection is in read-only mode.
      boolean isValid​(int timeout)  
      boolean isWrapperFor​(java.lang.Class<?> iface)  
      java.lang.String nativeSQL​(java.lang.String sql)
      Converts the given SQL statement into the system's native SQL grammar.
      java.sql.CallableStatement prepareCall​(java.lang.String sql)
      Creates a CallableStatement object for calling database stored procedures.
      java.sql.CallableStatement prepareCall​(java.lang.String sql, int resultSetType, int resultSetConcurrency)
      Creates a CallableStatement object that will generate ResultSet objects with the given type and concurrency.
      java.sql.CallableStatement prepareCall​(java.lang.String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)
      Creates a CallableStatement object that will generate ResultSet objects with the given type and concurrency.
      java.sql.PreparedStatement prepareStatement​(java.lang.String sql)
      Creates a PreparedStatement object for sending parameterized SQL statements to the database.
      java.sql.PreparedStatement prepareStatement​(java.lang.String sql, int autoGeneratedKeys)
      Creates a default PreparedStatement object that has the capability to retrieve auto-generated keys.
      java.sql.PreparedStatement prepareStatement​(java.lang.String sql, int[] columnIndexes)
      Creates a default PreparedStatement object capable of returning the auto-generated keys designated by the given array.
      java.sql.PreparedStatement prepareStatement​(java.lang.String sql, int resultSetType, int resultSetConcurrency)
      Creates a PreparedStatement object that will generate ResultSet objects with the given type and concurrency.
      java.sql.PreparedStatement prepareStatement​(java.lang.String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)
      Creates a PreparedStatement object that will generate ResultSet objects with the given type, concurrency, and holdability.
      java.sql.PreparedStatement prepareStatement​(java.lang.String sql, java.lang.String[] columnNames)
      Creates a default PreparedStatement object capable of returning the auto-generated keys designated by the given array.
      void releaseSavepoint​(java.sql.Savepoint savepoint)
      Removes the given Savepoint object from the current transaction.
      void rollback()
      Drops all changes made since the previous commit/rollback and releases any database locks currently held by this Connection.
      void rollback​(java.sql.Savepoint savepoint)
      Undoes all changes made after the given Savepoint object was set.
      void setAutoCommit​(boolean autoCommit)
      Sets this connection's auto-commit mode.
      void setCatalog​(java.lang.String catalog)
      Sets a catalog name in order to select a subspace of this Connection's database in which to work.
      void setClientInfo​(java.lang.String name, java.lang.String value)  
      void setClientInfo​(java.util.Properties properties)  
      void setHoldability​(int holdability)
      Changes the holdability of ResultSet objects created using this Connection object to the given holdability.
      void setNetworkTimeout​(java.util.concurrent.Executor executor, int timeout)  
      void setReadOnly​(boolean readOnly)
      Puts this connection in read-only mode as a hint to enable database optimizations.
      void setResourceFactoryName​(java.lang.String name)
      Set the name of the factory that allocated this connection
      java.sql.Savepoint setSavepoint()
      Creates an unnamed savepoint in the current transaction and returns the new Savepoint object that represents it.
      java.sql.Savepoint setSavepoint​(java.lang.String name)
      Creates a savepoint with the given name in the current transaction and returns the new Savepoint object that represents it.
      void setSchema​(java.lang.String schema)  
      void setTransactionIsolation​(int level)
      Attempts to change the transaction isolation level to the one given.
      void setTypeMap​(java.util.Map map)
      Installs the given type map as the type map for this connection.
      <T> T unwrap​(java.lang.Class<T> iface)  

      • Methods inherited from class java.lang.Object

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

      • Methods inherited from interface java.sql.Connection

        beginRequest, endRequest, setShardingKey, setShardingKey, setShardingKeyIfValid, setShardingKeyIfValid

    • Field Detail

      • delegate_

        private java.sql.Connection delegate_

      • isOpen_

        private boolean isOpen_

      • resourceFactoryName_

        private java.lang.String resourceFactoryName_

      • openStatements_

        private final java.util.List openStatements_

      • openDatabaseMetaData_

        private final java.util.List openDatabaseMetaData_

    • Constructor Detail

      • ConnectionWrapper

        public ConnectionWrapper​(java.sql.Connection connection)
        Create a new connection wrapper
        Parameters:
        connection - The connection that we are wrapping

    • Method Detail

      • setResourceFactoryName

        public final void setResourceFactoryName​(java.lang.String name)
        Set the name of the factory that allocated this connection
        Specified by:
        setResourceFactoryName in interface ManagedResource
        Parameters:
        name - The name of the factory

      • setAutoCommit

        public void setAutoCommit​(boolean autoCommit)
                   throws java.sql.SQLException
        Sets this connection's auto-commit mode. If a connection is in auto-commit mode, then all its SQL statements will be executed and committed as individual transactions. Otherwise, its SQL statements are grouped into transactions that are terminated by a call to either the method commit or the method rollback. By default, new connections are in auto-commit mode.

        The commit occurs when the statement completes or the next execute occurs, whichever comes first. In the case of statements returning a ResultSet, the statement completes when the last row of the ResultSet has been retrieved or the ResultSet has been closed. In advanced cases, a single statement may return multiple results as well as output parameter values. In these cases the commit occurs when all results and output parameter values have been retrieved.

        Specified by:
        setAutoCommit in interface java.sql.Connection
        Parameters:
        autoCommit - true enables auto-commit; false disables auto-commit.
        Throws:
        java.sql.SQLException - if a database access error occurs

      • setReadOnly

        public void setReadOnly​(boolean readOnly)
                 throws java.sql.SQLException
        Puts this connection in read-only mode as a hint to enable database optimizations.

        Note: This method cannot be called while in the middle of a transaction.

        Specified by:
        setReadOnly in interface java.sql.Connection
        Parameters:
        readOnly - true enables read-only mode; false disables read-only mode.
        Throws:
        java.sql.SQLException - if a database access error occurs

      • setCatalog

        public void setCatalog​(java.lang.String catalog)
                throws java.sql.SQLException
        Sets a catalog name in order to select a subspace of this Connection's database in which to work. If the driver does not support catalogs, it will silently ignore this request.
        Specified by:
        setCatalog in interface java.sql.Connection
        Parameters:
        catalog - The catalog name
        Throws:
        java.sql.SQLException - if a database access error occurs

      • setTransactionIsolation

        public void setTransactionIsolation​(int level)
                             throws java.sql.SQLException
        Attempts to change the transaction isolation level to the one given. The constants defined in the interface Connection are the possible transaction isolation levels.

        Note: This method cannot be called while in the middle of a transaction.

        Specified by:
        setTransactionIsolation in interface java.sql.Connection
        Parameters:
        level - one of the TRANSACTION_* isolation values with the exception of TRANSACTION_NONE; some databases may not support other values
        Throws:
        java.sql.SQLException - if a database access error occurs

      • setTypeMap

        public void setTypeMap​(java.util.Map map)
                throws java.sql.SQLException
        Installs the given type map as the type map for this connection. The type map will be used for the custom mapping of SQL structured types and distinct types.
        Specified by:
        setTypeMap in interface java.sql.Connection
        Parameters:
        map - the java.util.Map object to install as the replacement for this Connection object's default type map
        Throws:
        java.sql.SQLException - If a sql error occurs
        Since:
        1.2

      • getResourceFactoryName

        public final java.lang.String getResourceFactoryName()
        Return the name of the factory that allocated this connection
        Specified by:
        getResourceFactoryName in interface ManagedResource
        Returns:
        The name of the factory

      • getDelegate

        public final java.sql.Connection getDelegate()
        Return the wrapped connection
        Returns:
        The wrapped connection

      • getAutoCommit

        public boolean getAutoCommit()
                      throws java.sql.SQLException
        Gets the current auto-commit state.
        Specified by:
        getAutoCommit in interface java.sql.Connection
        Returns:
        the current state of auto-commit mode
        Throws:
        java.sql.SQLException - if a database access error occurs
        See Also:
        setAutoCommit(boolean)

      • isClosed

        public boolean isClosed()
                 throws java.sql.SQLException
        Tests to see if a Connection is closed.
        Specified by:
        isClosed in interface java.sql.Connection
        Returns:
        true if the connection is closed; false if it's still open
        Throws:
        java.sql.SQLException - if a database access error occurs

      • getMetaData

        public java.sql.DatabaseMetaData getMetaData()
                                      throws java.sql.SQLException
        Gets the metadata regarding this connection's database. A Connection's database is able to provide information describing its tables, its supported SQL grammar, its stored procedures, the capabilities of this connection, and so on. This information is made available through a DatabaseMetaData object.
        Specified by:
        getMetaData in interface java.sql.Connection
        Returns:
        a DatabaseMetaData object for this Connection
        Throws:
        java.sql.SQLException - if a database access error occurs

      • isReadOnly

        public boolean isReadOnly()
                   throws java.sql.SQLException
        Tests to see if the connection is in read-only mode.
        Specified by:
        isReadOnly in interface java.sql.Connection
        Returns:
        true if connection is read-only and false otherwise
        Throws:
        java.sql.SQLException - if a database access error occurs

      • getCatalog

        public java.lang.String getCatalog()
                            throws java.sql.SQLException
        Returns the Connection's current catalog name.
        Specified by:
        getCatalog in interface java.sql.Connection
        Returns:
        the current catalog name or null
        Throws:
        java.sql.SQLException - if a database access error occurs

      • getTransactionIsolation

        public int getTransactionIsolation()
                            throws java.sql.SQLException
        Gets this Connection's current transaction isolation level.
        Specified by:
        getTransactionIsolation in interface java.sql.Connection
        Returns:
        the current TRANSACTION_* mode value
        Throws:
        java.sql.SQLException - if a database access error occurs

      • getWarnings

        public java.sql.SQLWarning getWarnings()
                                throws java.sql.SQLException
        Returns the first warning reported by calls on this Connection.

        Note: Subsequent warnings will be chained to this SQLWarning.

        Specified by:
        getWarnings in interface java.sql.Connection
        Returns:
        the first SQLWarning or null
        Throws:
        java.sql.SQLException - if a database access error occurs

      • getTypeMap

        public java.util.Map getTypeMap()
                         throws java.sql.SQLException
        Gets the type map object associated with this connection. Unless the application has added an entry to the type map, the map returned will be empty.
        Specified by:
        getTypeMap in interface java.sql.Connection
        Returns:
        the java.util.Map object associated with this Connection object
        Throws:
        java.sql.SQLException - If a sql error occurs
        Since:
        1.2

      • createStatement

        public java.sql.Statement createStatement()
                                   throws java.sql.SQLException
        Creates a Statement object for sending SQL statements to the database. SQL statements without parameters are normally executed using Statement objects. If the same SQL statement is executed many times, it is more efficient to use a PreparedStatement object.

        Result sets created using the returned Statement object will by default have forward-only type and read-only concurrency.

        Specified by:
        createStatement in interface java.sql.Connection
        Returns:
        a new Statement object
        Throws:
        java.sql.SQLException - if a database access error occurs

      • prepareStatement

        public java.sql.PreparedStatement prepareStatement​(java.lang.String sql)
                                            throws java.sql.SQLException
        Creates a PreparedStatement object for sending parameterized SQL statements to the database. A SQL statement with or without IN parameters can be pre-compiled and stored in a PreparedStatement object. This object can then be used to efficiently execute this statement multiple times.

        Note: This method is optimized for handling parametric SQL statements that benefit from precompilation. If the driver supports precompilation, the method prepareStatement will send the statement to the database for precompilation. Some drivers may not support precompilation. In this case, the statement may not be sent to the database until the PreparedStatement is executed. This has no direct effect on users; however, it does affect which method throws certain SQLExceptions.

        Result sets created using the returned PreparedStatement will have forward-only type and read-only concurrency, by default.

        Specified by:
        prepareStatement in interface java.sql.Connection
        Parameters:
        sql - a SQL statement that may contain one or more '?' IN parameter placeholders
        Returns:
        a new PreparedStatement object containing the pre-compiled statement
        Throws:
        java.sql.SQLException - if a database access error occurs

      • prepareCall

        public java.sql.CallableStatement prepareCall​(java.lang.String sql)
                                       throws java.sql.SQLException
        Creates a CallableStatement object for calling database stored procedures. The CallableStatement object provides methods for setting up its IN and OUT parameters, and methods for executing the call to a stored procedure.

        Note: This method is optimized for handling stored procedure call statements. Some drivers may send the call statement to the database when the method prepareCall is done; others may wait until the CallableStatement object is executed. This has no direct effect on users; however, it does affect which method throws certain SQLExceptions. Result sets created using the returned CallableStatement will have forward-only type and read-only concurrency, by default.

        Specified by:
        prepareCall in interface java.sql.Connection
        Parameters:
        sql - a SQL statement that may contain one or more '?' parameter placeholders. Typically this statement is a JDBC function call escape string.
        Returns:
        a new CallableStatement object containing the pre-compiled SQL statement
        Throws:
        java.sql.SQLException - if a database access error occurs

      • nativeSQL

        public java.lang.String nativeSQL​(java.lang.String sql)
                           throws java.sql.SQLException
        Converts the given SQL statement into the system's native SQL grammar. A driver may convert the JDBC sql grammar into its system's native SQL grammar prior to sending it; this method returns the native form of the statement that the driver would have sent.
        Specified by:
        nativeSQL in interface java.sql.Connection
        Parameters:
        sql - a SQL statement that may contain one or more '?' parameter placeholders
        Returns:
        the native form of this statement
        Throws:
        java.sql.SQLException - if a database access error occurs

      • commit

        public void commit()
            throws java.sql.SQLException
        Makes all changes made since the previous commit/rollback permanent and releases any database locks currently held by the Connection. This method should be used only when auto-commit mode has been disabled.
        Specified by:
        commit in interface java.sql.Connection
        Throws:
        java.sql.SQLException - if a database access error occurs
        See Also:
        setAutoCommit(boolean)

      • rollback

        public void rollback()
              throws java.sql.SQLException
        Drops all changes made since the previous commit/rollback and releases any database locks currently held by this Connection. This method should be used only when auto- commit has been disabled.
        Specified by:
        rollback in interface java.sql.Connection
        Throws:
        java.sql.SQLException - if a database access error occurs
        See Also:
        setAutoCommit(boolean)

      • close

        public void close()
           throws java.sql.SQLException
        Releases a Connection's database and JDBC resources immediately instead of waiting for them to be automatically released.

        Note: A Connection is automatically closed when it is garbage collected. Certain fatal errors also result in a closed Connection.

        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.sql.Connection
        Throws:
        java.sql.SQLException - if a database access error occurs

      • closeAnyOpenStatements

        public void closeAnyOpenStatements()
                            throws java.sql.SQLException
        Close any open statements
        Throws:
        java.sql.SQLException - If an error occurs

      • closeAnyOpenMetaDatas

        public void closeAnyOpenMetaDatas()
                           throws java.sql.SQLException
        Close any open DatabaseMetaData objects
        Throws:
        java.sql.SQLException - If an error occurs

      • clearWarnings

        public void clearWarnings()
                   throws java.sql.SQLException
        Clears all warnings reported for this Connection object. After a call to this method, the method getWarnings returns null until a new warning is reported for this Connection.
        Specified by:
        clearWarnings in interface java.sql.Connection
        Throws:
        java.sql.SQLException - if a database access error occurs

      • createStatement

        public java.sql.Statement createStatement​(int resultSetType,
                                          int resultSetConcurrency)
                                   throws java.sql.SQLException
        Creates a Statement object that will generate ResultSet objects with the given type and concurrency. This method is the same as the createStatement method above, but it allows the default result set type and result set concurrency type to be overridden.
        Specified by:
        createStatement in interface java.sql.Connection
        Parameters:
        resultSetType - a result set type; see ResultSet.TYPE_XXX
        resultSetConcurrency - a concurrency type; see ResultSet.CONCUR_XXX
        Returns:
        a new Statement object
        Throws:
        java.sql.SQLException - if a database access error occurs
        Since:
        1.2

      • prepareStatement

        public java.sql.PreparedStatement prepareStatement​(java.lang.String sql,
                                                   int resultSetType,
                                                   int resultSetConcurrency)
                                            throws java.sql.SQLException
        Creates a PreparedStatement object that will generate ResultSet objects with the given type and concurrency. This method is the same as the prepareStatement method above, but it allows the default result set type and result set concurrency type to be overridden.
        Specified by:
        prepareStatement in interface java.sql.Connection
        Parameters:
        sql - a SQL statement that may contain one or more '?' parameter placeholders. Typically this statement is a JDBC function call escape string.
        resultSetType - a result set type; see ResultSet.TYPE_XXX
        resultSetConcurrency - a concurrency type; see ResultSet.CONCUR_XXX
        Returns:
        a new PreparedStatement object containing the pre-compiled SQL statement
        Throws:
        java.sql.SQLException - if a database access error occurs
        Since:
        1.2

      • prepareCall

        public java.sql.CallableStatement prepareCall​(java.lang.String sql,
                                              int resultSetType,
                                              int resultSetConcurrency)
                                       throws java.sql.SQLException
        Creates a CallableStatement object that will generate ResultSet objects with the given type and concurrency. This method is the same as the prepareCall method above, but it allows the default result set type and result set concurrency type to be overridden.
        Specified by:
        prepareCall in interface java.sql.Connection
        Parameters:
        sql - a SQL statement that may contain one or more '?' parameter placeholders. Typically this statement is a JDBC function call escape string.
        resultSetType - a result set type; see ResultSet.TYPE_XXX
        resultSetConcurrency - a concurrency type; see ResultSet.CONCUR_XXX
        Returns:
        a new CallableStatement object containing the pre-compiled SQL statement
        Throws:
        java.sql.SQLException - if a database access error occurs
        Since:
        1.2

      • checkConnection

        private void checkConnection()
                      throws java.sql.SQLException
        Check to see if the connection is still open. If not, throw an exception.
        Throws:
        java.sql.SQLException

      • getOpenStatementCount

        public int getOpenStatementCount()
        Return the number of statements that are currently open. Useful for debugging purposes.
        Returns:
        The number of statements that are currently open.

      • setHoldability

        public void setHoldability​(int holdability)
                    throws java.sql.SQLException
        Changes the holdability of ResultSet objects created using this Connection object to the given holdability.
        Specified by:
        setHoldability in interface java.sql.Connection
        Parameters:
        holdability - a ResultSet holdability constant; one of ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT
        Throws:
        java.sql.SQLException - if a database access occurs, the given parameter is not a ResultSet constant indicating holdability, or the given holdability is not supported
        Since:
        1.4
        See Also:
        getHoldability(), ResultSet

      • getHoldability

        public int getHoldability()
                   throws java.sql.SQLException
        Retrieves the current holdability of ResultSet objects created using this Connection object.
        Specified by:
        getHoldability in interface java.sql.Connection
        Returns:
        the holdability, one of ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT
        Throws:
        java.sql.SQLException - if a database access occurs
        Since:
        1.4
        See Also:
        setHoldability(int), ResultSet

      • setSavepoint

        public java.sql.Savepoint setSavepoint()
                                throws java.sql.SQLException
        Creates an unnamed savepoint in the current transaction and returns the new Savepoint object that represents it.
        Specified by:
        setSavepoint in interface java.sql.Connection
        Returns:
        the new Savepoint object
        Throws:
        java.sql.SQLException - if a database access error occurs or this Connection object is currently in auto-commit mode
        Since:
        1.4
        See Also:
        Savepoint

      • setSavepoint

        public java.sql.Savepoint setSavepoint​(java.lang.String name)
                                throws java.sql.SQLException
        Creates a savepoint with the given name in the current transaction and returns the new Savepoint object that represents it.
        Specified by:
        setSavepoint in interface java.sql.Connection
        Parameters:
        name - a String containing the name of the savepoint
        Returns:
        the new Savepoint object
        Throws:
        java.sql.SQLException - if a database access error occurs or this Connection object is currently in auto-commit mode
        Since:
        1.4
        See Also:
        Savepoint

      • rollback

        public void rollback​(java.sql.Savepoint savepoint)
              throws java.sql.SQLException
        Undoes all changes made after the given Savepoint object was set.

        This method should be used only when auto-commit has been disabled.

        Specified by:
        rollback in interface java.sql.Connection
        Parameters:
        savepoint - the Savepoint object to roll back to
        Throws:
        java.sql.SQLException - if a database access error occurs, the Savepoint object is no longer valid, or this Connection object is currently in auto-commit mode
        Since:
        1.4
        See Also:
        Savepoint

      • releaseSavepoint

        public void releaseSavepoint​(java.sql.Savepoint savepoint)
                      throws java.sql.SQLException
        Removes the given Savepoint object from the current transaction. Any reference to the savepoint after it have been removed will cause an SQLException to be thrown.
        Specified by:
        releaseSavepoint in interface java.sql.Connection
        Parameters:
        savepoint - the Savepoint object to be removed
        Throws:
        java.sql.SQLException - if a database access error occurs or the given Savepoint object is not a valid savepoint in the current transaction
        Since:
        1.4

      • createStatement

        public java.sql.Statement createStatement​(int resultSetType,
                                          int resultSetConcurrency,
                                          int resultSetHoldability)
                                   throws java.sql.SQLException
        Creates a Statement object that will generate ResultSet objects with the given type, concurrency, and holdability. This method is the same as the createStatement method above, but it allows the default result set type, concurrency, and holdability to be overridden.
        Specified by:
        createStatement in interface java.sql.Connection
        Parameters:
        resultSetType - one of the following ResultSet constants: ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
        resultSetConcurrency - one of the following ResultSet constants: ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE
        resultSetHoldability - one of the following ResultSet constants: ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT
        Returns:
        a new Statement object that will generate ResultSet objects with the given type, concurrency, and holdability
        Throws:
        java.sql.SQLException - if a database access error occurs or the given parameters are not ResultSet constants indicating type, concurrency, and holdability
        Since:
        1.4
        See Also:
        ResultSet

      • prepareStatement

        public java.sql.PreparedStatement prepareStatement​(java.lang.String sql,
                                                   int resultSetType,
                                                   int resultSetConcurrency,
                                                   int resultSetHoldability)
                                            throws java.sql.SQLException
        Creates a PreparedStatement object that will generate ResultSet objects with the given type, concurrency, and holdability.

        This method is the same as the prepareStatement method above, but it allows the default result set type, concurrency, and holdability to be overridden.

        Specified by:
        prepareStatement in interface java.sql.Connection
        Parameters:
        sql - a String object that is the SQL statement to be sent to the database; may contain one or more ? IN parameters
        resultSetType - one of the following ResultSet constants: ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
        resultSetConcurrency - one of the following ResultSet constants: ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE
        resultSetHoldability - one of the following ResultSet constants: ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT
        Returns:
        a new PreparedStatement object, containing the pre-compiled SQL statement, that will generate ResultSet objects with the given type, concurrency, and holdability
        Throws:
        java.sql.SQLException - if a database access error occurs or the given parameters are not ResultSet constants indicating type, concurrency, and holdability
        Since:
        1.4
        See Also:
        ResultSet

      • prepareCall

        public java.sql.CallableStatement prepareCall​(java.lang.String sql,
                                              int resultSetType,
                                              int resultSetConcurrency,
                                              int resultSetHoldability)
                                       throws java.sql.SQLException
        Creates a CallableStatement object that will generate ResultSet objects with the given type and concurrency. This method is the same as the prepareCall method above, but it allows the default result set type, result set concurrency type and holdability to be overridden.
        Specified by:
        prepareCall in interface java.sql.Connection
        Parameters:
        sql - a String object that is the SQL statement to be sent to the database; may contain on or more ? parameters
        resultSetType - one of the following ResultSet constants: ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE
        resultSetConcurrency - one of the following ResultSet constants: ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE
        resultSetHoldability - one of the following ResultSet constants: ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT
        Returns:
        a new CallableStatement object, containing the pre-compiled SQL statement, that will generate ResultSet objects with the given type, concurrency, and holdability
        Throws:
        java.sql.SQLException - if a database access error occurs or the given parameters are not ResultSet constants indicating type, concurrency, and holdability
        Since:
        1.4
        See Also:
        ResultSet

      • prepareStatement

        public java.sql.PreparedStatement prepareStatement​(java.lang.String sql,
                                                   int autoGeneratedKeys)
                                            throws java.sql.SQLException
        Creates a default PreparedStatement object that has the capability to retrieve auto-generated keys. The given constant tells the driver whether it should make auto-generated keys available for retrieval. This parameter is ignored if the SQL statement is not an INSERT statement.

        Note: This method is optimized for handling parametric SQL statements that benefit from precompilation. If the driver supports precompilation, the method prepareStatement will send the statement to the database for precompilation. Some drivers may not support precompilation. In this case, the statement may not be sent to the database until the PreparedStatement object is executed. This has no direct effect on users; however, it does affect which methods throw certain SQLExceptions.

        Result sets created using the returned PreparedStatement object will by default be type TYPE_FORWARD_ONLY and have a concurrency level of CONCUR_READ_ONLY.

        Specified by:
        prepareStatement in interface java.sql.Connection
        Parameters:
        sql - an SQL statement that may contain one or more '?' IN parameter placeholders
        autoGeneratedKeys - a flag indicating whether auto-generated keys should be returned; one of Statement.RETURN_GENERATED_KEYS or Statement.NO_GENERATED_KEYS
        Returns:
        a new PreparedStatement object, containing the pre-compiled SQL statement, that will have the capability of returning auto-generated keys
        Throws:
        java.sql.SQLException - if a database access error occurs or the given parameter is not a Statement constant indicating whether auto-generated keys should be returned
        Since:
        1.4

      • prepareStatement

        public java.sql.PreparedStatement prepareStatement​(java.lang.String sql,
                                                   int[] columnIndexes)
                                            throws java.sql.SQLException
        Creates a default PreparedStatement object capable of returning the auto-generated keys designated by the given array. This array contains the indexes of the columns in the target table that contain the auto-generated keys that should be made available. This array is ignored if the SQL statement is not an INSERT statement.

        An SQL statement with or without IN parameters can be pre-compiled and stored in a PreparedStatement object. This object can then be used to efficiently execute this statement multiple times.

        Note: This method is optimized for handling parametric SQL statements that benefit from precompilation. If the driver supports precompilation, the method prepareStatement will send the statement to the database for precompilation. Some drivers may not support precompilation. In this case, the statement may not be sent to the database until the PreparedStatement object is executed. This has no direct effect on users; however, it does affect which methods throw certain SQLExceptions.

        Result sets created using the returned PreparedStatement object will by default be type TYPE_FORWARD_ONLY and have a concurrency level of CONCUR_READ_ONLY.

        Specified by:
        prepareStatement in interface java.sql.Connection
        Parameters:
        sql - an SQL statement that may contain one or more '?' IN parameter placeholders
        columnIndexes - an array of column indexes indicating the columns that should be returned from the inserted row or rows
        Returns:
        a new PreparedStatement object, containing the pre-compiled statement, that is capable of returning the auto-generated keys designated by the given array of column indexes
        Throws:
        java.sql.SQLException - if a database access error occurs
        Since:
        1.4

      • prepareStatement

        public java.sql.PreparedStatement prepareStatement​(java.lang.String sql,
                                                   java.lang.String[] columnNames)
                                            throws java.sql.SQLException
        Creates a default PreparedStatement object capable of returning the auto-generated keys designated by the given array. This array contains the names of the columns in the target table that contain the auto-generated keys that should be returned. This array is ignored if the SQL statement is not an INSERT statement.

        An SQL statement with or without IN parameters can be pre-compiled and stored in a PreparedStatement object. This object can then be used to efficiently execute this statement multiple times.

        Note: This method is optimized for handling parametric SQL statements that benefit from precompilation. If the driver supports precompilation, the method prepareStatement will send the statement to the database for precompilation. Some drivers may not support precompilation. In this case, the statement may not be sent to the database until the PreparedStatement object is executed. This has no direct effect on users; however, it does affect which methods throw certain SQLExceptions.

        Result sets created using the returned PreparedStatement object will by default be type TYPE_FORWARD_ONLY and have a concurrency level of CONCUR_READ_ONLY.

        Specified by:
        prepareStatement in interface java.sql.Connection
        Parameters:
        sql - an SQL statement that may contain one or more '?' IN parameter placeholders
        columnNames - an array of column names indicating the columns that should be returned from the inserted row or rows
        Returns:
        a new PreparedStatement object, containing the pre-compiled statement, that is capable of returning the auto-generated keys designated by the given array of column names
        Throws:
        java.sql.SQLException - if a database access error occurs
        Since:
        1.4

      • getNetworkTimeout

        public int getNetworkTimeout()
                      throws java.sql.SQLException
        Specified by:
        getNetworkTimeout in interface java.sql.Connection
        Throws:
        java.sql.SQLException

      • setNetworkTimeout

        public void setNetworkTimeout​(java.util.concurrent.Executor executor,
                              int timeout)
                       throws java.sql.SQLException
        Specified by:
        setNetworkTimeout in interface java.sql.Connection
        Throws:
        java.sql.SQLException

      • abort

        public void abort​(java.util.concurrent.Executor executor)
           throws java.sql.SQLException
        Specified by:
        abort in interface java.sql.Connection
        Throws:
        java.sql.SQLException

      • getSchema

        public java.lang.String getSchema()
                           throws java.sql.SQLException
        Specified by:
        getSchema in interface java.sql.Connection
        Throws:
        java.sql.SQLException

      • setSchema

        public void setSchema​(java.lang.String schema)
               throws java.sql.SQLException
        Specified by:
        setSchema in interface java.sql.Connection
        Throws:
        java.sql.SQLException

      • createStruct

        public java.sql.Struct createStruct​(java.lang.String typeName,
                                    java.lang.Object[] attributes)
                             throws java.sql.SQLException
        Specified by:
        createStruct in interface java.sql.Connection
        Throws:
        java.sql.SQLException

      • createArrayOf

        public java.sql.Array createArrayOf​(java.lang.String typeName,
                                    java.lang.Object[] elements)
                             throws java.sql.SQLException
        Specified by:
        createArrayOf in interface java.sql.Connection
        Throws:
        java.sql.SQLException

      • getClientInfo

        public java.util.Properties getClientInfo()
                                   throws java.sql.SQLException
        Specified by:
        getClientInfo in interface java.sql.Connection
        Throws:
        java.sql.SQLException

      • getClientInfo

        public java.lang.String getClientInfo​(java.lang.String name)
                               throws java.sql.SQLException
        Specified by:
        getClientInfo in interface java.sql.Connection
        Throws:
        java.sql.SQLException

      • setClientInfo

        public void setClientInfo​(java.util.Properties properties)
                   throws java.sql.SQLClientInfoException
        Specified by:
        setClientInfo in interface java.sql.Connection
        Throws:
        java.sql.SQLClientInfoException

      • setClientInfo

        public void setClientInfo​(java.lang.String name,
                          java.lang.String value)
                   throws java.sql.SQLClientInfoException
        Specified by:
        setClientInfo in interface java.sql.Connection
        Throws:
        java.sql.SQLClientInfoException

      • isValid

        public boolean isValid​(int timeout)
                throws java.sql.SQLException
        Specified by:
        isValid in interface java.sql.Connection
        Throws:
        java.sql.SQLException

      • createSQLXML

        public java.sql.SQLXML createSQLXML()
                             throws java.sql.SQLException
        Specified by:
        createSQLXML in interface java.sql.Connection
        Throws:
        java.sql.SQLException

      • createNClob

        public java.sql.NClob createNClob()
                           throws java.sql.SQLException
        Specified by:
        createNClob in interface java.sql.Connection
        Throws:
        java.sql.SQLException

      • createBlob

        public java.sql.Blob createBlob()
                         throws java.sql.SQLException
        Specified by:
        createBlob in interface java.sql.Connection
        Throws:
        java.sql.SQLException

      • createClob

        public java.sql.Clob createClob()
                         throws java.sql.SQLException
        Specified by:
        createClob in interface java.sql.Connection
        Throws:
        java.sql.SQLException

      • 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