Uses of Class
com.solacesystems.jcsmp.JCSMPException

Packages that use JCSMPException

Package	Description
com.solacesystems.jcsmp	The Solace Messaging API for Java (also referred to as JCSMP) is a 100% pure Java implementation that provides an object-oriented API for delivering high message throughput.
com.solacesystems.jcsmp.serialization
com.solacesystems.jcsmp.transaction

Uses of JCSMPException in com.solacesystems.jcsmp

Subclasses of JCSMPException in com.solacesystems.jcsmp

Modifier and Type	Class and Description
class	ClosedFacilityException ClosedFacilityException indicates that the requested operation cannot be fulfilled because the facility providing the operation was closed.
class	InvalidMessageReceivedException InvalidMessageReceivedException is raised when the message received from the Solace appliance is not valid.
class	InvalidOperationException InvalidOperationException indicates that the requested operation cannot be fulfilled because the object on which it was performed is not in a state to support such an operation.
class	InvalidPropertiesException InvalidPropertiesException indicates invalid properties are specified in JCSMPProperties.
class	JCSMPErrorResponseException JCSMPErrorResponseException is used to capture Solace Message Format (SMF) response codes.
class	JCSMPFatalErrorException JCSMPFatalErrorException indicates an unrecoverable error condition.
class	JCSMPFlowTransportException Indicates a transport error condition for a specific flow, while the parent session is not necessarily closed.
class	JCSMPFlowTransportUnsolicitedUnbindException This exception is used to indicate that a Guaranteed Delivery Flow (FlowReceiver) encountered a terminal condition making the flow unusable and must be closed/destroyed due to an unsolicited unbind for the resource it requires.
class	JCSMPInterruptedException
class	JCSMPLoginFailureException Indicates a producer or consumer was unable to login to the 3200 Series appliance.
class	JCSMPNotComparableException NotComparableException indicates that the comparison operation failed because the two objects being compared are semantically not comparable.
class	JCSMPOperationException JCSMPOperationException indicates an error condition related to Content Subscription Management Protocol (CSMP) operation.
class	JCSMPRequestTimeoutException Indicates that a blocking request operation timed out.
class	JCSMPResponseTimeoutException JCSMPResponseTimeoutException is used for client request timeout.
class	JCSMPSecurityException Thrown when a security restriction prevents an operation from being performed.
class	JCSMPStateException JCSMPStateException indicates that the program logic cannot proceed based on the current JCSMPSession state.
class	JCSMPTransportException JCSMPTransportException indicates an error condition regarding communication with the Solace appliance.
class	OperationNotSupportedException OperationNotSupportedException indicates the requested operation is not supported based on the current Session configuration.
class	PropertyMismatchException A general exception for property mismatch problems.
class	SDTEOFException SDTEOFException indicates a read operation was performed on an SDTStream which has no more data to read.
class	SDTException The base class of SDT exceptions.
class	SDTFormatException SDTFormatException indicates a type conversion error occurred retrieving data from an SDTMap or SDTStream.
class	StaleSessionException StaleSessionException indicates that the requested operation cannot be fulfilled because the underlying session was stale.
class	SubscriptionsOutOfSynchException Deprecated. This class is no longer supported and will be removed in a future release.
class	VersionNotSupportException Exception thrown when the appliance version is not compatible with the JCSMP version.

Methods in com.solacesystems.jcsmp that return JCSMPException

Modifier and Type	Method and Description
JCSMPException	CacheEventMessage.getCacheRequestException() Returns the exception that occurred when a cache request failed.
JCSMPException	StaleSessionException.getCause()

Methods in com.solacesystems.jcsmp with parameters of type JCSMPException

Modifier and Type	Method and Description
default void	JCSMPStreamingPublishCorrelatingEventHandler.handleError(String messageID, JCSMPException cause, long timestamp)
void	JCSMPStreamingPublishEventHandler.handleError(String messageID, JCSMPException cause, long timestamp) Deprecated. Use JCSMPStreamingPublishCorrelatingEventHandler instead. This method is invoked during streaming publishing if there is an error in reading the response, or if a non-OK response is read. Note: Handler processing should be kept to a minimum because it blocks the thread from which the error originated. Error responses from the appliance If an error response is available, it is represented as a JCSMPErrorResponseException. The subcodes discussed in JCSMPStreamingPublishCorrelatingEventHandler might be present to provide further information about why the message was rejected.
void	JCSMPStreamingPublishCorrelatingEventHandler.handleErrorEx(Object key, JCSMPException cause, long timestamp) This method is invoked during streaming publishing if there is an error in reading the response, or if a non-OK response is read.
void	XMLMessageListener.onException(JCSMPException exception) On error, this method is invoked.
void	CacheRequestListener.onException(Long requestId, Topic topic, JCSMPException exception) Called when an asynchronous cache request ends with an error.

Methods in com.solacesystems.jcsmp that throw JCSMPException

Modifier and Type	Method and Description
void	Session.addSubscriber() Deprecated. It is no longer necessary to call this function. This function might be removed in a future version of JCSMP.
void	JCSMPSession.addSubscription(Endpoint endpoint, Subscription subscription, int subscribeFlags) Adds a subscription to an Endpoint on the appliance.
void	JCSMPSession.addSubscription(Endpoint endpoint, Subscription subscription, JCSMPResponseListener handler, Object key) Adds a subscription asynchronously to an Endpoint on the appliance.
void	JCSMPSession.addSubscription(Subscription subscription) Adds a subscription to the appliance.
void	JCSMPSession.addSubscription(Subscription subscription, boolean waitForConfirm) Adds a subscription to an appliance.
void	JCSMPSession.addSubscription(Subscription subscription, JCSMPResponseListener handler, Object key) Adds a subscription asynchronously to the appliance.
void	JCSMPSession.applySubscriptions(Set<Subscription> subscriptions) Deprecated. Content-routing mode (non-client mode) no longer supported. Uses the subscription refresh feature to override the subscriptions and subscription filters associated with a subscriber on the appliance with a given list of subscriptions. The application can call this method at any time to initiate a subscription refresh. Only valid if the Session is operating in non-client mode.
void	Session.clearSubscriber() Deprecated. This method is no longer supported. The recommended way to delete subscriptions from the appliance is to perform an applySubscriptions() on the session with an empty subscription list.
void	JCSMPSession.connect() Connect to the appliance.
Browser	JCSMPSession.createBrowser(BrowserProperties properties) Creates a Browser, which can be used for browsing the contents of a Queue.
Browser	JCSMPSession.createBrowser(BrowserProperties properties, FlowEventHandler flowEventHandler) Creates a Browser, which can be used for browsing the contents of a Queue.
BytesMessage	Producer.createBytesMessage() Applications use this method to create a BytesMessage.
BytesXMLMessage	Producer.createBytesXMLMessage() Applications use this method to create a BytesXMLMessage.
BytesXMLMessage	Producer.createBytesXMLMessage(byte[] value) Applications use this method to create a BytesXMLMessage.
CacheSession	JCSMPSession.createCacheSession(CacheSessionProperties properties) Creates a CacheSession using the provided CacheSession properties.
FlowReceiver	JCSMPSession.createFlow(Endpoint endpoint, Subscription newSubscription, XMLMessageListener listener) Get an instance of FlowReceiver bound to a appliance Endpoint, such as a Queue or TopicEndpoint.
FlowReceiver	JCSMPSession.createFlow(XMLMessageListener listener, ConsumerFlowProperties flowProps) Get an instance of FlowReceiver bound to an appliance Endpoint, such as a Queue or TopicEndpoint.
FlowReceiver	JCSMPSession.createFlow(XMLMessageListener listener, ConsumerFlowProperties flowProps, EndpointProperties endpointProps) Get an instance of FlowReceiver bound to an appliance Endpoint, such as a Queue or TopicEndpoint.
FlowReceiver	JCSMPSession.createFlow(XMLMessageListener listener, ConsumerFlowProperties flowProps, EndpointProperties endpointProps, FlowEventHandler flowEventHandler) Get an instance of FlowReceiver bound to an appliance Endpoint, such as a Queue or TopicEndpoint.
MapMessage	Producer.createMapMessage() Applications use this method to create a MapMessage.
TopicEndpoint	JCSMPSession.createNonDurableTopicEndpoint() Creates a non-durable Topic Endpoint.
TopicEndpoint	JCSMPSession.createNonDurableTopicEndpoint(String name) Creates a non-durable Topic Endpoint based on the given name.
Requestor	JCSMPSession.createRequestor() Creates a new Requestor for this Session.
StreamMessage	Producer.createStreamMessage() Applications use this method to create a StreamMessage.
StreamXMLMessage	Producer.createStreamXMLMessage() Deprecated.
StreamXMLMessage	Producer.createStreamXMLMessage(InputStream stream) Deprecated.
Queue	JCSMPSession.createTemporaryQueue() Creates a temporary Queue for this Session.
Queue	JCSMPSession.createTemporaryQueue(String name) Creates a temporary Queue with the given name.
Topic	JCSMPSession.createTemporaryTopic() Creates a temporary Topic for this Session.
TextMessage	Producer.createTextMessage() Applications use this method to create a TextMessage.
TextXMLMessage	Producer.createTextXMLMessage() Deprecated.
TextXMLMessage	Producer.createTextXMLMessage(String text) Deprecated.
TransactedSession	JCSMPSession.createTransactedSession() Creates a new TransactedSession with the connected appliance.
XMLContentMessage	Producer.createXMLContentMessage() Applications use this method to create a XMLContentMessage.
void	JCSMPSession.deprovision(Endpoint endpoint, long deprovisionFlags) Deprovisions an Endpoint on the appliance.
Object	JCSMPSession.getCapability(CapabilityType type) Gets the value of a capability for the currently connected Session.
XMLMessageConsumer	JCSMPSession.getMessageConsumer() Deprecated. Please see JCSMPSession.getMessageConsumer(XMLMessageListener).
XMLMessageConsumer	JCSMPSession.getMessageConsumer(JCSMPReconnectEventHandler reconnectHandler) Deprecated. Please see JCSMPSession.getMessageConsumer(JCSMPReconnectEventHandler, XMLMessageListener).
XMLMessageConsumer	JCSMPSession.getMessageConsumer(JCSMPReconnectEventHandler reconnectHandler, XMLMessageListener listener) Get a default XMLMessageConsumer with a reconnect event handler.
XMLMessageConsumer	JCSMPSession.getMessageConsumer(SubscriptionStateProvider subscriptionStateProvider) Deprecated. Please see JCSMPSession.getMessageConsumer(SubscriptionStateProvider, XMLMessageListener).
XMLMessageConsumer	JCSMPSession.getMessageConsumer(SubscriptionStateProvider subscriptionStateProvider, JCSMPReconnectEventHandler reconnectHandler) Deprecated. Please see JCSMPSession.getMessageConsumer(SubscriptionStateProvider, JCSMPReconnectEventHandler, XMLMessageListener).
XMLMessageConsumer	JCSMPSession.getMessageConsumer(SubscriptionStateProvider subscriptionStateProvider, JCSMPReconnectEventHandler reconnectHandler, XMLMessageListener listener) Deprecated. Subscriptions out-of-sync checking is no longer supported. This method will be removed in a future version.
XMLMessageConsumer	JCSMPSession.getMessageConsumer(SubscriptionStateProvider subscriptionStateProvider, XMLMessageListener listener) Deprecated. Subscriptions out-of-sync checking is no longer supported. This method will be removed in a future version.
XMLMessageConsumer	JCSMPSession.getMessageConsumer(XMLMessageListener listener) Get a default XMLMessageConsumer.
XMLMessageProducer	JCSMPSession.getMessageProducer() Deprecated. Please see JCSMPSession.getMessageProducer(JCSMPStreamingPublishEventHandler). Note that using this deprecated method can introduce a performance penalty during a streaming publishing Session because it forces the appliance to transmit acknowledgements to every message. Using the recommended JCSMPSession.getMessageProducer(JCSMPStreamingPublishEventHandler) form eliminates this problem.
XMLMessageProducer	JCSMPSession.getMessageProducer(JCSMPStreamingPublishEventHandler callback) Get an instance of XMLMessageProducer.
XMLMessageProducer	JCSMPSession.getMessageProducer(JCSMPStreamingPublishEventHandler streamCallback, JCSMPProducerEventHandler eventCallback) Get an instance of XMLMessageProducer.
BytesXMLMessage	Browser.getNext() Retrieve the next message from the Browser's local message buffer, if one is available, waiting if necessary up to the timeout configured in BrowserProperties.
BytesXMLMessage	Browser.getNext(int timeoutInMillis) Retrieve the next message from the Browser's local message buffer, if one is available, waiting if necessary up to timeoutInMillis ms.
BytesXMLMessage	Browser.getNextNoWait() If there is at least one message available in the Browser's local message buffer, return it immediately; otherwise, return null.
JCSMPStreamingPublishEventHandler	Producer.getStreamingCallbackHandler() Deprecated.
boolean	Browser.hasMore() Returns true if there is at least one message available in the Browser's local message buffer.
void	JCSMPReconnectEventHandler.postReconnect() Called after each reconnection.
boolean	JCSMPReconnectEventHandler.preReconnect() Called before each reconnection attempt.
void	JCSMPSession.provision(Endpoint endpoint, EndpointProperties props, long provisionFlags) Provisions an Endpoint on the appliance.
BytesXMLMessage	Consumer.receive() Receives the next available message, waiting until one is available.
BytesXMLMessage	Consumer.receive(int timeoutInMillis) Receives the next available message.
BytesXMLMessage	Consumer.receiveNoWait() Receives the next available message.
void	Browser.remove(BytesXMLMessage message) Remove a message from the appliance's Queue Endpoint.
void	Session.removeSubscriber() Deprecated. Subscribers are now created and removed only through the appliance's management interface. This method has the same effect as Session.clearSubscriber()
void	JCSMPSession.removeSubscription(Endpoint endpoint, Subscription subscription, int unsubscribeFlags) Removes a subscription from an Endpoint on the appliance.
void	JCSMPSession.removeSubscription(Endpoint endpoint, Subscription subscription, JCSMPResponseListener handler, Object key) Removes a subscription asynchronously from an Endpoint on the appliance.
void	JCSMPSession.removeSubscription(Subscription subscription) Removes a subscription from the appliance.
void	JCSMPSession.removeSubscription(Subscription subscription, boolean waitForConfirm) Removes a subscription from the appliance.
void	JCSMPSession.removeSubscription(Subscription subscription, JCSMPResponseListener handler, Object key) Removes a subscription asynchronously from the appliance.
BytesXMLMessage	Requestor.request(XMLMessage request, long timeoutMillis, Destination sendDestination) Performs a request to the specified destination.
void	XMLMessageProducer.send(XMLMessage message) Deprecated.
void	XMLMessageProducer.send(XMLMessage message, Destination destination) Sends a message to a destination, such as a Queue or Topic.
CacheRequestResult	CacheSession.sendCacheRequest(Long requestId, Topic topic, boolean subscribe, CacheLiveDataAction liveDataAction) Send a synchronous cache request message.
void	CacheSession.sendCacheRequest(Long requestId, Topic topic, boolean subscribe, CacheLiveDataAction liveDataAction, CacheRequestListener listener) Send an asynchronous cache request message.
int	XMLMessageProducer.sendMultiple(JCSMPSendMultipleEntry[] entries, int offset, int length, int sendFlags) Sends a batch of messages.
void	XMLMessageProducer.sendReply(XMLMessage requestMessage, XMLMessage replyMessage) Convenience function for sending a reply message.
void	JCSMPSession.setProperty(String property, Object value) Sets a modifiable Session property once the Session has been constructed.
void	XMLMessageProducer.setStreamingCallbackHandler(JCSMPStreamingPublishEventHandler callback) Deprecated. As of release 4.1, please provide an JCSMPStreamingPublishEventHandler when acquiring an XMLMessageProducer from a session. This method is deprecated and has no effect.
void	XMLMessage.settle(XMLMessage.Outcome outcome) Settles a message in a requested way.
void	Consumer.start() Enables receiving messages from an appliance.
void	JCSMPSession.unsubscribeDurableTopicEndpoint(DurableTopicEndpoint endpoint) Unsubscribe from the durable Topic Endpoint.

Constructors in com.solacesystems.jcsmp with parameters of type JCSMPException

Constructor and Description
StaleSessionException(String message, JCSMPException cause)

Uses of JCSMPException in com.solacesystems.jcsmp.serialization

Method parameters in com.solacesystems.jcsmp.serialization with type arguments of type JCSMPException

Modifier and Type	Method and Description
static <T> XMLMessageListener	Consumed.with(com.solace.serdes.Deserializer<T> deserializer, BiConsumer<BytesXMLMessage,T> onData, BiConsumer<BytesXMLMessage,RuntimeException> onDeserializationException, Consumer<JCSMPException> onListenerException) Creates an XMLMessageListener used by XMLMessageConsumer with lamda functions for message payload deserialize.

Uses of JCSMPException in com.solacesystems.jcsmp.transaction

Subclasses of JCSMPException in com.solacesystems.jcsmp.transaction

Modifier and Type	Class and Description
class	RollbackException An exception thrown when a transaction rolls back unexpectedly.
class	TransactionResultUnknownException An exception thrown when a transaction commit result is unknown.

Methods in com.solacesystems.jcsmp.transaction that throw JCSMPException

Modifier and Type	Method and Description
void	TransactedSession.commit() Commit the active transaction.
FlowReceiver	TransactedSession.createFlow(XMLMessageListener listener, ConsumerFlowProperties flowProps, EndpointProperties endpointProps) Creates a consumer flow within this TransactedSession and associates it to this session.
FlowReceiver	TransactedSession.createFlow(XMLMessageListener listener, ConsumerFlowProperties flowProps, EndpointProperties endpointProps, FlowEventHandler flowEventHandler) Creates a consumer flow within this TransactedSession and associates it to this session.
XMLMessageProducer	TransactedSession.createProducer(ProducerFlowProperties fprop, JCSMPStreamingPublishEventHandler callback) Creates a producer flow within this TransactedSession and associates it to this session.
XMLMessageProducer	TransactedSession.createProducer(ProducerFlowProperties fprop, JCSMPStreamingPublishEventHandler streamCallback, JCSMPProducerEventHandler eventCallback) Creates a producer flow within this TransactedSession and associates it to this session.
void	TransactedSession.rollback() Rollback the active transaction.