com.solace.messaging

Class PubSubPlusClientException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.solace.messaging.PubSubPlusClientException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

PubSubPlusClientException.AuthenticationException, PubSubPlusClientException.AuthorizationException, PubSubPlusClientException.IncompatibleMessageException, PubSubPlusClientException.IncompleteMessageDeliveryException, PubSubPlusClientException.InvalidConfigurationException, PubSubPlusClientException.MessageDestinationDoesNotExistException, PubSubPlusClientException.MessageNotAcknowledgedByBrokerException, PubSubPlusClientException.MessageRejectedByBrokerException, PubSubPlusClientException.MessageReplayException, PubSubPlusClientException.MessageTooBigException, PubSubPlusClientException.MissingResourceException, PubSubPlusClientException.PublisherOverflowException, PubSubPlusClientException.PubSubPlusClientIOException, PubSubPlusClientException.RequestInterruptedException, PubSubPlusClientException.ResourceProvisioningException, PubSubPlusClientException.ServiceCapabilityException, PubSubPlusClientException.ServiceDownException, PubSubPlusClientException.ServiceUnreachableException, PubSubPlusClientException.TimeoutException

@ProviderType
public class PubSubPlusClientException
extends RuntimeException

PubSubPlusClientException is the superclass of those exceptions that can be thrown during the normal operation of PubSub+ client.

Sub-codes that gives more detailed information about an error response can be found in JCSMPErrorResponseSubcodeEx.

Since:

1.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PubSubPlusClientException.AuthenticationException A class for raising errors when client authentication fails.
static class	PubSubPlusClientException.AuthorizationException A class for raising errors when client authorizations fails, client authorizations unsupported or not enabled for the service
static class	PubSubPlusClientException.IncompatibleMessageException A class for raising errors for clients that have received incompatible messages.
static class	PubSubPlusClientException.IncompleteMessageDeliveryException A class for raising errors when a publisher or receiver has been terminated gracefully, but there are messages left in the buffer.
static class	PubSubPlusClientException.InvalidConfigurationException A class for raising errors for invalid configuration.
static class	PubSubPlusClientException.MessageDestinationDoesNotExistException A class for raising errors for messages with a destination that does not exist.
static class	PubSubPlusClientException.MessageNotAcknowledgedByBrokerException A class for raising errors when a broker does not acknowledge a message.
static class	PubSubPlusClientException.MessageRejectedByBrokerException A class for raising errors when a broker rejects a message.
static class	PubSubPlusClientException.MessageReplayException A class for raising message replay related errors
static class	PubSubPlusClientException.MessageTooBigException A class for raising errors when a message too large.
static class	PubSubPlusClientException.MissingResourceException A class for raising errors when a remote resource like a queue, vpn is not found on a broker.
static class	PubSubPlusClientException.PublisherOverflowException A class for raising errors when the broker is unable to publish a message because the transport is full and buffer space is not available.
static class	PubSubPlusClientException.PubSubPlusClientIOException A class for raising errors for I/O errors that occur between a messaging broker and a client.
static class	PubSubPlusClientException.RequestInterruptedException A class for raising errors when a request operation was interrupted.
static class	PubSubPlusClientException.ResourceProvisioningException A class for raising errors when provisioning of resources on a broker failed
static class	PubSubPlusClientException.ServiceCapabilityException A class for service capability exceptions mostly due to missing permissions on vpn or user account.
static class	PubSubPlusClientException.ServiceDownException A class for raising errors when a messaging broker is not reachable or service is down (unavailable).
static class	PubSubPlusClientException.ServiceUnreachableException A class for raising errors for services that are unreachable.
static class	PubSubPlusClientException.TimeoutException A class for raising errors when a time-out occurs.
static class	PubSubPlusClientException.UnsupportedAuthorizationException A class for raising errors when client authorizations unsupported or not enabled for the service.

Constructor Summary

Constructors

Constructor and Description
PubSubPlusClientException() Creates a PubSubPlusClientException exception with null as its detailed message.
PubSubPlusClientException(String message) Constructs a PubSubPlusClientException exception with the specified detailed message.
PubSubPlusClientException(String message, Throwable cause) Constructs a PubSubPlusClientException exception with the specified detailed message and cause.
PubSubPlusClientException(Throwable cause) Constructs a PubSubPlusClientException exception with the specified cause and a detail message of:

Method Summary

Modifier and Type	Method and Description
static PubSubPlusClientException	of(Throwable t) Converts a given exception to the appropriate PubSubPlusClientException.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, 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

PubSubPlusClientException

public PubSubPlusClientException()

Creates a PubSubPlusClientException exception with null as its detailed message. The cause is not initialized, and may subsequently be initialized by a call to Throwable.initCause(java.lang.Throwable).

Since:

1.0

PubSubPlusClientException

public PubSubPlusClientException(String message)

Constructs a PubSubPlusClientException exception with the specified detailed message. The cause is not initialized, and may subsequently be initialized by a call to Throwable.initCause(java.lang.Throwable).

Parameters:

message - the detailed message. The detailed message is saved for later retrieval by the Throwable.getMessage() method.

Since:

1.0

PubSubPlusClientException

public PubSubPlusClientException(String message,
                                 Throwable cause)

Constructs a PubSubPlusClientException exception with the specified detailed message and cause.

Note that the detailed message associated with cause is not automatically incorporated in this runtime exception's detailed message.

Parameters:

message - the detailed message. The detailed message is saved for later retrieval by the Throwable.getMessage() method.

cause - the cause that is saved for later retrieval by the Throwable.getCause() method. A null value is permitted, and indicates that the cause is non-existent or unknown.

Since:

1.0

PubSubPlusClientException

public PubSubPlusClientException(Throwable cause)

Constructs a PubSubPlusClientException exception with the specified cause and a detail message of:

(cause==null ? null : cause.toString())

The cause typically contains the class and detailed message of cause). This constructor is useful for runtime exceptions that are little more than wrappers for other throwable.

Parameters:

cause - the cause that is saved for later retrieval by the Throwable.getCause() method. A null value is permitted, and indicates that the cause is non-existent or unknown.

Since:

1.0

Method Detail

of

public static PubSubPlusClientException of(Throwable t)

Converts a given exception to the appropriate PubSubPlusClientException.

Parameters:

t - the exception to be converted, should not be null

Returns:

an appropriate instance of PubSubPlusClientException

Throws:

IllegalArgumentException - if Throwable is null

Since:

1.0