FileDocCategorySizeDatePackage
SQLClientInfoException.javaAPI DocJava SE 6 API11938Tue Jun 10 00:25:50 BST 2008java.sql

SQLClientInfoException

public class SQLClientInfoException extends SQLException
The subclass of {@link 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.

see
ClientInfoStatus
see
Connection#setClientInfo
since
1.6

Fields Summary
private Map
failedProperties
private static final long
serialVersionUID
Constructors 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 {@link Throwable#initCause(java.lang.Throwable)} method.

since
1.6


		this.failedProperties = null;
public SQLClientInfoException(Map 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 {@link Throwable#initCause(java.lang.Throwable)} method.

param
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

since
1.6


		this.failedProperties = failedProperties;
public SQLClientInfoException(Map 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.

param
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
param
cause 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


                super(cause != null?cause.toString():null);
		initCause(cause);
		this.failedProperties = failedProperties;
public SQLClientInfoException(String reason, Map 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 {@link Throwable#initCause(java.lang.Throwable)} method.

param
reason a description of the exception
param
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

since
1.6


		super(reason);
		this.failedProperties = failedProperties;
public SQLClientInfoException(String reason, Map 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.

param
reason a description of the exception
param
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
param
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.

since
1.6


		super(reason);
		initCause(cause);
		this.failedProperties = failedProperties;
public SQLClientInfoException(String reason, String SQLState, Map 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 {@link Throwable#initCause(java.lang.Throwable)} method. The vendor code is initialized to 0.

param
reason a description of the exception
param
SQLState an XOPEN or SQL:2003 code identifying the exception
param
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

since
1.6


		super(reason, SQLState);
		this.failedProperties = failedProperties;
public SQLClientInfoException(String reason, String SQLState, Map failedProperties, Throwable cause)
Constructs a SQLClientInfoException object initialized with a given reason, SQLState, cause and failedProperties. The vendor code is initialized to 0.

param
reason a description of the exception
param
SQLState an XOPEN or SQL:2003 code identifying the exception
param
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
param
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.

since
1.6


		super(reason, SQLState);
		initCause(cause);
		this.failedProperties = failedProperties;
public SQLClientInfoException(String reason, String SQLState, int vendorCode, Map 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 {@link Throwable#initCause(java.lang.Throwable)} method.

param
reason a description of the exception
param
SQLState an XOPEN or SQL:2003 code identifying the exception
param
vendorCode a database vendor-specific exception code
param
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

since
1.6

		
		super(reason, SQLState, vendorCode);
		this.failedProperties = failedProperties;
public SQLClientInfoException(String reason, String SQLState, int vendorCode, Map failedProperties, Throwable cause)
Constructs a SQLClientInfoException object initialized with a given reason, SQLState, cause, vendorCode and failedProperties.

param
reason a description of the exception
param
SQLState an XOPEN or SQL:2003 code identifying the exception
param
vendorCode a database vendor-specific exception code
param
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
param
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.

since
1.6


		super(reason, SQLState, vendorCode);
		initCause(cause);
		this.failedProperties = failedProperties;
Methods Summary
public java.util.MapgetFailedProperties()
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
Map list containing the client info properties that could not be set

since
1.6

		
		return this.failedProperties;