SQLRecoverableException

A SQLRecoverableException will be thrown in situations where the failed
operation might succeed if the application performs some recovery steps and retries
the entire transaction or in the case of a distributed transaction, the transaction branch. At a minimum recovery includes closing the current connection
and getting a new one. After a SQLRecoverableException the application must assume
that the connection is no longer valid.

Overview Package Class Tree Deprecated Index Help

 PREV CLASS NEXT CLASS FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
java.sql
Class SQLRecoverableException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by java.sql.SQLException
              extended by java.sql.SQLRecoverableException

All Implemented Interfaces:
    java.io.Serializable, java.lang.Iterable<java.lang.Throwable>

public class SQLRecoverableException
extends SQLException

The subclass of SQLException thrown in situations where a previously failed operation might be able to succeed if the application performs some recovery steps and retries the entire transaction or in the case of a distributed transaction, the transaction branch. At a minimum, the recovery operation must include closing the current connection and getting a new connection.

Since:
    1.6
See Also:
    Serialized Form

Constructor Summary
SQLRecoverableException()
          Constructs a SQLRecoverableException object.
SQLRecoverableException(java.lang.String reason)
          Constructs a SQLRecoverableException object with a given reason.
SQLRecoverableException(java.lang.String reason, java.lang.String SQLState)
          Constructs a SQLRecoverableException object with a given reason and SQLState.
SQLRecoverableException(java.lang.String reason, java.lang.String SQLState, int vendorCode)
          Constructs a SQLRecoverableException object with a given reason, SQLState and vendorCode.
SQLRecoverableException(java.lang.String reason, java.lang.String SQLState, int vendorCode, java.lang.Throwable cause)
          Constructs a SQLRecoverableException object with a given reason, SQLState, vendorCode and cause.
SQLRecoverableException(java.lang.String reason, java.lang.String SQLState, java.lang.Throwable cause)
          Constructs a SQLRecoverableException object with a given reason, SQLState and cause.
SQLRecoverableException(java.lang.String reason, java.lang.Throwable cause)
          Constructs a SQLRecoverableException object with a given reason and cause.
SQLRecoverableException(java.lang.Throwable cause)
          Constructs a SQLRecoverableException object with a given cause.
 
Method Summary
 
Methods inherited from class java.sql.SQLException
getErrorCode, getNextException, getSQLState, iterator, setNextException
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail
SQLRecoverableException

public SQLRecoverableException()

    Constructs a SQLRecoverableException object. The reason, SQLState are initialized to null and the vendor code is initialized to 0. The cause is not initialized, and may subsequently be initialized by a call to the Throwable.initCause(java.lang.Throwable) method.

    Since:
        1.6

SQLRecoverableException

public SQLRecoverableException(java.lang.String reason)

    Constructs a SQLRecoverableException object with a given reason. The SQLState is initialized to null and the vender code is initialized to 0. The cause is not initialized, and may subsequently be initialized by a call to the Throwable.initCause(java.lang.Throwable) method.

    Parameters:
        reason - a description of the exception
    Since:
        1.6

SQLRecoverableException

public SQLRecoverableException(java.lang.String reason,
                               java.lang.String SQLState)

    Constructs a SQLRecoverableException object with a given reason and SQLState. The cause is not initialized, and may subsequently be initialized by a call to the Throwable.initCause(java.lang.Throwable) method. The vendor code is initialized to 0.

    Parameters:
        reason - a description of the exception
        SQLState - an XOPEN or SQL:2003 code identifying the exception
    Since:
        1.6

SQLRecoverableException

public SQLRecoverableException(java.lang.String reason,
                               java.lang.String SQLState,
                               int vendorCode)

    Constructs a SQLRecoverableException object with a given reason, SQLState and vendorCode. The cause is not initialized, and may subsequently be initialized by a call to the Throwable.initCause(java.lang.Throwable) method.

    Parameters:
        reason - a description of the exception
        SQLState - an XOPEN or SQL:2003 code identifying the exception
        vendorCode - a database vendor specific exception code
    Since:
        1.6

SQLRecoverableException

public SQLRecoverableException(java.lang.Throwable cause)

    Constructs a SQLRecoverableException object with a given cause. The SQLState is initialized to null and the vendor code is initialized to 0. The reason is initialized to null if cause==null or to cause.toString() if cause!=null.

    Parameters:
        cause - the underlying reason for this SQLException (which is saved for later retrieval by the getCause() method); may be null indicating the cause is non-existent or unknown.
    Since:
        1.6

SQLRecoverableException

public SQLRecoverableException(java.lang.String reason,
                               java.lang.Throwable cause)

    Constructs a SQLRecoverableException object with a given reason and cause. The SQLState is initialized to null and the vendor code is initialized to 0.

    Parameters:
        reason - a description of the exception.
        cause - the underlying reason for this SQLException (which is saved for later retrieval by the getCause() method); may be null indicating the cause is non-existent or unknown.
    Since:
        1.6

SQLRecoverableException

public SQLRecoverableException(java.lang.String reason,
                               java.lang.String SQLState,
                               java.lang.Throwable cause)

    Constructs a SQLRecoverableException object with a given reason, SQLState and cause. The vendor code is initialized to 0.

    Parameters:
        reason - a description of the exception.
        SQLState - an XOPEN or SQL:2003 code identifying the exception
        cause - the underlying reason for this SQLException (which is saved for later retrieval by the getCause() method); may be null indicating the cause is non-existent or unknown.
    Since:
        1.6

SQLRecoverableException

public SQLRecoverableException(java.lang.String reason,
                               java.lang.String SQLState,
                               int vendorCode,


                               java.lang.Throwable cause)

    Constructs a SQLRecoverableException object with a given reason, SQLState, vendorCode and cause.

    Parameters:
        reason - a description of the exception
        SQLState - an XOPEN or SQL:2003 code identifying the exception
        vendorCode - a database vendor-specific exception code
        cause - the underlying reason for this SQLException (which is saved for later retrieval by the getCause() method); may be null indicating the cause is non-existent or unknown.
    Since:
        1.6
In order to provide clearer detail as to what methods are required and which methods are optional by the JDBC spec. We have updated the JDBC compliance chapter to provide a list of optional methods and need to update the javadocs accordingly.
Request to add createArray and creatStruct to the Connection interface to provide a portable mechanism for developers to be able to create the ADT Array and Struct