java.sql: public class: SQLClientInfoException

java.sql
public class: SQLClientInfoException [javadoc | source]

java.lang.Object
   java.lang.Throwable
      java.lang.Exception
         java.sql.SQLException
            java.sql.SQLClientInfoException

All Implemented Interfaces:
Iterable, Serializable

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.

Also see:

ClientInfoStatus

Connection#setClientInfo

since: 1.6 -

Fields inherited from java.lang.Exception:
serialVersionUID

Constructor:

Constructor:
public SQLClientInfoException() { this.failedProperties = null; } 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` -
public SQLClientInfoException(Map failedProperties) { this.failedProperties = 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` - 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` -
public SQLClientInfoException(Map failedProperties, Throwable cause) { super(cause != null?cause.toString():null); initCause(cause); this.failedProperties = failedProperties; } 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` - 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. since: `1.6` -
public SQLClientInfoException(String reason, Map failedProperties) { super(reason); this.failedProperties = 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` - 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 in `ClientInfoStatus` since: `1.6` -
public SQLClientInfoException(String reason, Map failedProperties, Throwable cause) { super(reason); initCause(cause); this.failedProperties = failedProperties; } 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` - 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 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. since: `1.6` -
public SQLClientInfoException(String reason, String SQLState, Map failedProperties) { super(reason, SQLState); this.failedProperties = 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` - 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 in `ClientInfoStatus` since: `1.6` -
public SQLClientInfoException(String reason, String SQLState, Map failedProperties, Throwable cause) { super(reason, SQLState); initCause(cause); this.failedProperties = failedProperties; } Constructs a `SQLClientInfoException` object initialized with a given `reason`, `SQLState`, `cause` and `failedProperties`. 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 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. since: `1.6` -
public SQLClientInfoException(String reason, String SQLState, int vendorCode, Map failedProperties) { super(reason, SQLState, vendorCode); this.failedProperties = 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` - 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 in `ClientInfoStatus` since: `1.6` -
public SQLClientInfoException(String reason, String SQLState, int vendorCode, Map failedProperties, Throwable cause) { super(reason, SQLState, vendorCode); initCause(cause); this.failedProperties = failedProperties; } Constructs a `SQLClientInfoException` object initialized with a given `reason`, `SQLState`, `cause`, `vendorCode` and `failedProperties`. 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 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. since: `1.6` -

 public SQLClientInfoException() {
                this.failedProperties = null;
}

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)

since: 1.6 -

 public SQLClientInfoException(Map failedProperties) {
                this.failedProperties = failedProperties;
}

SQLClientInfoException

failedProperties

reason

SQLState

null

cause

Throwable#initCause(java.lang.Throwable)

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 in ClientInfoStatus

since: 1.6 -

 public SQLClientInfoException(Map failedProperties,
    Throwable cause) {
                super(cause != null?cause.toString():null);
                initCause(cause);
                this.failedProperties = failedProperties;
}

SQLClientInfoException

cause

failedProperties

reason

null

cause==null

cause.toString()

cause!=null

Parameters:

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 -

 public SQLClientInfoException(String reason,
    Map failedProperties) {
                super(reason);
                this.failedProperties = failedProperties;
}

SQLClientInfoException

reason

failedProperties

SQLState

null

cause

Throwable#initCause(java.lang.Throwable)

Parameters:

reason - a description of the exception

since: 1.6 -

 public SQLClientInfoException(String reason,
    Map failedProperties,
    Throwable cause) {
                super(reason);
                initCause(cause);
                this.failedProperties = failedProperties;
}

SQLClientInfoException

reason

cause

failedProperties

SQLState

null

Parameters:

reason - a description of the exception

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 -

 public SQLClientInfoException(String reason,
    String SQLState,
    Map failedProperties) {
                super(reason, SQLState);
                this.failedProperties = failedProperties;
}

SQLClientInfoException

reason

SQLState

failedProperties

cause

Throwable#initCause(java.lang.Throwable)

Parameters:

reason - a description of the exception

SQLState - an XOPEN or SQL:2003 code identifying the exception

since: 1.6 -

 public SQLClientInfoException(String reason,
    String SQLState,
    Map failedProperties,
    Throwable cause) {
                super(reason, SQLState);
                initCause(cause);
                this.failedProperties = failedProperties;
}

SQLClientInfoException

reason

SQLState

cause

failedProperties

Parameters:

reason - a description of the exception

SQLState - an XOPEN or SQL:2003 code identifying the exception

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 -

 public SQLClientInfoException(String reason,
    String SQLState,
    int vendorCode,
    Map failedProperties) {
                super(reason, SQLState, vendorCode);
                this.failedProperties = failedProperties;
}

SQLClientInfoException

reason

SQLState

vendorCode

failedProperties

cause

Throwable#initCause(java.lang.Throwable)

Parameters:

reason - a description of the exception

SQLState - an XOPEN or SQL:2003 code identifying the exception

vendorCode - a database vendor-specific exception code

since: 1.6 -

 public SQLClientInfoException(String reason,
    String SQLState,
    int vendorCode,
    Map failedProperties,
    Throwable cause) {
                super(reason, SQLState, vendorCode);
                initCause(cause);
                this.failedProperties = failedProperties;
}

SQLClientInfoException

reason

SQLState

cause

vendorCode

failedProperties

Parameters:

reason - a description of the exception

SQLState - an XOPEN or SQL:2003 code identifying the exception

vendorCode - a database vendor-specific exception code

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 -

Method from java.sql.SQLClientInfoException Summary:
getFailedProperties

Methods from java.sql.SQLException:
getErrorCode, getNextException, getSQLState, iterator, setNextException

Methods from java.lang.Throwable:
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from java.sql.SQLClientInfoException Detail:
public Map getFailedProperties() { return this.failedProperties; } 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`

Method from java.sql.SQLClientInfoException Detail:

 public Map getFailedProperties() {
                return this.failedProperties;
}

ClientInfoStatus