IBM Support

Obtaining the IBM MQ Resource Adapter for the WebSphere Application Server Liberty Profile

Technote (troubleshooting)


How to obtain the IBM MQ Resource Adapter for use with either the WebSphere Application Server Liberty Profile or other JavaEE application servers?


In order to connect to IBM MQ from the Liberty Profile or other JavaEE application server, the IBM MQ Resource Adapter must be used. The Liberty Profile does not contain the IBM MQ Resource Adapter. It must be obtained separately.

Resolving the problem

The JavaEE version of the application server used will determine the version of the resource adapter that must be used.

JavaEE 1.5 and 1.6

The WebSphere MQ Resource Adapter v7.5 supports JCA v1.5 and provides JMS 1.1 support. To provide full integration with WebSphere Application Server Liberty Profile the WebSphere MQ 7.5 Resource Adapter has been updated to APAR IC92914. This resource adapter retains full compatibility with other JavaEE 1.5 and later application servers.

See "WebSphere MQ resource adapter v7.1 and later statement of support"

JavaEE 1.7

The IBM MQ Resource Adapter v8.0 and v9.0 supports JCA v1.7 and provides JMS 2.0 support. This needs to be deployed within a JavaEE 1.7 and later application server.

See "IBM MQ resource adapter v8.0 statement of support" and "IBM MQ resourece adapter v9.0 statement of support"

The WebSphere MQ Resource Adapter can be downloaded from Fix Central. To locate the latest version that is available for download, enter the phrase "Resource Adapter" in the Text Search box. The name of the file to be downloaded will be in the format of <V.R.M.F>-WS-MQ-Java-InstallRA.jar. From version IBM MQ v9 this format is <V.R.M.F>-IBM-MQ-Java-InstallRA.jar


The jar file that can be downloaded from Fix Central is executable. When run, it will display the IBM MQ license agreement, which must be accepted. It will ask for a directory in which to install the IBM MQ Resource Adapter. The Resource Adapter file and Installation Verification test program will be installed to that directory. The directory will be created if it does not exist.

The directory could be the 'resource adapters' directory of an application server or any other directory on your system. The Java installer used here does not require running as root or any specific user. The only requirement is the user it is run as has access write to the directory you want the files to go in.

To start the installation issue the command:
java -jar <V.R.M.F>-WS-MQ-Java-InstallRA.jar

java -jar <V.R.M.F>-IBM-MQ-Java-InstallRA.jar

from the directory to which you downloaded the file, where:<V.R.M.F>-WS-MQ-Java-InstallRA.jar
is the name of the file that was downloaded from Fix Central.This requires a Java™ Runtime Environment to have been installed on your machine and added to the system path.

For example, in order to install the WebSphere MQ Resource Adapter for the v9.0.0.0 release, the folllowing command would be used:

java -jar

This would display the following:


Before you can use, extract, or install IBM MQ V9.0, you must accept
the terms of 1. IBM International License Agreement for Evaluation of
Programs 2. IBM International Program License Agreement and additional
license information. Please read the following license agreements

The license agreement is separately viewable using the
--viewLicenseAgreement option.

Press Enter to display the license terms now, or 'x' to skip.

Either press 'Enter' or 'x' as required, after display of the license or immediately on selection of 'x', additional license terms can be displayed.

Additional license information is separately viewable using the
--viewLicenseInfo option.

Press Enter to display additional license information now, or 'x' to skip.

Again press 'Enter' or 'x' as required.

The license now need to be accepted, this message is displayed:
By choosing the "I Agree" option below, you agree to the terms of the
license agreement and non-IBM terms, if applicable. If you do not
agree, select "I do not Agree".

Select [1] I Agree, or [2] I do not Agree:

Selecting '2' terminates installation immediately. Selecting '1' allows selection of the installation directory.

Enter directory for product files or leave blank to accept the default value.
The default target directory is H:\Liberty\WMQ

Target directory for product files?

Enter the directory to install the files to, or press 'Enter' without entering any value to install the default location as displayed. After the files have been installed to the requested location a confirmation message is displayed:
Extracting files to H:\Liberty\WMQ\wmq
Successfully extracted all product files.

Files Installed

Within the selected directory a new directory 'wmq' will be created. Inside the 'wmq' directory, the following files are installed.


The wmq.jmsra.ivt.ear is the installation verification test program. The wmq.jmsra.rar is the WebSphere MQ Resource Adapter RAR file.

Details of running the installation verification test are within the IBM MQ 9.0 Product Documentation

Liberty Configuration

Details of the Liberty configuration should be checked in the WebSphere Application Server Product Documentation. In summary, an additional feature should be added (wmqJmsClient-1.1 or wmqJmsClient-2.0), and reference the wmq.jmsra.rar file added. An example configuration to support servlets and MDBs, with JNDI might look like




   <variable name="wmqJmsClient.rar.location"        


For Liberty versions up to v8.5.5.1 if an EJB is deployed using solely the configuration within the ejb-jar.xml, the version of WebSphere Application Server that the Liberty Profile is using must have APAR PM89890 applied. This method of configuration is used for the Resource Adapter's installation verification program (IVT), so this APAR is required in order for the IVT to run.

Platform Support

In addition to the platform support defined by the WebSphere MQ System Requirements, the WebSphere Application Server Liberty profile includes platform support for Mac OS X. Therefore use of the resource adapter within the Liberty profile on Mac OS X will be tolerated. Outside of the Liberty Profile the platform support for the IBM MQ Resource Adapter is unchanged

Document information

More support for: IBM MQ

Software version: 7.5, 8.0, 9.0

Operating system(s): AIX, HP-UX, IBM i, Linux, OpenVMS, Solaris, Windows, z/OS

Software edition: All Editions

Reference #: 1633761

Modified date: 13 June 2016