SQLClientInfoException

AI-generated Key Takeaways

• SQLClientInfoException signals a failure when setting client information properties on a database connection, often providing details about the specific properties that were rejected.

• This exception may still allow partial success, meaning some properties might have been set even if the exception is thrown.

• The getFailedProperties() method provides a map of properties that were not successfully set, along with their respective failure reasons.

• Applications should handle this exception by inspecting the failedProperties map to determine the appropriate course of action for any unset properties.

public class SQLClientInfoException extends SQLException

The subclass of SQLException is thrown when one or more client info properties could not be set on a Connection. In addition to the information provided by SQLException, a SQLClientInfoException provides a list of client info properties that were not set. Some databases do not allow multiple client info properties to be set atomically. For those databases, it is possible that some of the client info properties had been set even though the Connection.setClientInfo method threw an exception. An application can use the getFailedProperties method to retrieve a list of client info properties that were not set. The properties are identified by passing a Map<String,ClientInfoStatus> to the appropriate SQLClientInfoException constructor.

See Also

• ClientInfoStatus
• Connection.setClientInfo(String, String)

Public Constructor Summary

	SQLClientInfoException() Constructs a SQLClientInfoException Object.
	SQLClientInfoException(Map<String, ClientInfoStatus> failedProperties) Constructs a SQLClientInfoException object initialized with a given failedProperties.
	SQLClientInfoException(Map<String, ClientInfoStatus> failedProperties, Throwable cause) Constructs a SQLClientInfoException object initialized with a given cause and failedProperties.
	SQLClientInfoException(String reason, Map<String, ClientInfoStatus> failedProperties) Constructs a SQLClientInfoException object initialized with a given reason and failedProperties.
	SQLClientInfoException(String reason, Map<String, ClientInfoStatus> failedProperties, Throwable cause) Constructs a SQLClientInfoException object initialized with a given reason, cause and failedProperties.
	SQLClientInfoException(String reason, String SQLState, Map<String, ClientInfoStatus> failedProperties) Constructs a SQLClientInfoException object initialized with a given reason, SQLState and failedProperties.
	SQLClientInfoException(String reason, String SQLState, Map<String, ClientInfoStatus> failedProperties, Throwable cause) Constructs a SQLClientInfoException object initialized with a given reason, SQLState, cause and failedProperties.
	SQLClientInfoException(String reason, String SQLState, int vendorCode, Map<String, ClientInfoStatus> failedProperties) Constructs a SQLClientInfoException object initialized with a given reason, SQLState, vendorCode and failedProperties.
	SQLClientInfoException(String reason, String SQLState, int vendorCode, Map<String, ClientInfoStatus> failedProperties, Throwable cause) Constructs a SQLClientInfoException object initialized with a given reason, SQLState, cause, vendorCode and failedProperties.

Public Method Summary

Map<String, ClientInfoStatus>

getFailedProperties() Returns the list of client info properties that could not be set.

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 SQLClientInfoException ()

Constructs a SQLClientInfoException Object. The reason, SQLState, and failedProperties list 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 SQLClientInfoException (Map<String, ClientInfoStatus> failedProperties)

Constructs a SQLClientInfoException object initialized with a given failedProperties. The reason and 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.

Parameters

failedProperties	A Map containing the property values that could not be set. The keys in the Map contain the names of the client info properties that could not be set and the values contain one of the reason codes defined in ClientInfoStatus

public SQLClientInfoException (Map<String, ClientInfoStatus> failedProperties, Throwable cause)

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

Parameters

failedProperties	A Map containing the property values that could not be set. The keys in the Map contain the names of the client info properties that could not be set and the values contain one of the reason codes defined in ClientInfoStatus
cause	the (which is saved for later retrieval by the getCause() method); may be null indicating the cause is non-existent or unknown.

public SQLClientInfoException (String reason, Map<String, ClientInfoStatus> failedProperties)

Constructs a SQLClientInfoException object initialized with a given reason and failedProperties. The SQLState is 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.

Parameters

reason	a description of the exception
failedProperties	A Map containing the property values that could not be set. The keys in the Map contain the names of the client info properties that could not be set and the values contain one of the reason codes defined in ClientInfoStatus

public SQLClientInfoException (String reason, Map<String, ClientInfoStatus> failedProperties, Throwable cause)

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

Parameters

reason	a description of the exception
failedProperties	A Map containing the property values that could not be set. The keys in the Map contain the names of the client info properties that could not be set and the values contain one of the reason codes defined in ClientInfoStatus
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 SQLClientInfoException (String reason, String SQLState, Map<String, ClientInfoStatus> failedProperties)

Constructs a SQLClientInfoException object initialized with a given reason, SQLState and failedProperties. 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
failedProperties	A Map containing the property values that could not be set. The keys in the Map contain the names of the client info properties that could not be set and the values contain one of the reason codes defined in ClientInfoStatus

public SQLClientInfoException (String reason, String SQLState, Map<String, ClientInfoStatus> failedProperties, Throwable cause)

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

Parameters

reason	a description of the exception
SQLState	an XOPEN or SQL:2003 code identifying the exception
failedProperties	A Map containing the property values that could not be set. The keys in the Map contain the names of the client info properties that could not be set and the values contain one of the reason codes defined in ClientInfoStatus
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 SQLClientInfoException (String reason, String SQLState, int vendorCode, Map<String, ClientInfoStatus> failedProperties)

Constructs a SQLClientInfoException object initialized with a given reason, SQLState, vendorCode and failedProperties. 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
failedProperties	A Map containing the property values that could not be set. The keys in the Map contain the names of the client info properties that could not be set and the values contain one of the reason codes defined in ClientInfoStatus

public SQLClientInfoException (String reason, String SQLState, int vendorCode, Map<String, ClientInfoStatus> failedProperties, Throwable cause)

Constructs a SQLClientInfoException object initialized with a given reason, SQLState, cause, vendorCode and failedProperties.

Parameters

reason	a description of the exception
SQLState	an XOPEN or SQL:2003 code identifying the exception
vendorCode	a database vendor-specific exception code
failedProperties	A Map containing the property values that could not be set. The keys in the Map contain the names of the client info properties that could not be set and the values contain one of the reason codes defined in ClientInfoStatus
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 Methods

public Map<String, ClientInfoStatus> getFailedProperties ()

Returns the list of client info properties that could not be set. The keys in the Map contain the names of the client info properties that could not be set and the values contain one of the reason codes defined in ClientInfoStatus

Returns

• Map list containing the client info properties that could not be set