Using the API in JEE Environments

To use the Solace Jakarta Messaging API or Solace JMS API in an application server environment, you can deploy a Solace‑provided JCA‑compliant resource adapter. Solace provides separate resource adapters for Jakarta EE application servers (WildFly 27+, JBoss EAP 8+) and legacy Java EE application servers (WebSphere Traditional, WebLogic, JBoss EAP 7).

The Solace JCA resource adapters are provided as standalone resource adapter archive (RAR) files that also include the required messaging API libraries.

Solace provides two variants of the JCA Resource Adapter to support both legacy Java EE and modern Jakarta EE application servers. This page describes the Solace JCA Resource Adapter for JMS for legacy environments. For information about the Solace JCA Resource Adapter for Jakarta Messaging for modern Jakarta EE servers, see Solace JCA Resource Adapter for Jakarta Messaging Overview.

Resource Adapter Variants

Solace offers two resource adapter variants to support the full range of Java enterprise application servers:

  • Solace JCA Resource Adapter for Jakarta Messaging (sol-jms-jakarta-ra-<version>.rar)—For modern Jakarta EE application servers that use the jakarta.* namespace, including WildFly 27+ and JBoss EAP 8+. See Solace JCA Resource Adapter for Jakarta Messaging Overview.
  • Solace JCA Resource Adapter for JMS (sol-jms-ra-<version>.rar)—For legacy Java EE application servers that use the javax.* namespace, including WebSphere Traditional, WebLogic, and JBoss EAP 7. For information on how to integrate the Solace JMS implementation with particular Application Servers, contact Solace.

Choose the appropriate resource adapter based on your application server's Java/Jakarta EE support. The Solace JCA Resource Adapter for JMS and the Solace JCA Resource Adapter for Jakarta Messaging provide equivalent functionality but are binary-incompatible due to the namespace differences.

Integrating Without the Resource Adapter

To integrate Solace Messaging APIs into a JEE environment without using a JCA Resource Adapter, use only the following library files to avoid potential conflicts with existing Java library files:

For Solace Jakarta Messaging API

Recommended for new development.

  • commons-logging-1.1.x.jar
  • sol-jms-jakarta-10.x.x.jar
  • These library files are present in the lib directory of the extracted sol-jms-jakarta-<version>.zip package. Copy these library files to the relevant directory for your application. Then add them to your CLASSPATH to use Solace as a messaging provider within a Jakarta EE container.

For Solace JMS API

For existing applications.

  • commons-logging-1.1.x.jar
  • sol-jms-10.x.x.jar
  • These library files are present in the lib directory of the extracted sol-jms-<version>.zip package. Copy these library files to the relevant directory for your application. Then add them to your CLASSPATH to use Solace as a JMS provider within a Java EE container.