Sun Java logo     Previous      Contents      Index      Next     

Sun logo
Sun Java System Message Queue 3 2005Q4 Administration Guide 


This Sun Java™ System Message Queue Administration Guide describes Sun Java System Message Queue 3 2005Q4 (Message Queue 3.6), providing the information you need in order to administer a Message Queue messaging system.

This preface contains the following sections:

Who Should Use This Book

This manual is intended for administrators and application developers who need to perform Message Queue administrative tasks. A Message Queue administrator is responsible for setting up and managing a Message Queue messaging system, especially the message server at the heart of the system.

Before You Read This Book

Before reading this manual, you should read the Message Queue Technical Overview to become familiar with the Message Queue implementation of the Java Message Specification, with the components of the Message Queue service, and with the basic process of developing, deploying, and administering a Message Queue application.

How This Book Is Organized

Table 1 briefly describes the contents of this manual.

Table 1  Contents of This Manual 



Part I, "Introduction to Message Queue Administration"

Chapter 1, "Administrative Tasks and Tools"

Introduces Message Queue administrative tasks and tools.

Chapter 2, "Quick-Start Tutorial"

Provides a hands-on tutorial to acquaint you with the Message Queue Administration Console.

Part II, "Administration Tasks"

Chapter 3, "Starting Brokers and Clients"

Describes how to start the Message Queue broker and clients.

Chapter 4, "Configuring a Broker"

Describes how configuration properties are set and read, and gives an introduction to the configurable aspects of the broker. Also describes how to set up a file or database to perform persistence functions.

Chapter 5, "Managing a Broker"

Describes broker management tasks.

Chapter 6, "Managing Physical Destinations"

Describes management tasks relating to physical destinations.

Chapter 7, "Managing Security"

Describes security-related tasks, such as managing password files, authentication, authorization, and encryption.

Chapter 8, "Managing Administered Objects"

Describes the object store and shows how to perform tasks related to administered objects (connection factories and destinations).

Chapter 9, "Working With Broker Clusters"

Describes how to set up and manage a cluster of Message Queue brokers.

Chapter 10, "Monitoring a Message Server"

Describes how to set up and use Message Queue monitoring facilities.

Chapter 11, "Analyzing and Tuning a Message Service"

Describes techniques for analyzing and optimizing message server performance.

Chapter 12, "Troubleshooting Problems"

Provides suggestions for determining the cause of common Message Queue problems and the actions you can take to resolve them.

Part III, "Reference"

Chapter 13, "Command Line Reference"

Provides syntax and descriptions for Message Queue command utilities.

Chapter 14, "Broker Properties Reference"

Lists and describes the properties you can use to configure a broker.

Chapter 15, "Physical Destination Property Reference"

Lists and describes the properties you can use to configure physical destinations.

Chapter 16, "Administered Object Attribute Reference"

Lists and describes the properties you can use to configure administered objects (connection factories and destinations).

Chapter 17, "JMS Resource Adapter Property Reference"

Lists and describes the properties you can use to configure the Message Queue Resource Adapter for use with an application server.

Chapter 18, "Metrics Reference"

Lists and describes the metrics produced by a Message Queue broker.

Part IV, "Appendixes"

Appendix A, "Platform-Specific Locations of Message Queue Data"

Lists the locations of Message Queue files on each supported platform.

Appendix B, "Stability of Message Queue Interfaces"

Describes the stability of various Message Queue interfaces.

Appendix C, "HTTP/HTTPS Support"

Describes how to set up and use the Hypertext Transaction protocol (HTTP) for Message Queue communication.

Appendix D, "Frequently Used Command Utility Commands"

Lsts some frequently used Message Queue Command utility (imqcmd) commands.

Conventions Used In This Book

This section describes the conventions used in this manual.

Text Conventions

Table 2 summarizes the text conventions used in this manual.

Table 2  Text Conventions 




Italicized text represents a placeholder to be replaced with an appropriate clause or value. It is also used for document titles, for emphasis, and for key words or phrases being introduced.


Monospace text represents example code; commands that you enter on the command line; directory, file, or path names; error message text; class names; method names (including all elements in the signature); package names; reserved words; and URLs.


Square brackets indicate optional values in a command line syntax statement.


Text in all capitals represents environment variables (such as IMQ_HOME) or acronyms (such as JMS, GIF, or HTML).


Simultaneous keystrokes are joined with a plus sign: Ctrl+A means press the Ctrl and A keys simultaneously.


Consecutive keystrokes are joined with a hyphen: Esc-S means press the Esc key, release it, and then press the S key.

Directory Variable Conventions

Message Queue makes use of three directory variables; how they are set varies from platform to platform. Table 3 describes these variables and how they are used on the Solaris™, Linux, and Windows platforms.


In this manual, directory variables are shown without the usual platform-specific syntax (such as $IMQ_HOME on UNIX). Path names generally use UNIX directory separator notation (/).

Table 3  Message Queue Directory Variables 




Refers to the Message Queue base directory (root installation directory):

  • Unused on Solaris and Linux; there is no Message Queue base directory.
  • On Windows, set by the Message Queue installer (by default, to C:\Program Files\Sun\MessageQueue3).
  • For Sun Java System Application Server on Solaris and Windows, set to /imq under the Application Server base directory.


The directory in which Message Queue temporary or dynamically created configuration and data files are stored; can be set as an environment variable to point to any directory.

  • On Solaris, defaults to /var/imq.
  • On Linux, defaults to /var/opt/sun/mq directory.
  • On Windows, defaults to IMQ_HOME\var.
  • For Sun Java System Application Server, Evaluation Edition, on Solaris, defaults to IMQ_HOME/var.
  • For Sun Java System Application Server on Windows, defaults to IMQ_HOME\var.


The location of the Java™ runtime (JRE) required by Message Queue executables. Set by default to look in the following locations in the order shown, but can optionally be set to wherever the required JRE resides.

  • On Solaris 8 or 9:


  • On Solaris 10:


  • On Linux:


  • On Windows:


Related Documentation

The information resources listed in this section provide further information about Message Queue in addition to that provided in this manual.

Message Queue Documentation Set

The Message Queue documentation set comprises the documents listed in Table 4.

Table 4  Message Queue Documentation Set 




Message Queue Installation Guide

Developers and administrators

Explains how to install Message Queue software on Solaris, Linux, and Windows platforms.

Message Queue Release Notes

Developers and administrators

Includes descriptions of new features, limitations, and known bugs, as well as technical notes.

Message Queue Technical Overview

Developers and administrators

Introduces Message Queue concepts, features, and components.

Message Queue Administration Guide

Administrators and developers

Provides background and information needed to perform administrative tasks using Message Queue administration tools.

Message Queue Developer’s Guide for Java Clients


Provides information on developing Java client programs using the Message Queue implementation of the JMS and SOAP/JAXM specifications.

Message Queue Developer’s Guide for C Clients


Provides information on developing C client programs using the C application programming interface (C-API) to the Message Queue message service.

Java Message Service Specification

The Message Queue message service conforms to the Java Message Service (JMS) application programming interface, described in the Java Message Service Specification. This document can be found at the URL

Online Help

Online help is available for the Message Queue command line utilities; see Chapter 13, "Command Line Reference," for details. The Message Queue graphical user interface (GUI) administration tool, the Administration Console, also includes a context-sensitive online help facility; see Administration Console Online Help.


JMS and Message Queue API documentation in JavaDoc format is provided at the locations shown in Table 5. This documentation can be viewed in any HTML browser, such as Netscape or Internet Explorer. It includes standard JMS API documentation as well as Message Queue–specific APIs.

Table 5  JavaDoc Locations 









Example Client Applications

The Message Queue installation includes a directory containing several example client applications. See Appendix A, "Platform-Specific Locations of Message Queue Data," for exact locations depending on the particular platform you are using. The README files located in that directory and in each of its subdirectories provide descriptive information about the example applications.

Related Third-Party Web Sites

Where relevant, this manual refers to third-party URLs that provide additional, related information.


Sun is not responsible for the availability of third-party Web sites mentioned in this manual. Sun does not endorse and is not responsible or liable for any content, advertising, products, or other materials available on or through such sites or resources. Sun will not be responsible or liable for any actual or alleged damage or loss caused by or in connection with the use of or reliance on any such content, goods, or services available on or through such sites or resources.

Sun Welcomes Your Comments

Sun is always interested in improving its documentation and welcomes your comments and suggestions. To share your comments, go to

and click Send comments. In the resulting online form, provide the document title and part numberd along with your comment. (The part number is a seven-digit or nine-digit number that can be found on the title page of the book or at the top of the document.)

Previous      Contents      Index      Next     

Part No: 819-2571-10.   Copyright 2005 Sun Microsystems, Inc. All rights reserved.