com.solacesystems.jcsmp

Class JCSMPException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.apache.commons.lang.exception.NestableException

com.solacesystems.common.ChainedException

com.solacesystems.jcsmp.JCSMPException

All Implemented Interfaces:

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

Direct Known Subclasses:

JCSMPInterruptedException, JCSMPNotComparableException, JCSMPOperationException, JCSMPStateException, JCSMPTransportException, PropertyMismatchException, SDTException

public class JCSMPException
extends com.solacesystems.common.ChainedException

The base class of JCSMP exceptions. In general, applications must handle the appropriate JCSMPException subclass, depending on the context.

JCSMPException

• JCSMPTransportException - An appliance communication related error. These exceptions can be raised after several retries, depending on the session configuration.

  When an application receives these exceptions from a JCSMPSession, the session becomes unusable.

• JCSMPStateException - Usually caused by an application or JCSMP program logic error. Exceptions in this category are unrecoverable.
  • InvalidOperationException - The operation is supported, but the object is in wrong state.
    • StaleSessionException - The operation failed because the object is in the stale state. This occurs when a session has lost its connection and couldn't recover it because the max reconnection attempts has been exceeded (See reconnectRetries in JCSMPChannelProperties).
    • ClosedFacilityException - The operation failed because the object was closed. This occurs when the object was explicitly closed, or closed because the session associated with the object was closed.
  • InvalidPropertiesException - An error in the supplied JCSMPProperties.
  • OperationNotSupportedException - An error that is usually configuration related (such as calling addSubscription in a non-blocking mode while there is no Session event handler configured).
  • JCSMPFatalErrorException - An error usually related to a bug in JCSMP.
• JCSMPOperationException - An error related to CSMP protocol. Examples are the 4xx SMF response, and the non-OK response of CSMP.
• JCSMPErrorResponseException - An error related to CSMP protocol. The application might need to examine responseBody to discover the cause.
• JCSMPRequestTimeoutException - An error raised when a blocking request operation times out.
• JCSMPLoginFailureException - An error raised when a consumer or producer fails to login to the appliance upon opening a control or data channel.
• SubscriptionsOutOfSynchException - The application's view of a subscriber's subscriptions does not corresponding with what is on the appliance.
• InvalidMessageReceivedException - A messaging format error.
• VersionNotSupportException - The current appliance version is not compatible with JCSMP.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
JCSMPException(String message) Constructs a JCSMPException with the specified detailed message.
JCSMPException(String message, Throwable cause) Constructs a JCSMPException with the specified detailed message and nested exception.
JCSMPException(String message, Throwable cause, String extraInfo) Constructs a JCSMPException with the specified detailed message and nested exception.

Method Summary

Modifier and Type	Method and Description
String	getExtraInfo()
void	setExtraInfo(String extraInfo)

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, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

JCSMPException

public JCSMPException(String message,
                      Throwable cause)

Constructs a JCSMPException with the specified detailed message and nested exception.

Parameters:

message - The detailed message.

cause - The nested exception.

JCSMPException

public JCSMPException(String message,
                      Throwable cause,
                      String extraInfo)

Constructs a JCSMPException with the specified detailed message and nested exception.

Parameters:

message - The detailed message.

cause - The nested exception.

extraInfo - A string that contains more information about this exception.

JCSMPException

public JCSMPException(String message)

Constructs a JCSMPException with the specified detailed message.

Parameters:

message - The detailed message.

Method Detail

setExtraInfo

public void setExtraInfo(String extraInfo)

getExtraInfo

public String getExtraInfo()