What is installed for IBM MQ classes for JMS
A number of files and directories are created when you install IBM MQ classes for JMS. On Windows, some configuration is performed during installation by automatically setting environment variables. On other platforms, and in certain Windows environments, we must set environment variables before we can run IBM MQ classes for JMS applications.
For most operating systems, the IBM MQ classes for JMS are installed as an optional component when you install IBM MQ.
For the IBM MQ client for HP Integrity NonStop Server, the IBM MQ classes for JMS are installed by default.
For more information about installing IBM MQ, see:Important: Apart from the relocatable JAR files described in IBM MQ classes for JMS relocatable JAR files, copying the IBM MQ classes for JMS JAR files or native libraries to other machines, or to a different location on a machine where the IBM MQ classes for JMS have been installed, is not supported.
Installation directories
Table 1 shows where the IBM MQ classes for JMS files are installed on each platform.Platform | Directory |
---|---|
UNIX and Linux | MQ_INSTALLATION_PATH/java |
Windows | MQ_INSTALLATION_PATH\java |
IBM i | /QIBM/ProdData/mqm/java |
z/OS | MQ_INSTALLATION_PATH/mqm/V9R1M0/java |
IBM MQ client for HP Integrity NonStop Server | MQ_INSTALLATION_PATH/opt/mqm/java |
MQ_INSTALLATION_PATH represents the high-level directory in which IBM MQ is installed.
The installation directory includes the following content:- The IBM MQ classes for JMS JAR files, including the relocatable JAR files, which are in the MQ_INSTALLATION_PATH\java\lib directory.
- The IBM MQ native libraries, which are used by
applications that use the Java Native Interface.
The 32-bit native libraries are installed into the MQ_INSTALLATION_PATH\java\lib directory and the 64-bit native libraries can be found in the MQ_INSTALLATION_PATH\java\lib64 directory.
For more information about the IBM MQ native libraries, see Configure the Java Native Interface (JNI) libraries.
- Additional scripts that are described in Scripts provided with IBM MQ classes for JMS. These scripts are in the MQ_INSTALLATION_PATH\java\bin directory.
- The specifications of the IBM MQ classes for JMS API. The
Javadoc tool has been used to generate the HTML
pages that contain the specifications of the API. The HTML pages are in the MQ_INSTALLATION_PATH\java\doc\WMQJMSClasses directory:
- On UNIX, Linux, and Windows, this subdirectory contains the individual HTML pages.
- On IBM i, the HTML pages are in a file called wmqjms_javadoc.jar.
- On z/OS, the HTML pages are in a file called wmqjms_javadoc.jar.
- Support for OGSi. OSGi bundles are installed in the java\lib\OSGi directory and described in Support for OSGi.
- The IBM MQ resource adapter, which can be deployed
into any Java Platform, Enterprise Edition 7 ( Java EE 7) compliant application server.
The IBM MQ resource adapter is in the MQ_INSTALLATION_PATH\java\lib\jca directory; for more information, see Use the IBM MQ resource adapter
- On Windows, symbols that can be used for debugging are installed in the MQ_INSTALLATION_PATH\java\lib\symbols directory.
The installation directory also includes some files that belong to other IBM MQ components.
Sample applications
Some sample applications are supplied with IBM MQ classes for JMS. Table 2 shows where the sample applications are installed on each platform.Platform | Directory |
---|---|
UNIX and Linux | MQ_INSTALLATION_PATH/samp/jms |
Windows | MQ_INSTALLATION_PATH\tools\jms |
IBM i | /QIBM/ProdData/mqm/java/samples/jms |
z/OS | MQ_INSTALLATION_PATH/mqm/V9R1M0/java/samples/jms |
IBM MQ client for HP Integrity NonStop Server | MQ_INSTALLATION_PATH/opt/mqm/samp/jms |
MQ_INSTALLATION_PATH represents the high-level directory in which IBM MQ is installed.
After installation, you might need to perform some configuration tasks to compile and run applications.
Set environment variables describes the classpath that is required to run simple IBM MQ classes for JMS applications. This topic also describes additional JAR files that need to be referenced in special circumstances and the environment variables that you must set to run the scripts that are provided with IBM MQ classes for JMS.
To control properties, such as tracing and logging of an application, we need to provide a configuration properties file. The IBM MQ classes for JMS configuration properties file is described in The IBM MQ classes for JMS configuration file.
- IBM MQ classes for JMS relocatable JAR files
The relocatable JAR files can be moved to systems that need to run IBM MQ classes for JMS. - Set environment variables
Before we can compile and run IBM MQ classes for JMS applications, the setting for the CLASSPATH environment variable must include the IBM MQ classes for JMS Java archive (JAR) file. Depending on we requirements, you might need to add other JAR files to your class path. To run the scripts provided with IBM MQ classes for JMS, other environment variables must be set. - Configure the Java Native Interface (JNI) libraries
IBM MQ classes for JMS applications, that either connect to a queue manager using the bindings transport, or that connect to a queue manager using the client transport and use channel exit programs written in languages other than Java, need to be run in an environment that allows access to the Java Native Interface (JNI) libraries. - The IBM MQ classes for JMS configuration file
An IBM MQ classes for JMS configuration file specifies properties that are used to configure IBM MQ classes for JMS. - STEPLIB configuration for IBM MQ classes for JMS on z/OS
On z/OS, the STEPLIB used at run time must contain the IBM MQ SCSQAUTH and SCSQANLE libraries. Specify these libraries in the startup JCL or using the .profile file. - IBM MQ classes for JMS and software management tools
Software management tools such as Apache Maven can be used with the IBM MQ classes for JMS.
Parent topic: Installing and configuring IBM MQ classes for JMS
Related tasks
Related information