SQLRecoverableException

AI-generated Key Takeaways

• SQLRecoverableException signals that a failed SQL operation might succeed if the application takes recovery steps, like reconnecting to the database, and retries the transaction or transaction branch.

• It's a subclass of SQLException and provides constructors to specify the reason, SQLState, vendor code, and underlying cause of the exception.

• Recovery involves closing the current connection and obtaining a new one before retrying the operation.

• SQLRecoverableException offers methods inherited from SQLException and Throwable for accessing error details and chaining exceptions.

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.

Public Constructor Summary

	SQLRecoverableException() Constructs a SQLRecoverableException object.
	SQLRecoverableException(String reason) Constructs a SQLRecoverableException object with a given reason.
	SQLRecoverableException(String reason, String SQLState) Constructs a SQLRecoverableException object with a given reason and SQLState.
	SQLRecoverableException(String reason, String SQLState, int vendorCode) Constructs a SQLRecoverableException object with a given reason, SQLState and vendorCode.
	SQLRecoverableException(Throwable cause) Constructs a SQLRecoverableException object with a given cause.
	SQLRecoverableException(String reason, Throwable cause) Constructs a SQLRecoverableException object with a given reason and cause.
	SQLRecoverableException(String reason, String SQLState, Throwable cause) Constructs a SQLRecoverableException object with a given reason, SQLState and cause.
	SQLRecoverableException(String reason, String SQLState, int vendorCode, Throwable cause) Constructs a SQLRecoverableException object with a given reason, SQLState, vendorCode and cause.

Inherited Method Summary

From class java.sql.SQLException

int	getErrorCode() Retrieves the vendor-specific exception code for this SQLException object.
SQLException	getNextException() Retrieves the exception chained to this SQLException object by setNextException(SQLException ex).
String	getSQLState() Retrieves the SQLState for this SQLException object.
Iterator<Throwable>	iterator() Returns an iterator over the chained SQLExceptions.
void	setNextException(SQLException ex) Adds an SQLException object to the end of the chain.

From class java.lang.Throwable

synchronized final void	addSuppressed(Throwable exception) Appends the specified exception to the exceptions that were suppressed in order to deliver this exception.
synchronized Throwable	fillInStackTrace() Fills in the execution stack trace.
synchronized Throwable	getCause() Returns the cause of this throwable or null if the cause is nonexistent or unknown.
String	getLocalizedMessage() Creates a localized description of this throwable.
String	getMessage() Returns the detail message string of this throwable.
StackTraceElement[]	getStackTrace() Provides programmatic access to the stack trace information printed by printStackTrace().
synchronized final Throwable[]	getSuppressed() Returns an array containing all of the exceptions that were suppressed, typically by the try-with-resources statement, in order to deliver this exception.
synchronized Throwable	initCause(Throwable cause) Initializes the cause of this throwable to the specified value.
void	printStackTrace() Prints this throwable and its backtrace to the standard error stream.
void	printStackTrace(PrintWriter s) Prints this throwable and its backtrace to the specified print writer.
void	printStackTrace(PrintStream s) Prints this throwable and its backtrace to the specified print stream.
void	setStackTrace(StackTraceElement[] stackTrace) Sets the stack trace elements that will be returned by getStackTrace() and printed by printStackTrace() and related methods.
String	toString() Returns a short description of this throwable.

From class java.lang.Object

Object	clone() Creates and returns a copy of this Object.
boolean	equals(Object obj) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of Class that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long timeout, int nanos) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait(long timeout) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.

From interface java.lang.Iterable

void	forEach(Consumer<? super T> action) Performs the given action for each element of the Iterable until all elements have been processed or the action throws an exception.
abstract Iterator<Throwable>	iterator() Returns an iterator over elements of type T.
Spliterator<Throwable>	spliterator() Creates a Spliterator over the elements described by this Iterable.

Public Constructors

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.

public SQLRecoverableException (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

public SQLRecoverableException (String reason, 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

public SQLRecoverableException (String reason, 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

public SQLRecoverableException (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.

public SQLRecoverableException (String reason, 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.

public SQLRecoverableException (String reason, String SQLState, 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.

public SQLRecoverableException (String reason, String SQLState, int vendorCode, 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.