Class SQLClientInfoException
java.lang.Object
java.lang.Throwable
java.lang.Exception
java.sql.SQLException
java.sql.SQLClientInfoException
- All Implemented Interfaces:
Serializable
,Iterable<Throwable>
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.- Since:
- 1.6
- See Also:
-
Constructor Summary
ConstructorDescriptionConstructs aSQLClientInfoException
Object.SQLClientInfoException
(String reason, String SQLState, int vendorCode, Map<String, ClientInfoStatus> failedProperties) Constructs aSQLClientInfoException
object initialized with a givenreason
,SQLState
,vendorCode
andfailedProperties
.SQLClientInfoException
(String reason, String SQLState, int vendorCode, Map<String, ClientInfoStatus> failedProperties, Throwable cause) Constructs aSQLClientInfoException
object initialized with a givenreason
,SQLState
,cause
,vendorCode
andfailedProperties
.SQLClientInfoException
(String reason, String SQLState, Map<String, ClientInfoStatus> failedProperties) Constructs aSQLClientInfoException
object initialized with a givenreason
,SQLState
andfailedProperties
.SQLClientInfoException
(String reason, String SQLState, Map<String, ClientInfoStatus> failedProperties, Throwable cause) Constructs aSQLClientInfoException
object initialized with a givenreason
,SQLState
,cause
andfailedProperties
.SQLClientInfoException
(String reason, Map<String, ClientInfoStatus> failedProperties) Constructs aSQLClientInfoException
object initialized with a givenreason
andfailedProperties
.SQLClientInfoException
(String reason, Map<String, ClientInfoStatus> failedProperties, Throwable cause) Constructs aSQLClientInfoException
object initialized with a givenreason
,cause
andfailedProperties
.SQLClientInfoException
(Map<String, ClientInfoStatus> failedProperties) Constructs aSQLClientInfoException
object initialized with a givenfailedProperties
.SQLClientInfoException
(Map<String, ClientInfoStatus> failedProperties, Throwable cause) Constructs aSQLClientInfoException
object initialized with a givencause
andfailedProperties
. -
Method Summary
Modifier and TypeMethodDescriptionReturns the list of client info properties that could not be set.Methods inherited from class java.sql.SQLException
getErrorCode, getNextException, getSQLState, iterator, setNextException
Methods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface java.lang.Iterable
forEach, spliterator
-
Constructor Details
-
SQLClientInfoException
public SQLClientInfoException()Constructs aSQLClientInfoException
Object. Thereason
,SQLState
, and failedProperties list are initialized tonull
and the vendor code is initialized to 0. Thecause
is not initialized, and may subsequently be initialized by a call to theThrowable.initCause(java.lang.Throwable)
method.- Since:
- 1.6
-
SQLClientInfoException
Constructs aSQLClientInfoException
object initialized with a givenfailedProperties
. Thereason
andSQLState
are initialized tonull
and the vendor code is initialized to 0. Thecause
is not initialized, and may subsequently be initialized by a call to theThrowable.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 inClientInfoStatus
- Since:
- 1.6
-
SQLClientInfoException
Constructs aSQLClientInfoException
object initialized with a givencause
andfailedProperties
. Thereason
is initialized tonull
ifcause==null
or tocause.toString()
ifcause!=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 inClientInfoStatus
cause
- the (which is saved for later retrieval by thegetCause()
method); may be null indicating the cause is non-existent or unknown.- Since:
- 1.6
-
SQLClientInfoException
Constructs aSQLClientInfoException
object initialized with a givenreason
andfailedProperties
. TheSQLState
is initialized tonull
and the vendor code is initialized to 0. Thecause
is not initialized, and may subsequently be initialized by a call to theThrowable.initCause(java.lang.Throwable)
method.- Parameters:
reason
- a description of the exceptionfailedProperties
- 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 inClientInfoStatus
- Since:
- 1.6
-
SQLClientInfoException
public SQLClientInfoException(String reason, Map<String, ClientInfoStatus> failedProperties, Throwable cause) Constructs aSQLClientInfoException
object initialized with a givenreason
,cause
andfailedProperties
. TheSQLState
is initialized tonull
and the vendor code is initialized to 0.- Parameters:
reason
- a description of the exceptionfailedProperties
- 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 inClientInfoStatus
cause
- the underlying reason for thisSQLException
(which is saved for later retrieval by thegetCause()
method); may be null indicating the cause is non-existent or unknown.- Since:
- 1.6
-
SQLClientInfoException
public SQLClientInfoException(String reason, String SQLState, Map<String, ClientInfoStatus> failedProperties) Constructs aSQLClientInfoException
object initialized with a givenreason
,SQLState
andfailedProperties
. Thecause
is not initialized, and may subsequently be initialized by a call to theThrowable.initCause(java.lang.Throwable)
method. The vendor code is initialized to 0.- Parameters:
reason
- a description of the exceptionSQLState
- an XOPEN or SQL:2003 code identifying the exceptionfailedProperties
- 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 inClientInfoStatus
- Since:
- 1.6
-
SQLClientInfoException
public SQLClientInfoException(String reason, String SQLState, Map<String, ClientInfoStatus> failedProperties, Throwable cause) Constructs aSQLClientInfoException
object initialized with a givenreason
,SQLState
,cause
andfailedProperties
. The vendor code is initialized to 0.- Parameters:
reason
- a description of the exceptionSQLState
- an XOPEN or SQL:2003 code identifying the exceptionfailedProperties
- 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 inClientInfoStatus
cause
- the underlying reason for thisSQLException
(which is saved for later retrieval by thegetCause()
method); may be null indicating the cause is non-existent or unknown.- Since:
- 1.6
-
SQLClientInfoException
public SQLClientInfoException(String reason, String SQLState, int vendorCode, Map<String, ClientInfoStatus> failedProperties) Constructs aSQLClientInfoException
object initialized with a givenreason
,SQLState
,vendorCode
andfailedProperties
. Thecause
is not initialized, and may subsequently be initialized by a call to theThrowable.initCause(java.lang.Throwable)
method.- Parameters:
reason
- a description of the exceptionSQLState
- an XOPEN or SQL:2003 code identifying the exceptionvendorCode
- a database vendor-specific exception codefailedProperties
- 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 inClientInfoStatus
- Since:
- 1.6
-
SQLClientInfoException
public SQLClientInfoException(String reason, String SQLState, int vendorCode, Map<String, ClientInfoStatus> failedProperties, Throwable cause) Constructs aSQLClientInfoException
object initialized with a givenreason
,SQLState
,cause
,vendorCode
andfailedProperties
.- Parameters:
reason
- a description of the exceptionSQLState
- an XOPEN or SQL:2003 code identifying the exceptionvendorCode
- a database vendor-specific exception codefailedProperties
- 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 inClientInfoStatus
cause
- the underlying reason for thisSQLException
(which is saved for later retrieval by thegetCause()
method); may be null indicating the cause is non-existent or unknown.- Since:
- 1.6
-
-
Method Details
-
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 inClientInfoStatus
- Returns:
- Map list containing the client info properties that could not be set
- Since:
- 1.6
-