Deprecated List (Solace Messaging API for Java v10.25.1)

Deprecated Interfaces
Interface and Description
com.solacesystems.jcsmp.JCSMPStreamingPublishEventHandler Use `JCSMPStreamingPublishCorrelatingEventHandler` instead. MessageIDs used to identify published messages by the interface can changed between publish and acknowledgement in the event of a DR failover. Therefore, it is recommended that applications use its extension `JCSMPStreamingPublishCorrelatingEventHandler` instead. By providing an implementation of `JCSMPStreamingPublishEventHandler` to `Producer`, an application can send messages without waiting for responses (streaming publishing mode). The response (when applicable) of the send operation is delivered asynchronously through this callback handler, however in the event of a DR failover the messageID may have changed and so cannot be used.
com.solacesystems.jcsmp.StreamXMLMessage Use of message types other than `BytesXMLMessage` is deprecated.
com.solacesystems.jcsmp.SubscriptionStateProvider SubscriptionStateProvider is no longer supported and its use has no effect.
com.solacesystems.jcsmp.TextXMLMessage Use of message types other than `BytesXMLMessage` is deprecated.

Deprecated Classes
Class and Description
com.solacesystems.jcsmp.MessageType Replaced by `DeliveryMode`.
com.solacesystems.jcsmp.SubscriptionState SubscriptionState is no longer supported and its use has no effect.

Deprecated Enums
Enum and Description

com.solacesystems.jcsmp.JCSMPErrorResponseSubcode
Replaced by JCSMPErrorResponseSubcodeEx

Deprecated Enums
Enum and Description
com.solacesystems.jcsmp.JCSMPErrorResponseSubcode Replaced by `JCSMPErrorResponseSubcodeEx`

Deprecated Exceptions
Exceptions and Description
com.solacesystems.jcsmp.SubscriptionsOutOfSynchException This class is no longer supported and will be removed in a future release.

Deprecated Fields
Field and Description
com.solacesystems.jcsmp.JCSMPProperties.CLIENT_MODE
com.solacesystems.jcsmp.JCSMPProperties.CONTROL_CHANNEL_PROPERTIES These channel properties are deprecated in favor of `JCSMPProperties.CLIENT_CHANNEL_PROPERTIES`. If the default settings for CLIENT_CHANNEL_PROPERTIES are modified in any way, they override these legacy channel properties.
com.solacesystems.jcsmp.JCSMPProperties.MAX_RESENDS
com.solacesystems.jcsmp.JCSMPProperties.PUBLISHER_DATA_CHANNEL_PROPERTIES These channel properties are deprecated in favor of `JCSMPProperties.CLIENT_CHANNEL_PROPERTIES`. If the default settings for CLIENT_CHANNEL_PROPERTIES are modified in any way, they override these legacy channel properties.
com.solacesystems.jcsmp.JCSMPProperties.SECURE_PROPS
com.solacesystems.jcsmp.JCSMPProperties.SESSION_NAME
com.solacesystems.jcsmp.JCSMPProperties.SSL_PROTOCOL
com.solacesystems.jcsmp.JCSMPProperties.SUBSCRIBER_DATA_CHANNEL_PROPERTIES These channel properties are deprecated in favor of `JCSMPProperties.CLIENT_CHANNEL_PROPERTIES`. If the default settings for CLIENT_CHANNEL_PROPERTIES are modified in any way, they override these legacy channel properties.
com.solacesystems.jcsmp.JCSMPProperties.SUBSCRIBER_LOCAL_PRIORITY
com.solacesystems.jcsmp.JCSMPProperties.SUBSCRIBER_NETWORK_PRIORITY

Deprecated Methods
Method and Description
com.solacesystems.jcsmp.Session.addSubscriber() It is no longer necessary to call this function. This function might be removed in a future version of JCSMP.
com.solacesystems.jcsmp.Session.clearSubscriber() 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.
com.solacesystems.jcsmp.JCSMPFactory.createQueue(String, String) Use `JCSMPFactory.createQueue(String)`.
com.solacesystems.jcsmp.Producer.createStreamXMLMessage()
com.solacesystems.jcsmp.Producer.createStreamXMLMessage(InputStream)
com.solacesystems.jcsmp.Producer.createTextXMLMessage()
com.solacesystems.jcsmp.Producer.createTextXMLMessage(String)
com.solacesystems.jcsmp.XMLMessage.getAppMessageID() Renamed to `XMLMessage.getApplicationMessageId()`.
com.solacesystems.jcsmp.XMLMessage.getAppMessageType() Renamed to `XMLMessage.getApplicationMessageType()`.
com.solacesystems.jcsmp.XMLMessage.getDeliverToOne()
com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx.getDescription(int) This method is no longer supported, and its use is discouraged. Refer to API documentation for explanations of these error subcodes.
com.solacesystems.jcsmp.DestinationUtils.getEncodedName(Destination) See `DestinationUtils.getNetworkName(Destination)`.
com.solacesystems.jcsmp.JCSMPSession.getMessageConsumer() Please see `JCSMPSession.getMessageConsumer(XMLMessageListener)`.
com.solacesystems.jcsmp.JCSMPSession.getMessageConsumer(JCSMPReconnectEventHandler) Please see `JCSMPSession.getMessageConsumer(JCSMPReconnectEventHandler, XMLMessageListener)`.
com.solacesystems.jcsmp.JCSMPSession.getMessageConsumer(SubscriptionStateProvider) Please see `JCSMPSession.getMessageConsumer(SubscriptionStateProvider, XMLMessageListener)`.
com.solacesystems.jcsmp.JCSMPSession.getMessageConsumer(SubscriptionStateProvider, JCSMPReconnectEventHandler) Please see `JCSMPSession.getMessageConsumer(SubscriptionStateProvider, JCSMPReconnectEventHandler, XMLMessageListener)`.
com.solacesystems.jcsmp.JCSMPSession.getMessageConsumer(SubscriptionStateProvider, JCSMPReconnectEventHandler, XMLMessageListener) Subscriptions out-of-sync checking is no longer supported. This method will be removed in a future version.
com.solacesystems.jcsmp.JCSMPSession.getMessageConsumer(SubscriptionStateProvider, XMLMessageListener) Subscriptions out-of-sync checking is no longer supported. This method will be removed in a future version.
com.solacesystems.jcsmp.XMLMessage.getMessageId() Use `XMLMessage.ackMessage()` to acknowledge messages. The message ID is only to be used for the purpose of acknowledgements. No other meaning should be inferred from the value of the guaranteed message ID. Returns the message ID set by JCSMP during send or reception. The message ID is the String representation of a 64-bit unsigned integer value identifying the message. On the receiving side, if messages received do not have message ID set by the appliance, JCSMP automatically assigns one and guarantees its uniqueness for a particular `<subscriber; message type>`. Guaranteed messages delivered from the appliance have a appliance-assigned message ID. Messages sent or received over the `Direct` delivery mode are assigned a message ID by the API, but its value is not meaningful.
com.solacesystems.jcsmp.XMLMessage.getMessageIdLong() Use `XMLMessage.ackMessage()` to acknowledge messages. The message ID is only to be used for the purpose of acknowledgements. No other meaning should be inferred from the value of the guaranteed message ID. Returns the message ID set by JCSMP during send or reception. For discussion of message ID assignment, see `XMLMessage.getMessageId()`.
com.solacesystems.jcsmp.JCSMPSession.getMessageProducer() 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.
com.solacesystems.jcsmp.XMLMessage.getMessageType() See `XMLMessage.getDeliveryMode()`. Gets the type of the message. Valid types are enumerated in `MessageType`: `MessageType.NON_PERSISTENT` `MessageType.PERSISTENT` `MessageType.DIRECT` (default)
com.solacesystems.jcsmp.XMLMessage.getSenderID() Renamed to `XMLMessage.getSenderId()`.
com.solacesystems.jcsmp.XMLMessage.getSendTimestamp() Renamed to `XMLMessage.getSenderTimestamp()`.
com.solacesystems.jcsmp.JCSMPChannelProperties.getSmfPort() Use of this setting is discouraged, the recommended way of selecting ports is through the "Host:Port" syntax of the `JCSMPProperties.HOST` property.
com.solacesystems.jcsmp.Producer.getStreamingCallbackHandler()
com.solacesystems.jcsmp.JCSMPErrorResponseException.getSubcode() use `JCSMPErrorResponseException.getSubcodeEx()`.
com.solacesystems.jcsmp.JCSMPRuntime.getSupportedMaxNumOfXpesInOneRequest()
com.solacesystems.jcsmp.JCSMPStreamingPublishEventHandler.handleError(String, JCSMPException, long) 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.
com.solacesystems.jcsmp.Topic.isRxAllDeliverToOne()
com.solacesystems.jcsmp.TopicProperties.isRxAllDeliverToOne()
com.solacesystems.jcsmp.JCSMPChannelProperties.isSecureChannel()
com.solacesystems.jcsmp.DestinationUtils.queueFromEncodedName(String) See `DestinationUtils.queueFromNetworkName(String)`.
com.solacesystems.jcsmp.BytesXMLMessage.readBytes(byte[]) As of release 4.5, use `XMLMessage.readContentBytes(int, byte[], int, int)`. This function used a read pointer stored in the message and therefore was not thread-safe when called by consumers of the message.
com.solacesystems.jcsmp.BytesXMLMessage.readBytes(byte[], int) As of release 4.5, use `XMLMessage.readContentBytes(int, byte[], int, int)`. This function used a read pointer stored in the message and therefore was not thread-safe when called by consumers of the message.
com.solacesystems.jcsmp.XMLMessage.rejectMessage() As of version 4.0, rejectMessage has no separate effect from ackMessage. Applications should avoid using this method as it will be removed in a future release.
com.solacesystems.jcsmp.Session.removeSubscriber() Subscribers are now created and removed only through the appliance's management interface. This method has the same effect as `Session.clearSubscriber()`
com.solacesystems.jcsmp.JCSMPStreamingPublishEventHandler.responseReceived(String) Use `JCSMPStreamingPublishCorrelatingEventHandler` instead. This method is invoked whenever an OK response is received. When publishing `PERSISTENT` and `NON_PERSISTENT` messages, the `messageID` is passed as an argument to this callback when an acknowledgement is received. Note: This method is not invoked for `DIRECT` messages because they do not receive acknowledgements.
com.solacesystems.jcsmp.XMLMessage.rewindAttachment() This method no longer has any effect.
com.solacesystems.jcsmp.BytesXMLMessage.rewindContent() As of release 4.5, use `XMLMessage.readContentBytes(int, byte[], int, int)`. This function used a read pointer stored in the message and therefore was not thread-safe when called by consumers of the message.
com.solacesystems.jcsmp.XMLMessageProducer.send(XMLMessage)
com.solacesystems.jcsmp.XMLMessage.setAppMessageID(String) Renamed to `XMLMessage.setApplicationMessageId(String)`.
com.solacesystems.jcsmp.XMLMessage.setAppMessageType(String) Renamed to `XMLMessage.setApplicationMessageType(String)`.
com.solacesystems.jcsmp.XMLMessage.setDeliverToOne(boolean)
com.solacesystems.jcsmp.XMLMessageConsumer.setMessageListener(XMLMessageListener) As of release 4.1, please provide an `XMLMessageListener` when acquiring an `XMLMessageConsumer` from a session. This method is deprecated and provided for backwards-compatibility; if using it, note that it must be called immediately after acquiring the `XMLMessageConsumer`, before it is started, and it may only be called once. Failure to respect these conditions will result in an `IllegalStateException` being thrown.
com.solacesystems.jcsmp.XMLMessage.setMessageType(MessageType) See `XMLMessage.setDeliveryMode(DeliveryMode)`. Sets the type of the message. Valid types are enumerated in `MessageType`: `MessageType.NON_PERSISTENT` `MessageType.PERSISTENT` `MessageType.DIRECT` (default)
com.solacesystems.jcsmp.TopicProperties.setRxAllDeliverToOne(boolean)
com.solacesystems.jcsmp.XMLMessage.setSenderID(String) Renamed to `XMLMessage.setSenderId(String)`.
com.solacesystems.jcsmp.XMLMessage.setSendTimestamp(long) Renamed to `XMLMessage.setSenderTimestamp(long)`.
com.solacesystems.jcsmp.JCSMPChannelProperties.setSmfPort(int) Use of this setting is discouraged, the recommended way of selecting ports is through the "Host:Port" syntax of the `JCSMPProperties.HOST` property.
com.solacesystems.jcsmp.XMLMessageProducer.setStreamingCallbackHandler(JCSMPStreamingPublishEventHandler) As of release 4.1, please provide an `JCSMPStreamingPublishEventHandler` when acquiring an `XMLMessageProducer` from a session. This method is deprecated and has no effect.
com.solacesystems.jcsmp.DestinationUtils.topicFromEncodedName(String) See `DestinationUtils.topicFromNetworkName(String)`.
com.solacesystems.jcsmp.XMLMessage.writeNewAttachment(byte[]) Use `XMLMessage.writeAttachment(byte[])` instead
com.solacesystems.jcsmp.XMLMessage.writeNewAttachment(byte[], int, int) Use `XMLMessage.writeAttachment(byte[],int,int)` instead.
com.solacesystems.jcsmp.XMLMessage.writeNewAttachment(InputStream) Use `XMLMessage.writeAttachment(InputStream)` instead.
com.solacesystems.jcsmp.XMLMessage.writeNewAttachment(InputStream, int, int) Use `XMLMessage.writeAttachment(InputStream)` instead.

Deprecated Constructors
Constructor and Description

com.solacesystems.jcsmp.JCSMPStats(String)

Deprecated Constructors
Constructor and Description
com.solacesystems.jcsmp.JCSMPStats(String)

Deprecated Enum Constants
Enum Constant and Description
com.solacesystems.jcsmp.CapabilityType.FLOW_CHANGE_UPDATES Use `CapabilityType.ACTIVE_FLOW_INDICATION` Peer supports Flow Change Updates.

Deprecated API

Contents

Error responses from the appliance