compact2, compact3
java.sql
Class SQLClientInfoException
- java.lang.Object
-
- java.lang.Throwable
-
- java.lang.Exception
-
- java.sql.SQLException
-
- java.sql.SQLClientInfoException
-
- All Implemented Interfaces:
- Serializable, Iterable<Throwable>
public class SQLClientInfoException extends SQLException
The subclass ofSQLException
is thrown when one or more client info properties could not be set on aConnection
. In addition to the information provided bySQLException
, aSQLClientInfoException
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 theConnection.setClientInfo
method threw an exception. An application can use thegetFailedProperties
method to retrieve a list of client info properties that were not set. The properties are identified by passing aMap<String,ClientInfoStatus>
to the appropriateSQLClientInfoException
constructor.- Since:
- 1.6
- See Also:
-
ClientInfoStatus
,Connection.setClientInfo(java.lang.String, java.lang.String)
, Serialized Form
-
-
Constructor Summary
Constructors Constructor and Description SQLClientInfoException()
Constructs aSQLClientInfoException
Object.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
.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(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
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description Map<String,ClientInfoStatus>
getFailedProperties()
Returns 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 Detail
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
public SQLClientInfoException(Map<String,ClientInfoStatus> failedProperties)
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
public SQLClientInfoException(Map<String,ClientInfoStatus> failedProperties, Throwable cause)
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
public SQLClientInfoException(String reason, Map<String,ClientInfoStatus> failedProperties)
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 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 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 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 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 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 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 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 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 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 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 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 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 Detail
getFailedProperties
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 inClientInfoStatus
- Returns:
- Map list containing the client info properties that could not be set
- Since:
- 1.6
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.