com.solacesystems.solclientj.core

Class SolclientException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.solacesystems.solclientj.core.SolclientException

All Implemented Interfaces:

java.io.Serializable

public class SolclientException
extends java.lang.RuntimeException

Represents a runtime exception that can be raised from the API.
It encapsulates the details that were available at the time the exception was raised:

• A message
• A SolEnum.ReturnCode
• An optional SolclientErrorInfo

Note: The SolclientException object is allocated from the heap and could cause garbage collection interruptions when it is no longer referenced.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SolclientException(SolclientErrorInfo errorInfo, int returnCode) Constructs the exception having a message based on the details of SolclientErrorInfo and the SolEnum.ReturnCode
SolclientException(java.lang.String message, int returnCode) Constructs the exception having a message and a SolEnum.ReturnCode
SolclientException(java.lang.String message, SolclientErrorInfo errorInfo, int returnCode) Constructs the exception based on the message parameter with appended details of SolclientErrorInfo and the SolEnum.ReturnCode

Method Summary

Modifier and Type	Method and Description
java.lang.String	getMessage() Returns a formatted error message with the numerical and string representation of the SolEnum.ReturnCode Details of the SolclientErrorInfo may be ommited in the message if none was available.
int	getReturnCode() Returns the SolEnum.ReturnCode at the time of the exception.
SolclientErrorInfo	getSolclientErrorInfo() Returns the available SolclientErrorInfo when the exception was raised.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SolclientException

public SolclientException(java.lang.String message,
                          SolclientErrorInfo errorInfo,
                          int returnCode)

Constructs the exception based on the message parameter with appended details of SolclientErrorInfo and the SolEnum.ReturnCode

Parameters:

message -

errorInfo - SolclientErrorInfo

returnCode - SolEnum.ReturnCode

SolclientException

public SolclientException(SolclientErrorInfo errorInfo,
                          int returnCode)

Constructs the exception having a message based on the details of SolclientErrorInfo and the SolEnum.ReturnCode

Parameters:

errorInfo - SolclientErrorInfo

returnCode - SolEnum.ReturnCode

SolclientException

public SolclientException(java.lang.String message,
                          int returnCode)

Constructs the exception having a message and a SolEnum.ReturnCode

Parameters:

message -

returnCode - SolEnum.ReturnCode

Method Detail

getSolclientErrorInfo

public SolclientErrorInfo getSolclientErrorInfo()

Returns the available SolclientErrorInfo when the exception was raised.

Returns:

SolclientErrorInfo

getMessage

public java.lang.String getMessage()

Returns a formatted error message with the numerical and string representation of the SolEnum.ReturnCode
Details of the SolclientErrorInfo may be ommited in the message if none was available.

Overrides:

getMessage in class java.lang.Throwable

Returns:

Formatted error message.

getReturnCode

public int getReturnCode()

Returns the SolEnum.ReturnCode at the time of the exception.

Returns:

SolEnum.ReturnCode