com.solacesystems.jcsmp

Class JCSMPErrorResponseException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.apache.commons.lang.exception.NestableException

com.solacesystems.common.ChainedException

com.solacesystems.jcsmp.JCSMPException

com.solacesystems.jcsmp.JCSMPOperationException

com.solacesystems.jcsmp.JCSMPErrorResponseException

All Implemented Interfaces:

Serializable, org.apache.commons.lang.exception.Nestable

public class JCSMPErrorResponseException
extends JCSMPOperationException

JCSMPErrorResponseException is used to capture Solace Message Format (SMF) response codes.

These types of exceptions are not related to JCSMP. They are most likely caused by the application or the appliance's state.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
JCSMPErrorResponseException(int responseCode, String responsePhrase, String responseBody, String connectionInfoStr) Construct a JCSMPErrorResponseException

Method Summary

Modifier and Type	Method and Description
String	getConnectionInfoString()
String	getResponseBody()
int	getResponseCode()
String	getResponsePhrase()
JCSMPErrorResponseSubcode	getSubcode() Deprecated. use JCSMPErrorResponseException.getSubcodeEx().
int	getSubcodeEx() Gets the normalized subcode (JCSMPErrorResponseSubcodeEx) for this error response.
String	toString()

Methods inherited from class com.solacesystems.jcsmp.JCSMPException

getExtraInfo, setExtraInfo

Methods inherited from class org.apache.commons.lang.exception.NestableException

getCause, getMessage, getMessage, getMessages, getThrowable, getThrowableCount, getThrowables, indexOfThrowable, indexOfThrowable, printPartialStackTrace, printStackTrace, printStackTrace, printStackTrace

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getLocalizedMessage, getStackTrace, getSuppressed, initCause, setStackTrace

Methods inherited from class java.lang.Object

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

Constructor Detail

JCSMPErrorResponseException

public JCSMPErrorResponseException(int responseCode,
                                   String responsePhrase,
                                   String responseBody,
                                   String connectionInfoStr)

Construct a JCSMPErrorResponseException

Parameters:

responseCode - The SMF response code.

responsePhrase - A short phrase associated with the response code.

connectionInfoStr - A string that output the connection's information to correlate this exception to a TCP connection

responseBody - The Content Subscription Management Protocol (CSMP) response message (in XML) itself, if present. Applications must parse this XML content to find the detailed, CSMP-related error conditions.

Method Detail

getResponseBody

public String getResponseBody()

Returns:

The CSMP response message (in XML), or null, if no CSMP response message is available.

getResponseCode

public int getResponseCode()

Returns:

The SMF response code.

getResponsePhrase

public String getResponsePhrase()

Returns:

The phrase associated with the response code, or null, if the phrase is not provided.

getConnectionInfoString

public String getConnectionInfoString()

getSubcode

@Deprecated
public JCSMPErrorResponseSubcode getSubcode()

Deprecated. use JCSMPErrorResponseException.getSubcodeEx().

Gets the normalized subcode (JCSMPErrorResponseSubcode) for this error response. JCSMPErrorResponseSubcode is deprecated, use getSubcodeEx().

Returns:

A normalized subcode for this error response, if known, null otherwise.

getSubcodeEx

public int getSubcodeEx()

Gets the normalized subcode (JCSMPErrorResponseSubcodeEx) for this error response.

Returns:

A normalized subcode for this error response, if known, 0 otherwise.

toString

public String toString()

Overrides:

toString in class Throwable