Sun Java logo     Previous      Contents      Index      Next     

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

Preface

The Sun Java™ System Message Queue Administration Guide provides the information you need in order to administer a Message Queue messaging system.

This book describes Sun Java System Message Queue 3 2005Q1 (Message Queue 3.6).

This preface contains the following sections:


Who Should Use This Book

This guide is meant for administrators and application developers who need to perform Message Queue administration tasks.

A Message Queue administrator is responsible for setting up and managing a Message Queue messaging system, especially the Message Queue message server at the heart of this system.


Before You Read This Book

You must 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

The following table briefly describes the contents of the manual.

Table 1  Book Contents 

Part/Chapter

Description

Part I, "Introduction to Message Queue Administration"

Chapter 1, "Administration Tasks and Tools"

Introduces Message Queue administration tasks and tools.

Chapter 2, "Administration Quick Start"

Provides a hands-on tutorial to acquaint you with the 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 topics and queues.

Chapter 7, "Managing Security"

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

Chapter 8, "Managing Administered Objects"

Describes the object store and explains how to perform tasks related to destination administered objects and connection factory administered objects.

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 message server performance and explains how to tune the message server to optimize its performance.

Chapter 12, "Troubleshooting Problems"

Provides suggestions about how to determine the cause of common Message Queue problems, and about the actions you can take to resolve the problems.

Part III, "Reference"

Chapter 13, "Command Reference"

Provides syntax and descriptions for the Message Queue command utilities.

Chapter 14, "Broker Properties Reference"

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

Chapter 15, "Physical Destination Property Reference"

List and describes the properties you can use to configure topics and queues.

Chapter 16, "Administered Object Attribute Reference"

List and describes the properties you can use to configure destination administered objects and connection factory administered objects.

Chapter 17, "JMS Resource Adapter Attribute Reference"

List and describes the properties you can use to configure the Message Queue resource adapter for use with an application server.

Chapter 18, "Metrics Reference"

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

Part IV, "Appendixes"

Appendix A, "Operating System-Specific Locations of Message Queue Data"

Lists the location 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 use of HTTP for Message Queue communication.


Conventions Used In This Book

This section provides information about the conventions used in this document.

Text Conventions

Table 2  Document Conventions 

Format

Description

italics

Italicized text represents a placeholder. Substitute an appropriate clause or value where you see italic text. Italicized text is also used to designate a document title, for emphasis, or for a word or phrase being introduced.

monospace

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 to indicate optional values in a command line syntax statement.

ALL CAPS

Text in all capitals represents file system types (GIF, TXT, HTML and so forth), environment variables (IMQ_HOME), or acronyms (Message Queue, JSP).

Key+Key

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

Key-Key

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 summarizes how they are used on the Solaris™, Windows, and Linux platforms.

Table 3  Message Queue Directory Variables 

Variable

Description

IMQ_HOME

This is generally used in Message Queue documentation to refer to the Message Queue base directory (root installation directory):

  • On Solaris and Linux, there is no root Message Queue installation directory. Therefore, IMQ_HOME is not used in Message Queue documentation to refer to file locations on Solaris.
  • On Solaris and Windows, for Sun Java System Application Server, the root Message Queue installation directory is /imq under the Application Server base directory.
  • On Windows, the root Message Queue installation directory is set by the Message Queue installer (by default, as C:\Program Files\Sun\MessageQueue3).

IMQ_VARHOME

This is the /var directory in which Message Queue temporary or dynamically-created configuration and data files are stored. It can be set as an environment variable to point to any directory.

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

IMQ_JAVAHOME

This is an environment variable that points to the location of the Java™ runtime (JRE) required by Message Queue executables:

  • On Solaris, IMQ_JAVAHOME looks for the java runtime in the following order, but a user can optionally set the value to wherever the required JRE resides.
    Solaris 8 or 9:
      /usr/jdk/entsys-j2se
      /usr/jdk/jdk1.5.
    *
      /usr/jdk/j2sdk1.5.*
      /usr/j2se
    Solaris 10:
      /usr/jdk/entsys-j2se
      /usr/java
      /usr/j2se
  • On Linux, Message Queue first looks for the java runtime in the following order, but a user can optionally set the value of IMQ_JAVAHOME to wherever the required JRE resides.
      /usr/jdk/entsys-j2se
      /usr/java/jre1.5.
    *
      /usr/java/jdk1.5.*
      /usr/java/jre1.4.2*
      /usr/java/j2sdk1.4.2
    *
  • On Windows, IMQ_JAVAHOME defaults to IMQ_HOME\jre, but a user can optionally set the value to wherever the required JRE resides.

In this guide, IMQ_HOME, IMQ_VARHOME, and IMQ_JAVAHOME are shown without platform-specific environment variable notation or syntax (for example, $IMQ_HOME on UNIX�). Path names generally use UNIX directory separator notation (/).


Related Documentation

In addition to this guide, Message Queue provides additional documentation resources.

Message Queue Documentation Set

The documents that comprise the Message Queue documentation set are listed in Table 4 in the order in which you would normally use them.

Table 4  Message Queue Documentation Set 

Document

Audience

Description

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

Describes Message Queue concepts, features, and components.

Message Queue Administration Guide

Administrators and developers

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

Message Queue Developer’s Guide for Java Clients

Developers

Provides information about how to develop a Java client program that uses the Message Queue implementation of the JMS and SOAP/JAXM specifications.

Message Queue Developer’s Guide for C Clients

Developers

Provides information about how to develop a C client program that uses the C interface (C-API) to the Message Queue message service.

Online Help

Message Queue includes command line utilities for performing Message Queue message service administration tasks. To access the online help for these utilities, see Chapter 13, "Command Reference.".

Message Queue also includes a graphical user interface (GUI) administration tool, the Administration Console (imqadmin). Context sensitive online help is included in the Administration Console.

JavaDoc

JMS and Message Queue API documentation in JavaDoc format is provided at the following location:

Platform

Location

Solaris

/usr/share/javadoc/imq/index.html

Linux

/opt/sun/mq/javadoc/index.html/

Windows

IMQ_HOME/javadoc/index.html

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 for Message Queue administered objects (see Chapter 3 of the Message Queue Developer’s Guide for Java Clients), which are of value to developers of messaging applications.

Example Client Applications

A number of example applications that provide sample client application code are included in a platform-specific directory (see Appendix A, "Operating System-Specific Locations of Message Queue Data").

See the README file located in that directory and in each of its subdirectories.

The Java Message Service (JMS) Specification

The JMS specification can be found at the following location:

The specification includes sample client code.


Related Third-Party Web Site References

Third-party URLs are referenced in this document and provide additional, related information.


Note

Sun is not responsible for the availability of third-party Web sites mentioned in this document. Sun does not endorse and is not responsible or liable for any content, advertising, products, or other materials that are 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 that are available on or through such sites or resources.



Sun Welcomes Your Comments

Sun is interested in improving its documentation and welcomes your comments and suggestions.

To share your comments, go to http://docs.sun.com and click Send Comments. In the online form, provide the document title and part number. 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-0066-10.   Copyright 2005 Sun Microsystems, Inc. All rights reserved.