SQLClientInfoException
open class SQLClientInfoException : SQLException
kotlin.Any | ||||
↳ | kotlin.Throwable | |||
↳ | java.lang.Exception | |||
↳ | java.sql.SQLException | |||
↳ | java.sql.SQLClientInfoException |
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.
Summary
Public constructors | |
---|---|
Constructs a |
|
SQLClientInfoException(failedProperties: MutableMap<String!, ClientInfoStatus!>!) Constructs a |
|
SQLClientInfoException(failedProperties: MutableMap<String!, ClientInfoStatus!>!, cause: Throwable!) Constructs a |
|
SQLClientInfoException(reason: String!, failedProperties: MutableMap<String!, ClientInfoStatus!>!) Constructs a |
|
SQLClientInfoException(reason: String!, failedProperties: MutableMap<String!, ClientInfoStatus!>!, cause: Throwable!) Constructs a |
|
SQLClientInfoException(reason: String!, SQLState: String!, failedProperties: MutableMap<String!, ClientInfoStatus!>!) Constructs a |
|
SQLClientInfoException(reason: String!, SQLState: String!, failedProperties: MutableMap<String!, ClientInfoStatus!>!, cause: Throwable!) Constructs a |
|
SQLClientInfoException(reason: String!, SQLState: String!, vendorCode: Int, failedProperties: MutableMap<String!, ClientInfoStatus!>!) Constructs a |
|
SQLClientInfoException(reason: String!, SQLState: String!, vendorCode: Int, failedProperties: MutableMap<String!, ClientInfoStatus!>!, cause: Throwable!) Constructs a |
Public methods | |
---|---|
open MutableMap<String!, ClientInfoStatus!>! |
Returns the list of client info properties that could not be set. |
Inherited functions | |
---|---|
Public constructors
SQLClientInfoException
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.
SQLClientInfoException
SQLClientInfoException(failedProperties: MutableMap<String!, ClientInfoStatus!>!)
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 |
MutableMap<String!, ClientInfoStatus!>!: 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
|
SQLClientInfoException
SQLClientInfoException(
failedProperties: MutableMap<String!, ClientInfoStatus!>!,
cause: Throwable!)
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 |
MutableMap<String!, ClientInfoStatus!>!: 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 |
Throwable!: the (which is saved for later retrieval by the getCause() method); may be null indicating the cause is non-existent or unknown.
|
SQLClientInfoException
SQLClientInfoException(
reason: String!,
failedProperties: MutableMap<String!, ClientInfoStatus!>!)
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 |
String!: a description of the exception |
failedProperties |
MutableMap<String!, ClientInfoStatus!>!: 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
|
SQLClientInfoException
SQLClientInfoException(
reason: String!,
failedProperties: MutableMap<String!, ClientInfoStatus!>!,
cause: Throwable!)
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 |
String!: a description of the exception |
failedProperties |
MutableMap<String!, ClientInfoStatus!>!: 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 |
Throwable!: 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.
|
SQLClientInfoException
SQLClientInfoException(
reason: String!,
SQLState: String!,
failedProperties: MutableMap<String!, ClientInfoStatus!>!)
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 |
String!: a description of the exception |
SQLState |
String!: an XOPEN or SQL:2003 code identifying the exception |
failedProperties |
MutableMap<String!, ClientInfoStatus!>!: 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
|
SQLClientInfoException
SQLClientInfoException(
reason: String!,
SQLState: String!,
failedProperties: MutableMap<String!, ClientInfoStatus!>!,
cause: Throwable!)
Constructs a SQLClientInfoException
object initialized with a given reason
, SQLState
, cause
and failedProperties
. The vendor code is initialized to 0.
Parameters | |
---|---|
reason |
String!: a description of the exception |
SQLState |
String!: an XOPEN or SQL:2003 code identifying the exception |
failedProperties |
MutableMap<String!, ClientInfoStatus!>!: 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 |
Throwable!: 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.
|
SQLClientInfoException
SQLClientInfoException(
reason: String!,
SQLState: String!,
vendorCode: Int,
failedProperties: MutableMap<String!, ClientInfoStatus!>!)
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 |
String!: a description of the exception |
SQLState |
String!: an XOPEN or SQL:2003 code identifying the exception |
vendorCode |
Int: a database vendor-specific exception code |
failedProperties |
MutableMap<String!, ClientInfoStatus!>!: 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
|
SQLClientInfoException
SQLClientInfoException(
reason: String!,
SQLState: String!,
vendorCode: Int,
failedProperties: MutableMap<String!, ClientInfoStatus!>!,
cause: Throwable!)
Constructs a SQLClientInfoException
object initialized with a given reason
, SQLState
, cause
, vendorCode
and failedProperties
.
Parameters | |
---|---|
reason |
String!: a description of the exception |
SQLState |
String!: an XOPEN or SQL:2003 code identifying the exception |
vendorCode |
Int: a database vendor-specific exception code |
failedProperties |
MutableMap<String!, ClientInfoStatus!>!: 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 |
Throwable!: 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
getFailedProperties
open fun getFailedProperties(): MutableMap<String!, ClientInfoStatus!>!
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
Return | |
---|---|
MutableMap<String!, ClientInfoStatus!>! |
Map list containing the client info properties that could not be set |