Installation

To install the Solace Messaging API for JMS, unzip the sol-jms-<version_number>.zip file on any supported platform. (For information on supported platforms, refer to JMS Messaging API Release Notes.) The resulting sdk‑jms directory contains the following directories:

• docs—Contains the JMS Javadoc API documentation in an HTML format.
• lib—Contains the Solace JMS API library files.

  The sol-jms jar library file includes metadata conforming to the OSGi standards and can be deployed as an OSGi bundle. For more information, see OSGI Support.

• licenses—Contains the Apache license version 2.0 agreement.
• samples—Contains all the files required to run the JMS sample applications. For detailed information on how to build and run the sample JMS applications, refer to the readme.txt file included in the sdk‑jms\samples directory.

Copy the library files in the lib folder to the relevant directory for your application. If you are creating a new application, ensure that the CLASSPATH variable is set to include the location of the new libraries. No additional registry or other global system changes are required.

The Solace JMS API requires the use of standard Java distribution 1.8 or greater.

Required Packages

Note that the following Java packages are required to use the Solace JMS API implementation.

Required Packages for the Solace JMS API

Packages	Description
javax.jms	The Oracle Solace JMS API package. This package is always used by JMS applications; it is provided with the Solace JMS API distribution. If you use the Solace Messaging API for Jakarta Messaging the required package is jakarta.jms instead of javax.jms. The jakarta.jms package is always used by Jakarta JMS applications; it is provided with the Solace Messaging API for Jakarta Messaging distribution.
javax.naming	This package includes all JNDI packages required for ConnectionFactory and Destination lookups.
Java distribution	The Solace JMS API requires the use of standard Java distribution 1.8 or greater.