Release Notes: Solace PubSub+ Messaging API for JMS and Jakarta Messaging, Version 10.23.0
Release History for Solace PubSub+ Messaging API for JMS and Jakarta Messaging, Version 10.23.0
March 2024

New Features Introduced in Release 10.23.0 and Earlier Releases

This section lists the new features introduced in the Solace PubSub+ Messaging API for JMS and Jakarta Messaging between releases 10.23.0 and 10.10.0.
NameDescriptionIntroduced in Version
Support for HTTP And SOCKS5 Proxy
The API now supports connecting to a Solace broker via an HTTP or SOCKS5 proxy.
JMS, JCSMP API - Update API License Agreement
We have simplified the API license text and clarified that distributing work containing the Solace APIs is allowed.
Support jakarta.jms Namespace with new Solace Jakarta Messaging API
The Solace JMS API now supports the jakarta.jms namespace within the new Jakarta Messaging product.
JCSMP API - Support for Partitioned Queues
This enhancement adds support for Partitioned Queues to the API. Partitioned Queues expand PubSub+ to provide deterministic, ordered, and non-exclusive message delivery for customers to scale the number of consumers when publishing ordered datasets. The ordered datasets are keyed to ensure all events in the dataset are sent to the same consumer without mis-ordering events.
JMS, JCSMP - Delayed Redelivery With Head-Of-Line Blocking
To give applications time to recover from a temporary inability to process a message, this feature allows for the delayed redelivery of messages to clients that are consuming guaranteed messages using local transactions. Delayed redelivery is controlled by a timer and triggered by a client-initated transaction rollback. While the redelivery timer is running, the consumer flow is blocked if it participated in a rolled back transaction and message delivery to the application is suspended until the timer expires. A multiplier is used to allow for exponential back-off of redelivery attempts.
The entire delayed redelivery configuration is performed on the PubSub+ Event Broker.
Delayed redelivery is a Controlled Availability (CA) feature, and requires PubSub+ Event Broker version 10.3.0 or later. Please contact Solace to find out if this feature is supported for your use case.
JMS - Distributed Tracing - Context Propagation
Enables adding and extracting tracing metadata attached to events published and received by the Solace JMS API.
API Server Certificate Validation Using Subject Alternate Name
This feature compares the DNS name that the API is trying to connect to to the DNS name stored in the subject alternate name of the server certificate, following current security best practices for TLS connections.
Create Pre-Send and Post-Receive Hooks to Allow for Payload Encryption/Decryption
This API now provides hooks that allow the application to encrypt a payload right before the SEND and decrypt right after the RECEIVE. The hooks are configurable and allow for variation in the actual code that does the encrypt/decrypt. It is up to the application developers to write the code to encrypt/decrypt and be cognizant of performance.
Prevent Republishing of Guaranteed Messages that Exceed the Maximum Message Size
This feature prevents applications from sending guaranteed messages that exceed the maximum message size configured in the PubSub+ Event Broker in order to prevent erroneous states in the API.
Remove Use of Out of Date Apache Commons Libraries
Removed usage of and dependencies on various Apache Commons libraries including commons-lang and commons-collections.
OAuth/OIDC Support in Messaging API for JCSMP/JMS
OAuth / OpenID Connect has been added as a method of authenticating and authorizing clients connecting to the PubSub+ Event Broker using the SMF protocol. Clients using Solace APIs will be able to present a token as a credential during client login. This enables clients to integrate with modern identity and access management systems.
Publish the JCA Resource Adapter to Maven Repository
The JCA Resource Adapter can now be downloaded from the Maven repository.
Increase the Maximum Number Of Messages in a Transaction
This feature increases the transaction scaling limits to allow up to 20,000 messages (consume plus publish) in a single transaction. The previous limit was 256 messages. To use this feature, you must upgrade your PubSub+ Event Brokers to Release 9.8.1 or later.
This feature is a Controlled Availability feature. Please contact Solace to find out if this feature is supported for your use case. Solace will work with you to verify that the feature is suitable for production use in your environment.
JCSMP/JMS Support for SNI
The JCSMP API and its derivatives (JMS) will now populate the SNI field when negotiating a TLS connection.
End of Life Support for Java 6 and Java 7
Solace is deprecating support for Java versions 1.6 and 1.7 with the intention that future releases of the Java API (JCSMP) will NOT be supported on Java versions prior to 1.8. Java versions prior to 1.8 are not supported by Oracle or OpenJDK, making it impossible for Solace to maintain support for older versions of the language.
Release 10.10 will be the last Solace Java API version that supports versions prior to Java 1.8.

Issues Resolved in Release 10.23.0 and Earlier Releases

This section lists the history of resolved issues in the Solace PubSub+ Messaging API for JMS and Jakarta Messaging between releases 10.23.0 and 10.10.0.
Reference NumberDescriptionResolved in Version
Cross-signed X.509 certificates (signed by multiple root authorities) may not be accepted by the API unless all signing Certificate-Authority (CA) certificates are in the trust store. For example, Let's Encrypt issues certificates signed by both itself and a now expired root CA.
Have all root CAs in the trustStore.
An application thread using transactions may block forever in a commit() call if the application interrupts another thread that is calling commit() and the API is configured to reconnect.
If creating and immediately closing consumers or browsers, the JCSMP, JMS, and Jakarta Messaging APIs may fail to unbind the associated flow from the queue or topic endpoint on the broker. The flow will remain bound to the queue or topic endpoint on the broker until the application either closes the connection on which the consumer or browser was created or the application is restarted.
When an exception is raised while publishing a message, the message can later be automatically resent by the API.
JCSMP and JMS APIs fall into a reconnect loop when receiving corrupted but skippable messages.
In rare cases, the messaging API may deadlock while automatically re-transmitting guaranteed messages due to a timeout waiting for an acknowledgement from the broker. Note this is a different deadlock compared to what was reported and fixed in SOL-59955.
If the application disconnects and reconnects while in the process of creating a new producer it may get a "400: Too Many Publishers" exception. This error is expected to occur very rarely.
If an application thread is interrupted while waiting for a response from the broker to a request to create a consumer for a queue or durable topic subscription, and the API is in the process of reconnecting, the application thread and an API thread may deadlock. This issue can only occur if using JMS 10.11.0 or later with broker 9.8.1 or later.
The API's keepalive mechanism has been improved to avoid false positive keepalive failures while receiving large messages over slow networks.
Interrupting an application thread while it is calling commit() or rollback() for a transacted session may cause the transacted session object to be unusable, and subsequent calls to the object's commit() or rollback() methods will throw an exception. This issue can only occur if using at least version 10.11 of either the JCSMP or JMS API with a broker running at least version 9.8.1 of SolOS. Earlier versions of either the API or broker are not exposed to this issue.
Starting in JMS and JMCSP 10.13.0, client applications that directly or indirectly use apache-commons-lang v2 library classes ArrayUtils or SystemUtils could trigger a NoSuchMethodError at runtime.
This issue only exists in version 10.13.0. Users of that version can avoid the issue either by upgrading to version 10.13.1 or by applying one of the following workarounds. Implementing either one will avoid this problem. (1) Upgrade client applications to use apache-commons-lang v3 (apache-commons-lang v3 superseded v2 in 2011). (2) Ensure that the classpath variable includes apache-commons-lang before including Solace libraries.
XA transactions may be rolled back if a consumer used to receive messages as part of the transaction is closed before committing the transaction.
The messaging API may deadlock while automatically re-transmitting guaranteed messages due to a timeout waiting for an acknowledgement from the broker.
The Java/JMS API can deadlock when the internal reactor thread is blocked on trying to send a message.
As an example, this can occur when the TCP socket's send buffer is full and the application attempts to unbind from an endpoint.
Javax.jms.TemporaryQueue.delete() needs to be optimized to improve performance when called repeatedly over many threads.
Messages received by the API should be read-only but this is not the case for messages received over a shared subscription.
Zero length BytesMessages that are received from REST publishers are mistakenly being converted into generic JMS messages(javax.jms.Message).
If the API receives a corrupted message such that the decoded length of the binary metadata portion greatly exceeds the length of the byte buffer, the API may not reconnect to the broker as it is supposed to.
If the API is in the process of retransmitting guaranteed messages and is also reconnecting to the broker but fails to reconnect within the configured number of retry attempts, the thread used to retransmit the guaranteed messages is not shut down as expected. The only impact is that the thread will use a small amount of CPU resources until the application exits or shuts down the context used to create the original connection.
TransactedSession.createProducer(ProducerFlowProperties fprop, ...) fails to respect the window size specified in the ProducerFlowProperties. Instead, the value for previous versions was always set to 255.
Solace recommends against using either JCSMP 10.11.0 or JMS 10.11.0 with SolOS due to broker issue SOL-47779: AdCtrl v4 publishers can stall due to lost acks, which exists only in SolOS There is no issue using these versions of the APIs with earlier or later versions than of SolOS.
The JCSMP and JMS APIs may always return a delivery count of 1 for messages consumed or browsed from a queue or topic endpoint with the delivery count feature enabled. This issue only occurs with versions 10.10.0 and 10.10.1 of the JCSMP and JMS APIs and only with broker versions or later. If using a 9.8 version of the broker the issue can only occur if the message is consumed as part of an XA transaction. If using a 9.9 or later version of the broker the issue can occur regardless of how the message is consumed or browsed.
When the API is integrated with Camel and Spring, if a disconnection occurs and the API fails to reconnect to the broker within the configured number of reconnect attempts, a deadlock between the API and Spring, Camel, or the application threads may occur. This will prevent the application from being shut down without restarting the JVM.
JMSXDeliveryCount never returns a value greater than 2.
JMS API threads may deadlock when the following combination of events occur:
- The client disconnected and attempted to reconnect but reached the configured maximum number of reconnect attempts.
- The application is notified that the Connection is down with an exception and tries to close the Connection in its onException() callback.
- There is at least one MessageConsumer for the Connection that is in the process of starting or stopping.
A JMS application may block indefinitely in the call to createConsumer() if the API was in the process of reconnecting and the call to create the consumer is made concurrent with the API stopping trying to reconnect after reaching the configured number of reconnect attempts.

Changed Functionality in Release 10.23.0 and Earlier Releases

This section lists the history of changed functionality in the Solace PubSub+ Messaging API for JMS and Jakarta Messaging between releases 10.23.0 and 10.10.0.
Reference NumberDescriptionIntroduced in Version
A latest version of JDK 8 is required to avoid a 'NullPointerException' issue during SSL handshake caused by HostnameChecker (see [[JDK-8211339] NPE during SSL handshake caused by HostnameChecker - Java Bug System (|] for details).
Apache commons logging has been upgraded from 1.1.3 to 1.2.
The class names responsible for raising transaction-related log entries may change after upgrading the Solace Broker and API.
The format of reply-to topics has changed. The reply-to topic used by the API's request/reply helper methods used to be of the form:
The trailing # has been replaced with an underscore _ such that the topic is now of the form:
In JCSMP, the suffix of a reply-to topic set with the setReplyToSuffix() method is also now prefixed with the underscore("_") character.

Vulnerabilities Addressed in Release 10.23.0 and Earlier Releases

The following vulnerabilities have been resolved in the Solace PubSub+ Messaging API for JMS and Jakarta Messaging between releases 10.23.0 and 10.10.0.


Known Issues in Release 10.23.0 and Earlier Releases

This section describes known issues in the Solace PubSub+ Messaging API for JMS and Jakarta Messaging between releases 10.23.0 and 10.10.0.
Reference NumberDescription
The JCSMP, JMS, Jakarta Messaging, and Java API may lock up if an application thread continuously interrupts JCSMPXMLMessageProducer.send() and triggers a session reconnect.
A temporary queue is not provisioned until the consumer is created.
In applications, create the consumer immediately after the queue
For example:
Queue queue = session.createTemporaryQueue();
// temporary queue not yet provisioned
MessageConsumer consumer = session.createConsumer(queue);
// temporary queue only provisioned now
For more details, refer to the Release Notes page for the Solace JMS Open API.

Supported Environments