com.solacesystems.solclientj.core

Class SolclientErrorInfo

java.lang.Object

com.solacesystems.solclientj.core.SolclientErrorInfo

public class SolclientErrorInfo
extends java.lang.Object

This data structure holds detailed error information based on the underlying API implementation and as relayed from the Appliance.
The last SolclientErrorInfo can be obtained from Solclient.getLastErrorInfo().
When available the last SolclientErrorInfo accompanies a raised SolclientException

Constructor Summary

Constructors

Constructor and Description
SolclientErrorInfo(int responseCode, int subCode, java.lang.String errorStr) Constructs this data structure with the provided attributes.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getErrorStr() An information error string for certain types of subcodes (an empty string if not used).
int	getResponseCode() A response code that is returned by the Appliance for some SolEnum.SubCode otherwise zero.
int	getSubCode()
java.lang.String	toString() Provides a formatted representation of the error, containing the errorStr, a numerical and String representation of the SolEnum.SubCode , and the numerical representation of the responseCode.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SolclientErrorInfo

public SolclientErrorInfo(int responseCode,
                          int subCode,
                          java.lang.String errorStr)

Constructs this data structure with the provided attributes.

Parameters:

responseCode -

subCode - SolEnum.SubCode

errorStr -

Method Detail

getErrorStr

public java.lang.String getErrorStr()

An information error string for certain types of subcodes (an empty string if not used).

Returns:

the error string if available

getResponseCode

public int getResponseCode()

A response code that is returned by the Appliance for some SolEnum.SubCode otherwise zero.

Returns:

the response code from the Appliance

getSubCode

public int getSubCode()

Returns:

SolEnum.SubCode

toString

public java.lang.String toString()

Provides a formatted representation of the error, containing the errorStr, a numerical and String representation of the SolEnum.SubCode , and the numerical representation of the responseCode.

Overrides:

toString in class java.lang.Object

Returns:

Formatted error message.