Sun logo      Previous      Contents      Next     

Sun ONE Message Queue 3.0.1 SP2 Installation Guide

Chapter 1

This chapter provides an overall introduction to installing the MQ product. The topics covered are:

Product Editions

The Sun™ ONE Message Queue product is available in two editions: Platform and Enterprise—each corresponding to a different licensed capacity, as described below. (To upgrade MQ from one edition to another, see the instructions in the MQ Installation Guide.)

Platform Edition

This edition can be downloaded free from the Sun website and is also bundled with the latest Sun ONE Application Server platform. The Platform Edition places no limit on the number of JMS client connections supported by each MQ message service. It comes with two licenses, as described below:

Enterprise Edition

This edition is for deploying and running messaging applications in a production environment. It includes support for multi-broker message services, HTTP/HTTPS connections, secure connection services, scalable connection capability, and multiple queue delivery policies. You can also use the Enterprise Edition for developing, debugging, and load testing messaging applications and components. The Enterprise Edition has an unlimited duration license that places no limit on the number of brokers in a multi-broker message service, but specifies the number of CPUs that are supported.

Supported Platforms and Products

MQ 3.0.1, SP2 is supported on Solaris, Linux, and Windows operating systems and platforms. It also depends upon other technologies, as indicated in the following table. Other versions or vendor implementations can also be used but they are untested by Sun Microsystems and therefore not supported.

Table 1-1  MQ 3.0.1 Product Support Matrix 


Used For

Supported Platform/Product Version1

Java Runtime Environment (JRE)
(Sun Microsystems production versions only)

MQ broker (message server) and MQ administration tools

JDK/JRE 1.4.1_03:

  • Solaris 9—MQ depends on platform-bundled JDK/JRE 1.4.1_03
  • Solaris 8—platform-bundled JRE 1.3 needs to be removed and replaced by JDK/JRE 1.4.1_03
  • Windows—JRE 1.4.1_03 is bundled and installed with MQ

JDK/JRE 1.4.1:

  • Linux— JRE 1.4.1 is bundled on MQ CD distribution, but not yet with Linux platform

Java Software Development Kit (JDK), Standard Edition
(Sun Microsystems production versions only)

JMS client development

(SOAP messaging clients are supported only on JDK 1.4.1_03)

Version 1.4.1_032:

  • SPARC on Solaris 8 and Solaris 9
  • x86 on Solaris 9, update 4 or higher
  • Windows XP professional, 2000 Professional SP2,
    2000 Server SP2, 2000 Advanced Server SP2
  • Linux RedHat 7.2

Version 1.3.1_053:

  • (SPARC only) Solaris 8 and Solaris 9
  • Windows XP professional, 2000 Professional SP2,
    2000 Server SP2, 2000 Advanced Server SP2

Version 1.2.2_08: Not supported, but should work (in case you cannot upgrade to a later version)

LDAP Directory Server

MQ user repository and administered object support

Sun ONE Directory Server version 5.1

Web Server

HTTP and HTTPS support

Sun ONE Web Server, Enterprise Edition 6.0 SP4


Plugged-in persistence support

Cloudscape (version 3.0)

Oracle 8i, version 8.1.7 and Oracle 9i, version 9.0.1


administered object support

  • JNDI version 1.2.1
  • LDAP Service Provider version 1.2.2
  • File System Service Provider version 1.2 Beta 3 (supported for development and testing, but not for deployment in a production environment.)

1Check the MQ Release Notes for any updates to supported versions

2Download this JDK from:

3Download this JDK from:

MQ Software Modules

The following table identifies the full set of software modules included with the MQ product (see Table 1-2 for their installed location).

Table 1-2  MQ Software Modules 




The server-side software used to route and deliver messages. This module requires the Java runtime module.

Administration tools

The command-line utilities and GUI tools used to administer an MQ messaging system. This module requires the client runtime and Java runtime modules.

Client runtime

The client-side software needed to support client applications.


API documentation needed by client application developers in Javadoc™ format.

Example applications

Example client applications.

Java runtime

Java Runtime Environment (Windows only).


The software needed to enable the licensed capacity of an MQ messaging system.

Installing from Web and CD-ROM

You have the option of either downloading the MQ 3.0.1, SP2 product from the Sun ONE website or installing it from CD-ROM. For detailed instructions, see the platform-specific instructions in subsequent chapters.

Installed Directory Structure

The install image below reflects a full Solaris installation (all packages) or a full (“Typical”) Windows installation. This image might vary if you perform a partial installation.


On Windows, the COPYRIGHT, LICENSE, and README files have a .txt filename extension.

Table 1-3  Installed Directory Structure 

File and directory

File and directory (Windows and Linux)1


COPYRIGHT (not installed)


Copyright text file

LICENSE (not installed)


License text file

README (not installed)


README text file

/usr/bin directory

./bin directory

Contains the executables for the broker (imqbrokerd) and the following MQ administration tools:

  • Administration Console (imqadmin)
  • Command (imqcmd)
  • Object Manager (imqobjmgr)
  • User Manager (imqusermgr)
  • Database Manager (imqdbmgr)
  • Key Tool (imqkeytool)

On Windows, the files named above have a .bat filename extension. This directory also includes the utility to install and uninstall the broker as a Windows Service (imqsvcadmin) as well other executables (imqbrokersvc).

/usr/share/lib directory

./lib directory

Contains files that support the MQ client runtime:

/*jar contains jar files used to build and run JMS client applications

/usr/share/lib/imq directory

./lib directory

Contains files used to support MQ tools and processes:

/ext/*jar location for placing jar files needed for plug-in persistence capabilitiy

/props subdirectory contains the broker’s default configuration file

/help subdirectory contains MQ help files


/etc/imq directory

./etc directory

Contains license files, security-related files (such as passfile, access control files, and flat-file user repository), and (on Solaris only) rc script configuration files that can be used for automatic startup

/var/imq directory

./var directory

Working storage directory for MQ.

/instances subdirectory which will contain configuration files, log files, and file-based persistent data stores for each broker instance

/usr/share/javadoc/imq directory

./javadoc directory

Contains the MQ and JMS API documentation distributed as Javadoc (HTML)

/usr/demo/imq directory

./demo directory

Source code for and instructions on how to run client example applications


./jre directory

The JRE 1.4 files (on Windows only)

1Paths are relative to IMQ_HOME (see Directory Variable Conventions).

Upgrading from Version 2.0

MQ 3.0.1, SP2 is fully compatible with MQ 3.0.1 and MQ 3.0.1 SP1, and upgrading from MQ 3.0.1 or MQ 3.0.1 SP1 to MQ 3.0.1, SP2 requires no changes in broker configuration, administered objects, administration tools, or client applications.

However, MQ 3.0.1 versions are generally not compatible with iMQ 2.0, largely because of changes in internal and external data used by MQ 3.0.1 versions. For this reason it is strongly recommended that you uninstall iMQ 2.0 before installing any MQ 3.0.1 version, and not try to install MQ 3.0.1 over iMQ 2.0.

Uninstalling iMQ 2.0

If you are running iMQ 2.0, Service Pack 1, you should first uninstall the Service Pack, using the uninstall instructions in the Service Pack Installation Guide, and then uninstall iMQ 2.0, using the uninstall instructions in the iMQ 2.0 Installation Guide.

The uninstall operation does not remove the iMQ 2.0 IMQ_VARHOME directory. This directory (by default /var/opt/SUNWjmq on Solaris and Linux operating systems, and c:\Program files\iPlanetMessageQueue2.0\var on Windows systems) contains transient and security-related files (see Table 1-4). Some of this data is compatible with MQ 3.0.1 and can be preserved using the instructions in the following section.

Compatibilities and Incompatibilities

Due to changes made to improve features, MQ 3.0.1 versions are generally not compatible with iMQ 2.0. In particular, there are a number of issues that you might need to address when upgrading from iMQ 2.0 to MQ 3.0.1, SP2:

Broker Compatibility

An MQ 3.0.1 broker will not inter-operate with an iMQ 2.0 broker due to changes in broker properties and the persistent store schema. However, some iMQ 2.0 data is compatible with MQ 3.0.1, as shown in Table 1-4, and can be preserved when upgrading to MQ 3.0.1. When upgrading from iMQ 2.0 to MQ 3.0.1, you should consider the following:

Administered Object Compatibility

MQ 3.0.1 administered objects have been enhanced with new attributes and iMQ 2.0 attributes have been renamed. Therefore, when upgrading from iMQ 2.0 to MQ 3.0.1, you should consider the following:

Administration Tool Compatibility

Because of the renaming of many files and directories (specifically to replace the string “jmq” with “imq”), all MQ 3.0.1 command line utilities, broker properties, administered object attributes, and internal file names have changed. Therefore, when upgrading from iMQ 2.0 to MQ 3.0.1, you should consider the following:

Client Compatibility

When upgrading from iMQ 2.0 to MQ 3.0.1, you should consider the following:

Where To Go Next

When you are ready to install MQ on a specific platform, see the appropriate chapter for your platform (Solaris, Linux, or Windows). Each chapter contains hardware and software requirements, installation procedures, and other relevant instructions, such as how to upgrade editions and how to proceed after installation.

Previous      Contents      Next     

Copyright 2004 Sun Microsystems, Inc. All rights reserved.