Preface

This Developer's Guide for JMX Clients describes the application programming interface provided in Sun GlassFish Message Queue for programmatically configuring and monitoring Message Queue resources in conformance with the Java Management Extensions (JMX). These functions are also available to system administrators by way of the Message Queue Administration Console and command line utilities, as described in the Message Queue Administration Guide; the API described here makes the same administrative functionality available programmatically from within a running client application. Broker properties and command-line options that support the JMX API are described in the Message Queue Administration Guide.

This preface consists of the following sections:

• Who Should Use This Book

• Before You Read This Book

• How This Book Is Organized

• Documentation Conventions

• Related Documentation

• Third-Party Web Site References

• Searching Sun Product Documentation

• Documentation, Support, and Training

• Sun Welcomes Your Comments

Who Should Use This Book

This guide is intended for Java application developers wishing to use the Message Queue JMX API to perform Message Queue administrative tasks programmatically from within a client application.

Before You Read This Book

This guide assumes that you are already familiar with general Message Queue concepts, administrative operations, and Java client programming, as described in the following manuals:

• Message Queue Technical Overview

• Message Queue Administration Guide

• Message Queue Developer’s Guide for Java Clients

You should also be familiar with the general principles of the Java Management Extensions, as described in the following publications:

• Java Management Extensions Instrumentation and Agent Specification

• Java Management Extensions (JMX) Remote API Specification

Together, these two publications are referred to hereafter as the JMX Specification.

How This Book Is Organized

Table P–1 describes the contents of this manual.

Documentation Conventions

This section describes the following conventions used in Message Queue documentation:

• Typographic Conventions

• Symbol Conventions

• Shell Prompt Conventions

• Directory Variable Conventions

Typographic Conventions

The following table describes the typographic conventions that are used in this book.

Symbol Conventions

The following table explains symbols that might be used in this book.

Shell Prompt Conventions

The following table shows the conventions used in Message Queue documentation for the default UNIX® system prompt and superuser prompt for the C shell, Bourne shell, Korn shell, and for the Windows operating system.

Directory Variable Conventions

Message Queue documentation makes use of three directory variables; two of which represent environment variables needed by Message Queue. (How you set the environment variables varies from platform to platform.)

The following table describes the directory variables that might be found in this book and how they are used. When installed from the IPS (pkg(5)) image distribution, Message Queue is installed in a directory referred to as mqInstallHome, and some of the directory variables in Table P–5 reference this mqInstallHome directory.

In this book, directory variables are shown without platform-specific environment variable notation or syntax (such as $IMQ_HOME on UNIX). Non-platform-specific path names use UNIX directory separator (/) notation.

Related Documentation

The information resources listed in this section provide further information about Message Queue in addition to that contained in this manual. The section covers the following resources:

• Message Queue Documentation Set

• Java Message Service (JMS) Specification

• JavaDoc

• Example Client Applications

• Online Help

Message Queue Documentation Set

The documents that comprise the Message Queue documentation set are listed in the following table in the order in which you might normally use them. These documents are available through the Sun documentation Web site at

http://www.sun.com/documentation/

Click “Software,” followed by “Application & Integration Services,” and then “Message Queue.”

For a content reference to topics with the Message Queue documentation set, see the Message Queue Documentation Center at the above location.

Java Message Service (JMS) 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

http://java.sun.com/products/jms/docs.html

JavaDoc

JMS and Message Queue API documentation in JavaDoc format is included in your Message Queue installation at the locations shown in Table P–7, depending on your installation method. This documentation can be viewed in any HTML browser. It includes standard JMS API documentation as well as Message Queue–specific APIs.

Example Client Applications

Message Queue provides a number of example client applications to assist developers.

Example Java Client Applications

Example Java client applications are located in the following directories, depending on installation method. See the README files located in these directories and their subdirectories for descriptive information about the example applications.

Example C Client Programs

Example C client applications are located in the following directories, depending on installation method. See the README files located in these directories and their subdirectories for descriptive information about the example applications.

Example JMX Client Programs

Example Java Management Extensions (JMX) client applications are located in the following directories, depending on installation method. See the README files located in these directories and their subdirectories for descriptive information about the example applications.

Online Help

Online help is available for the Message Queue command line utilities; for details, see Chapter 16, Command Line Reference, in Sun GlassFish Message Queue 4.4 Administration Guide for details. The Message Queue graphical user interface (GUI) administration tool, the Administration Console, also includes a context-sensitive help facility; see the section “Administration Console Online Help” in Chapter 2, Quick-Start Tutorial, in Sun GlassFish Message Queue 4.4 Administration Guide.

Third-Party Web Site References

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 or alleged to be 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.

Searching Sun Product Documentation

Besides searching Sun product documentation from the docs.sun.com web site, you can use a search engine by typing the following syntax in the search field:

search-term site:docs.sun.com

For example, to search for “broker,” type the following:

broker site:docs.sun.com

To include other Sun web sites in your search (for example, java.sun.com, www.sun.com, and developers.sun.com), use “sun.com” in place of “docs.sun.com” in the search field.

Documentation, Support, and Training

The Sun web site provides information about the following additional resources:

• Documentation

• Support

• Training

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 Feedback.