IBM MQ classes for JMS/Jakarta Messaging relocatable JAR files

The relocatable JAR files can be moved to systems that need to run IBM® MQ classes for JMS or IBM MQ classes for Jakarta Messaging.

Important:
  • Apart from the relocatable JAR files described in Relocatable JAR files, copying the IBM MQ classes for JMS or IBM MQ classes for Jakarta Messaging JAR files or native libraries to other machines, or to a different location on a machine where the IBM MQ classes for JMS or IBM MQ classes for Jakarta Messaging have been installed, is not supported.
  • Do not include the relocatable JAR files within applications deployed into Java EE application servers, such as WebSphere® Application Server or WebSphere Liberty. In these environments, the IBM MQ resource adapter should be deployed and used instead. Note that WebSphere Application Server embeds the IBM MQ resource adapter, so there is no need to deploy it manually into this environment.
  • To avoid classloader conflicts, it is not recommended to bundle the relocatable JAR files within multiple applications inside the same Java runtime. In this scenario, make the IBM MQ relocatable JAR files available on the Java runtime's classpath.
  • If you are bundling the relocatable JAR files within your applications, ensure that you include all prerequisite JAR files as described in Relocatable JAR files. You should also ensure that you have appropriate procedures to update the bundled JAR files as part of application maintenance, to ensure that the IBM MQ classes for JMS or IBM MQ classes for Jakarta Messaging are still current and known issues are re-mediated.

Relocatable JAR files

Within an enterprise, the following files can be moved to systems that need to run IBM MQ classes for JMS or IBM MQ classes for Jakarta Messaging:
  • [MQ 9.3.0 Jun 2022][MQ 9.3.0 Jun 2022]bcpkix-jdk15to18.jar 4
  • [MQ 9.3.5 Feb 2024]bcpkix-jdk18on.jar 3
  • [MQ 9.3.0 Jun 2022][MQ 9.3.0 Jun 2022]bcprov-jdk15to18.jar 4
  • [MQ 9.3.5 Feb 2024]bcprov-jdk18on.jar 3
  • [MQ 9.3.0 Jun 2022][MQ 9.3.0 Jun 2022]bcutil-jdk15to18.jar 4
  • [MQ 9.3.5 Feb 2024]bcutil-jdk18on.jar 3
  • [JMS 2.0]com.ibm.mq.allclient.jar1
  • [MQ 9.3.0 Jun 2022][MQ 9.3.0 Jun 2022][Jakarta Messaging 3.0]com.ibm.mq.jakarta.client.jar 2
  • [Removed][MQ 9.3.3 Jun 2023]com.ibm.mq.traceControl.jar
  • fscontext.jar
  • [MQ 9.3.3 Jun 2023]jackson-annotations.jar
  • [MQ 9.3.3 Jun 2023]jackson-core.jar
  • [MQ 9.3.3 Jun 2023]jackson-databind.jar
  • jakarta.jms-api.jar
  • jms.jar
  • org.json.jar
  • providerutil.jar
Notes:
  1. JMS 2.0 and JMS 1.1
  2. Jakarta Messaging 3.0
  3. Continuous Delivery from IBM MQ 9.3.5
  4. Long Term Support and Continuous Delivery before IBM MQ 9.3.5

JMS JAR files

[MQ 9.3.0 Jun 2022][MQ 9.3.0 Jun 2022]jms.jar contains the JMS 1.1 and JMS 2.0 interfaces - these are named javax.jms.*.

[MQ 9.3.0 Jun 2022][MQ 9.3.0 Jun 2022][Jakarta Messaging 3.0]jakarta.jms-api.jar contains the Jakarta Messaging 3.0 interfaces - these are named jakarta.jms.*.

fscontext.jar and providerutil.jar

The fscontext.jar and providerutil.jar files are required if your application performs JNDI lookups using a file system context.

Bouncy Castle security provider and CMS support JAR files

The Bouncy Castle security provider and CMS support JAR files are required. For more information, see Support for non-IBM JREs with AMS.

[MQ 9.3.5 Feb 2024]For Continuous Delivery from IBM MQ 9.3.5, the following JAR files are required:
  • bcpkix-jdk18on.jar
  • bcprov-jdk18on.jar
  • bcutil-jdk18on.jar
[Long Term Support]For Long Term Support and Continuous Delivery before IBM MQ 9.3.5, the following JAR files are required:
  • bcpkix-jdk15to18.jar
  • bcprov-jdk15to18.jar
  • bcutil-jdk15to18.jar

org.json.jar

The org.json.jar file is required. This is used by the IBM MQ classes for JMS and the IBM MQ classes for Jakarta Messaging when parsing client channel definition tables (CCDTs) that are in a JSON format. It is also used when calling the toString() method on com.ibm.mq.jms.MQConnection and com.ibm.mq.jms.MQSession objects to generate a JSON representation of them.

com.ibm.mq.allclient.jar and com.ibm.mq.jakarta.client.jar

The files com.ibm.mq.allclient.jar and com.ibm.mq.jakarta.client.jar contain the IBM MQ classes for JMS, the IBM MQ classes for Jakarta Messaging, the IBM MQ classes for Java, and the PCF and Headers Classes. If you move these JAR file to a new location, make sure that you take steps to keep this new location maintained with new IBM MQ Fix Packs. Also, make sure that the use of the files is made known to IBM Support if you are getting an interim fix.

To determine the version of the files com.ibm.mq.allclient.jar and com.ibm.mq.jakarta.client.jar, use the following command: [MQ 9.3.0 Jun 2022][MQ 9.3.0 Jun 2022][Jakarta Messaging 3.0]

java -jar com.ibm.mq.jakarta.client.jar
[JMS 2.0]

java -jar com.ibm.mq.allclient.jar
The following example shows some sample output from this command: 
C:\Program Files\IBM\MQ_1\java\lib>java -jar com.ibm.mq.allclient.jar
Name:       Java Message Service Client
Version:    9.3.0.0
Level:      p000-L140428.1
Build Type: Production
Location:   file:/C:/Program Files/IBM/MQ_1/java/lib/com.ibm.mq.allclient.jar

Name:       WebSphere MQ classes for Java Message Service
Version:    9.3.0.0
Level:      p000-L140428.1
Build Type: Production
Location:   file:/C:/Program Files/IBM/MQ_1/java/lib/com.ibm.mq.allclient.jar

Name:       WebSphere MQ JMS Provider
Version:    9.3.0.0
Level:      p000-L140428.1 mqjbnd=p000-L140428.1
Build Type: Production
Location:   file:/C:/Program Files/IBM/MQ_1/java/lib/com.ibm.mq.allclient.jar

Name:       Common Services for Java Platform, Standard Edition
Version:    9.3.0.0
Level:      p000-L140428.1
Build Type: Production
Location:   file:/C:/Program Files/IBM/MQ_1/java/lib/com.ibm.mq.allclient.jar
[MQ 9.3.3 Jun 2023]

jackson-annotations.jar, jackson-core.jar and jackson-databind.jar

The three Jackson JAR files are required if your IBM MQ classes for JMS or IBM MQ classes for Jakarta Messaging application creates secure TLS connections to a queue manager.