Sun Java System Message Queue 4.0 Developer's Guide for JMX Clients

Preface

This Message Queue Developer’s Guide for JMX Clients describes the application programming interface provided in Sun Java System Message Queue 4.0 for programmatically configuring and monitoring Message Queue resources in conformance with the Java Management Extensions (JMX). As in earlier versions of Message Queue, 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, new in release 4.0, makes the same administrative functionality available programmatically from within a running client application.

Message Queue 4.0 also includes several new broker properties and command-line options to support the new JMX API. These features are described in the Message Queue Release Notes for release 4.0, and will eventually be incorporated into the Message Queue Administration Guide.

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

This guide consists of the following chapters:

Chapter 1, Introduction to Message Queue JMX introduces the basic concepts and principles of the Message Queue JMX interface.
Chapter 2, Message Queue MBean Reference provides detailed information on the attributes, operations, and notifications provided by Message Queue managed beans (MBeans).
Appendix A, Alphabetical Reference lists the MBean attributes, operations, and notifications alphabetically, with references back to their descriptions in the body of the manual.

Related Documentation

In addition to this guide, Sun provides the additional documentation resources described in the following subsections.

Message Queue Documentation Set

The Message Queue documentation set comprises the documents shown in Table P–1, in the order in which you would normally use them.

Table P–1 Message Queue Documentation Set


Title	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	Introduces basic Message Queue concepts, features, and components
Message Queue Administration Guide	Administrators (also recommended for developers)	Provides background and information needed to perform administrative tasks using Message Queue administration tools
Message Queue Developer’s Guide for Java Clients	Developers	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	Developers	Provides information on developing C and C++ client programs using Message Queue's C application programming interface (C API)

Java Management Extensions (JMX) Documentation

The Message Queue JMX API conforms to the Java Management Extensions (JMX) standard, described in the Java Management Extensions Instrumentation and Agent Specification and the Java Management Extensions (JMX) Remote API Specification. These documents can be downloaded from the URLs

http://jcp.org/aboutJava/communityprocess/final/jsr003

and

http://jcp.org/aboutJava/communityprocess/final/jsr160

respectively.

For a general conceptual introduction to JMX principles and architecture, see the Java Management Extensions (JMX) Technology Overview at

http://java.sun.com/j2se/1.5.0/docs/guide/jmx/overview/JMXoverviewTOC.html

and the Java Management Extensions (JMX) Technology Tutorial at

http://java.sun.com/j2se/1.5.0/docs/guide/jmx/tutorial/tutorialTOC.html

JavaDoc

Message Queue API documentation in JavaDoc format is included in your Message Queue installation at the locations shown in Table P–2, depending on your platform. This documentation can be viewed in any HTML browser.

Table P–2 JavaDoc Locations


Platform	Location
Solaris	`/usr/share/javadoc/imq/index.html`
Linux	`/opt/sun/mq/javadoc/index.html`
Windows	`IMQ_HOME\javadoc\index.html` where `IMQ_HOME` is the Message Queue base directory set by the Message Queue installer (`C:\Program Files\Sun\MessageQueue4` by default)

Example Client Applications

Example applications providing sample Java client application code are included in your Message Queue installation at the locations shown in Table P–3, depending on your platform.

Table P–3 Example Code Locations


Platform	Location
Solaris	`/usr/demo/imq/jmx/`
Linux	`/opt/sun/mq/examples/jmx/`
Windows	`IMQ_HOME\demo\jmx\` where `IMQ_HOME` is the Message Queue base directory set by the Message Queue installer (`C:\Program Files\Sun\MessageQueue4` by default)

Documentation, Support, and Training

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

Typographic Conventions Used in This Book

Table P–4 describes the typographic conventions used in this book.

Table P–4 Typographic Conventions


Typeface	Meaning	Example
`AaBbCc123`	The names of commands, files, and directories, and onscreen computer output	Edit your `.login` file. Use `ls -a` to list all files. `machine_name% you have mail.`
`aabbcc123`	Placeholder: replace with a real name or value	The command to remove a file is `rm` `filename`.
AaBbCc123	Book titles, new terms, and terms to be emphasized	Read Chapter 6 in the User's Guide. A cache is a copy that is stored locally. Do not save the file. Note: Some emphasized items appear bold online.

Sun Welcomes Your Comments

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

http://docs.sun.com

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