Module java.sql
Package java.sql

Class SQLClientInfoException

java.lang.Object
java.lang.Throwable
java.lang.Exception
java.sql.SQLException
java.sql.SQLClientInfoException
All Implemented Interfaces:
Serializable,Iterable<Throwable>
public classSQLClientInfoExceptionextendsSQLException
The subclass ofSQLException is thrown when one or more client info properties could not be set on aConnection. In addition to the information provided bySQLException, aSQLClientInfoException 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 theConnection.setClientInfo method threw an exception. An application can use thegetFailedProperties method to retrieve a list of client info properties that were not set. The properties are identified by passing aMap<String,ClientInfoStatus> to the appropriateSQLClientInfoException constructor.
Since:
1.6
See Also:

  • Constructor Details

    • SQLClientInfoException

      public SQLClientInfoException()
      Constructs aSQLClientInfoException Object. Thereason,SQLState, and failedProperties list are initialized tonull and the vendor code is initialized to 0. Thecause is not initialized, and may subsequently be initialized by a call to theThrowable.initCause(java.lang.Throwable) method.
      Since:
      1.6

    • SQLClientInfoException

      public SQLClientInfoException(Map<String,ClientInfoStatus> failedProperties)
      Constructs aSQLClientInfoException object initialized with a givenfailedProperties. Thereason andSQLState are initialized tonull and the vendor code is initialized to 0. Thecause is not initialized, and may subsequently be initialized by a call to theThrowable.initCause(java.lang.Throwable) method.
      Parameters:
      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 inClientInfoStatus
      Since:
      1.6

    • SQLClientInfoException

      public SQLClientInfoException(Map<String,ClientInfoStatus> failedProperties,Throwable cause)
      Constructs aSQLClientInfoException object initialized with a givencause andfailedProperties. Thereason is initialized tonull ifcause==null or tocause.toString() ifcause!=null and the vendor code is initialized to 0.
      Parameters:
      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 inClientInfoStatus
      cause - the (which is saved for later retrieval by thegetCause() method); may be null indicating the cause is non-existent or unknown.
      Since:
      1.6

    • SQLClientInfoException

      public SQLClientInfoException(String reason,Map<String,ClientInfoStatus> failedProperties)
      Constructs aSQLClientInfoException object initialized with a givenreason andfailedProperties. TheSQLState is initialized tonull and the vendor code is initialized to 0. Thecause is not initialized, and may subsequently be initialized by a call to theThrowable.initCause(java.lang.Throwable) method.
      Parameters:
      reason - a description of the exception
      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 inClientInfoStatus
      Since:
      1.6

    • SQLClientInfoException

      public SQLClientInfoException(String reason,Map<String,ClientInfoStatus> failedProperties,Throwable cause)
      Constructs aSQLClientInfoException object initialized with a givenreason,cause andfailedProperties. TheSQLState is initialized tonull and the vendor code is initialized to 0.
      Parameters:
      reason - a description of the exception
      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 inClientInfoStatus
      cause - the underlying reason for thisSQLException (which is saved for later retrieval by thegetCause() method); may be null indicating the cause is non-existent or unknown.
      Since:
      1.6

    • SQLClientInfoException

      public SQLClientInfoException(String reason,String SQLState,Map<String,ClientInfoStatus> failedProperties)
      Constructs aSQLClientInfoException object initialized with a givenreason,SQLState andfailedProperties. Thecause is not initialized, and may subsequently be initialized by a call to theThrowable.initCause(java.lang.Throwable) method. The vendor code is initialized to 0.
      Parameters:
      reason - a description of the exception
      SQLState - an XOPEN or SQL:2003 code identifying the exception
      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 inClientInfoStatus
      Since:
      1.6

    • SQLClientInfoException

      public SQLClientInfoException(String reason,String SQLState,Map<String,ClientInfoStatus> failedProperties,Throwable cause)
      Constructs aSQLClientInfoException object initialized with a givenreason,SQLState,cause andfailedProperties. The vendor code is initialized to 0.
      Parameters:
      reason - a description of the exception
      SQLState - an XOPEN or SQL:2003 code identifying the exception
      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 inClientInfoStatus
      cause - the underlying reason for thisSQLException (which is saved for later retrieval by thegetCause() method); may be null indicating the cause is non-existent or unknown.
      Since:
      1.6

    • SQLClientInfoException

      public SQLClientInfoException(String reason,String SQLState, int vendorCode,Map<String,ClientInfoStatus> failedProperties)
      Constructs aSQLClientInfoException object initialized with a givenreason,SQLState,vendorCode andfailedProperties. Thecause is not initialized, and may subsequently be initialized by a call to theThrowable.initCause(java.lang.Throwable) method.
      Parameters:
      reason - a description of the exception
      SQLState - an XOPEN or SQL:2003 code identifying the exception
      vendorCode - a database vendor-specific exception code
      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 inClientInfoStatus
      Since:
      1.6

    • SQLClientInfoException

      public SQLClientInfoException(String reason,String SQLState, int vendorCode,Map<String,ClientInfoStatus> failedProperties,Throwable cause)
      Constructs aSQLClientInfoException object initialized with a givenreason,SQLState,cause,vendorCode andfailedProperties.
      Parameters:
      reason - a description of the exception
      SQLState - an XOPEN or SQL:2003 code identifying the exception
      vendorCode - a database vendor-specific exception code
      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 inClientInfoStatus
      cause - the underlying reason for thisSQLException (which is saved for later retrieval by thegetCause() method); may be null indicating the cause is non-existent or unknown.
      Since:
      1.6

  • Method Details

    • getFailedProperties

      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 inClientInfoStatus
      Returns:
      Map list containing the client info properties that could not be set
      Since:
      1.6