java.lang.Object java.lang.Throwable java.lang.Exception java.sql.SQLException java.sql.ClientInfoException
public class ClientInfoException
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 ClientInfoException
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.
Field Summary | |
---|---|
static int |
REASON_UNKNOWN
The client info property could not be set for some unknown reason |
static int |
REASON_UNKNOWN_PROPERTY
The client info property name specified was not a recognized property name |
static int |
REASON_VALUE_INVALID
The value specified for the client info property was not valid |
static int |
REASON_VALUE_TRUNCATED
The value specified for the client info property was too large |
Constructor Summary | |
---|---|
ClientInfoException()
Constructs a ClientInfoException Object. |
|
ClientInfoException(Properties failedProperties)
Constructs a ClientInfoException object initialized with a
given failedProperties . |
|
ClientInfoException(Properties failedProperties,
Throwable cause)
Constructs a ClientInfoException object initialized with
a given cause and failedProperties . |
|
ClientInfoException(String reason,
Properties failedProperties)
Constructs a ClientInfoException object initialized with a
given reason and failedProperties . |
|
ClientInfoException(String reason,
Properties failedProperties,
Throwable cause)
* Constructs a ClientInfoException object initialized with a
given reason , cause and
failedProperties . |
|
ClientInfoException(String reason,
String SQLState,
int vendorCode,
Properties failedProperties)
Constructs a ClientInfoException object initialized with a
given reason , SQLState ,
vendorCode and failedProperties . |
|
ClientInfoException(String reason,
String SQLState,
int vendorCode,
Properties failedProperties,
Throwable cause)
Constructs a ClientInfoException object initialized with a
given reason , SQLState ,
cause , vendorCode and
failedProperties . |
|
ClientInfoException(String reason,
String SQLState,
Properties failedProperties)
Constructs a ClientInfoException object initialized with a
given reason , SQLState and
failedProperties . |
|
ClientInfoException(String reason,
String SQLState,
Properties failedProperties,
Throwable cause)
Constructs a ClientInfoException object initialized with a
given reason , SQLState , cause
and failedProperties . |
Method Summary | |
---|---|
Properties |
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 |
---|
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final int REASON_UNKNOWN
public static final int REASON_UNKNOWN_PROPERTY
public static final int REASON_VALUE_INVALID
public static final int REASON_VALUE_TRUNCATED
Constructor Detail |
---|
public ClientInfoException()
ClientInfoException
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 ClientInfoException(Properties failedProperties)
ClientInfoException
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 list of property values that could not
be set. The keys in the Properties list
contain the names of the client info
properties that could not be set and
the values contain one of the reason codes
defined in ClientInfoException
public ClientInfoException(Properties failedProperties, Throwable cause)
ClientInfoException
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 list of property values that could not
be set. The keys in the Properties list
contain the names of the client info
properties that could not be set and
the values contain one of the reason codes
defined in ClientInfoException
cause
- the (which is saved for later retrieval by the getCause()
method); may be null indicating
the cause is non-existent or unknown.
public ClientInfoException(String reason, Properties failedProperties)
ClientInfoException
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
- The list of property values that could not
be set. The keys in the Properties list
contain the names of the client info
properties that could not be set and
the values contain one of the reason codes
defined in ClientInfoException
public ClientInfoException(String reason, Properties failedProperties, Throwable cause)
ClientInfoException
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 list of property values that could not
be set. The keys in the Properties list
contain the names of the client info
properties that could not be set and
the values contain one of the reason codes
defined in ClientInfoException
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 ClientInfoException(String reason, String SQLState, Properties failedProperties)
ClientInfoException
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
- The list of property values that could not
be set. The keys in the Properties list
contain the names of the client info
properties that could not be set and
the values contain one of the reason codes
defined in ClientInfoException
public ClientInfoException(String reason, String SQLState, Properties failedProperties, Throwable cause)
ClientInfoException
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 list of property values that could not
be set. The keys in the Properties list
contain the names of the client info
properties that could not be set and
the values contain one of the reason codes
defined in ClientInfoException
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 ClientInfoException(String reason, String SQLState, int vendorCode, Properties failedProperties)
ClientInfoException
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 list of property values that could not
be set. The keys in the Properties list
contain the names of the client info
properties that could not be set and
the values contain one of the reason codes
defined in ClientInfoException
public ClientInfoException(String reason, String SQLState, int vendorCode, Properties failedProperties, Throwable cause)
ClientInfoException
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 list of property values that could not
be set. The keys in the Properties list
contain the names of the client info
properties that could not be set and
the values contain one of the reason codes
defined in ClientInfoException
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.
Method Detail |
---|
public Properties getFailedProperties()
ClientInfoException