APIdia Launch Partner
Top Description Fields Constructors Methods
java.sql

public Class SQLClientInfoException

extends SQLException
Class Inheritance
Imports
java.util.Map

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
ClientInfoStatus, Connection#setClientInfo

Field Summary

Modifier and TypeField and Description
private Map<String, ClientInfoStatus>
private static final long

Constructor Summary

AccessConstructor and Description
public
SQLClientInfoException()

Constructs a SQLClientInfoException Object.

public
SQLClientInfoException(Map<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
failedProperties
)

Constructs a SQLClientInfoException object initialized with a given failedProperties.

public
SQLClientInfoException(Map<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
failedProperties
,
Throwable
the (which is saved for later retrieval by the getCause() method); may be null indicating the cause is non-existent or unknown.
cause
)

Constructs a SQLClientInfoException object initialized with a given cause and failedProperties.

public
SQLClientInfoException(String
a description of the exception
reason
,
Map<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
failedProperties
)

Constructs a SQLClientInfoException object initialized with a given reason and failedProperties.

public
SQLClientInfoException(String
a description of the exception
reason
,
Map<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
failedProperties
,
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.
cause
)

Constructs a SQLClientInfoException object initialized with a given reason, cause and failedProperties.

public
SQLClientInfoException(String
a description of the exception
reason
,
String
an XOPEN or SQL:2003 code identifying the exception
SQLState
,
Map<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
failedProperties
)

Constructs a SQLClientInfoException object initialized with a given reason, SQLState and failedProperties.

public
SQLClientInfoException(String
a description of the exception
reason
,
String
an XOPEN or SQL:2003 code identifying the exception
SQLState
,
Map<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
failedProperties
,
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.
cause
)

Constructs a SQLClientInfoException object initialized with a given reason, SQLState, cause and failedProperties.

public
SQLClientInfoException(String
a description of the exception
reason
,
String
an XOPEN or SQL:2003 code identifying the exception
SQLState
,
int
a database vendor-specific exception code
vendorCode
,
Map<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
failedProperties
)

Constructs a SQLClientInfoException object initialized with a given reason, SQLState, vendorCode and failedProperties.

public
SQLClientInfoException(String
a description of the exception
reason
,
String
an XOPEN or SQL:2003 code identifying the exception
SQLState
,
int
a database vendor-specific exception code
vendorCode
,
Map<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
failedProperties
,
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.
cause
)

Constructs a SQLClientInfoException object initialized with a given reason, SQLState, cause, vendorCode and failedProperties.

Method Summary

Modifier and TypeMethod and Description
public Map<String, ClientInfoStatus>

Returns:

Map list containing the client info properties that could not be set
getFailedProperties
()

Returns the list of client info properties that could not be set.

Inherited from java.sql.SQLException:
getErrorCodegetNextExceptiongetSQLStateiteratorsetNextException

Field Detail

failedPropertiesback to summary
private Map<String, ClientInfoStatus> failedProperties
Annotations
@SuppressWarnings:serial
serialVersionUIDback to summary
private static final long serialVersionUID

Hides java.sql.SQLException.serialVersionUID.

Constructor Detail

SQLClientInfoExceptionback to summary
public 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.

Since
1.6
SQLClientInfoExceptionback to summary
public SQLClientInfoException(Map<String, ClientInfoStatus> failedProperties)

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:Map<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

Since
1.6
SQLClientInfoExceptionback to summary
public SQLClientInfoException(Map<String, ClientInfoStatus> failedProperties, Throwable cause)

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:Map<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.

Since
1.6
SQLClientInfoExceptionback to summary
public SQLClientInfoException(String reason, Map<String, ClientInfoStatus> failedProperties)

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:Map<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

Since
1.6
SQLClientInfoExceptionback to summary
public SQLClientInfoException(String reason, Map<String, ClientInfoStatus> failedProperties, Throwable cause)

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:Map<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.

Since
1.6
SQLClientInfoExceptionback to summary
public SQLClientInfoException(String reason, String SQLState, Map<String, ClientInfoStatus> failedProperties)

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:Map<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

Since
1.6
SQLClientInfoExceptionback to summary
public SQLClientInfoException(String reason, String SQLState, Map<String, ClientInfoStatus> failedProperties, Throwable cause)

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:Map<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.

Since
1.6
SQLClientInfoExceptionback to summary
public SQLClientInfoException(String reason, String SQLState, int vendorCode, Map<String, ClientInfoStatus> failedProperties)

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:Map<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

Since
1.6
SQLClientInfoExceptionback to summary
public 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.

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:Map<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.

Since
1.6

Method Detail

getFailedPropertiesback to summary
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 in ClientInfoStatus

Returns:Map<String, ClientInfoStatus>

Map list containing the client info properties that could not be set

Since
1.6