public class SQLClientInfoException extends SQLException
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.
ClientInfoStatus
,
Connection.setClientInfo(java.lang.String, java.lang.String)
,
Serialized FormConstructor and Description |
---|
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,
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 . |
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 . |
Modifier and Type | Method and Description |
---|---|
Map<String,ClientInfoStatus> |
getFailedProperties()
Returns the list of client info properties that could not be set.
|
getErrorCode, getNextException, getSQLState, iterator, setNextException
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
forEach, spliterator
public SQLClientInfoException()
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)
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.
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)
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.
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)
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.
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 in ClientInfoStatus
public SQLClientInfoException(String reason, Map<String,ClientInfoStatus> failedProperties, Throwable cause)
SQLClientInfoException
object initialized with a
given reason
, cause
and
failedProperties
.
The SQLState
is initialized
to null
and the vendor code is initialized to 0.
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 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)
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.
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 in ClientInfoStatus
public SQLClientInfoException(String reason, String SQLState, Map<String,ClientInfoStatus> failedProperties, Throwable cause)
SQLClientInfoException
object initialized with a
given reason
, SQLState
, cause
and failedProperties
. The vendor code is initialized to 0.
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 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)
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.
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 in ClientInfoStatus
public SQLClientInfoException(String reason, String SQLState, int vendorCode, Map<String,ClientInfoStatus> failedProperties, Throwable cause)
SQLClientInfoException
object initialized with a
given reason
, SQLState
,
cause
, vendorCode
and
failedProperties
.
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 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 Map<String,ClientInfoStatus> getFailedProperties()
ClientInfoStatus
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, 2016, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.