Sun Java System Message Queue 4.2 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^TM System 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

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.

Table P–1 Contents of This Manual


Chapter/Appendix	Description
Chapter 1, Introduction to JMX Programming for Message Queue Clients	Introduces the basic concepts and principles of the Message Queue JMX interface.
Chapter 2, Using the JMX API	Provides code examples showing how to use the JMX application programming interface from within your Message Queue client applications.
Chapter 3, 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.

Documentation Conventions

This section describes various conventions used in Message Queue documentation.

Typographic Conventions

Table P–2 shows the typographic conventions used inMessage Queue documentation.

Table P–2 Typographic Conventions


Typeface	Meaning	Examples
`AaBbCc123`	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`	What you type, as contrasted with onscreen computer output	`machine_name%` `su` `Password:`
`AaBbCc123`	Placeholder: replace with a real name or value	The command to remove a file is `rm` `fileName.`
AaBbCc123	Book titles, new terms, and emphasized words	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 online in boldface.

Symbol Conventions

Table P–3 shows symbol conventions used inMessage Queue documentation.

Table P–3 Symbol Conventions


Symbol	Description	Example	Meaning
[ ]	Encloses optional arguments and command options	`ls` [`-l`]	The `-l` option is optional.
{ \| }	Encloses a set of choices for a required command option	`-d` {`y`\|`n`}	The `-d` option requires that you use either the `y` argument or the `n` argument.
`${ }`	Indicates a variable reference	`${com.sun.javaRoot}`	References the value of the variable `com.sun.javaRoot`.
-	Joins simultaneous multiple keystrokes	Ctrl-A	Hold down the Control key while pressing the A key.
+	Joins consecutive multiple keystrokes	Ctrl+A+N	Press the Control key, release it, and then press the subsequent keys.
->	Indicates hierarchical menu selection in a graphical user interface	File -> New -> Templates	From the File menu, choose New; from the New submenu, choose Templates.

Directory Variable Conventions

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

Note –

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

Table P–4 Directory Variable Conventions


Variable	Description
`IMQ_HOME`	Message Queue home directory: Unused on Solaris and Linux; there is no Message Queue home directory. On Windows, denotes the directory `mqInstallHome\mq`, where `mqInstallHome` is the installation home directory specified when the product was installed (by default, `C:\Program Files\Sun\MessageQueue`). Note – The information above applies only to the standalone installation of Message Queue. When Message Queue is installed and run as part of a Sun Java System Application Server installation, `IMQ_HOME` is set to `appServerInstallDir/imq`, where `appServerInstallDir` is the Application Server installation directory.
`IMQ_VARHOME`	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`. On Windows, defaults to `IMQ_HOME\var`. Note – The information above applies only to the standalone installation of Message Queue. When Message Queue is installed and run as part of a Sun Java System Application Server installation, `IMQ_VARHOME` is set to `appServerDomainDir/imq`, where `appServerDomainDir` is the domain directory for the domain starting the Message Queue broker.
`IMQ_JAVAHOME`	Location of the Java runtime environment (JRE) used by Message Queue executables.

Related Documentation

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

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

Table P–5 Message Queue Documentation Set


Document	Audience	Description
Sun Java System Message Queue 4.2 Technical Overview	Developers and administrators	Describes Message Queue concepts, features, and components.
Sun Java System Message Queue 4.2 Release Notes	Developers and administrators	Includes descriptions of new features, limitations, and known bugs, as well as technical notes.
Sun Java System Message Queue 4.2 Installation Guide	Developers and administrators	Explains how to install Message Queue software on Solaris, Linux, and Windows platforms.
Sun Java System Message Queue 4.2 Developer’s Guide for Java Clients	Developers	Provides a quick-start tutorial and programming information for developers of Java client programs using the Message Queue implementation of the JMS or SOAP/JAXM APIs.
Sun Java System Message Queue 4.2 Administration Guide	Administrators, also recommended for developers	Provides background and information needed to perform administration tasks using Message Queue administration tools.
Sun Java System Message Queue 4.2 Developer’s Guide for C Clients	Developers	Provides programming and reference documentation for developers of C client programs using the Message Queue C implementation of the JMS API (C-API).
Sun Java System Message Queue 4.2 Developer’s Guide for JMX Clients	Administrators	Provides programming and reference documentation for developers of JMX client programs using the Message Queue JMX API.

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

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

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

Table P–6 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 home directory

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 platform. See the README files located in these directories and their subdirectories for descriptive information about the example applications.

Platform	Location
Solaris	`/usr/demo/imq/`
Linux	`/opt/sun/mq/examples`
Windows	`IMQ_HOME/demo/` where `IMQ_HOME` is the Message Queue home directory

Platform

Location

Solaris

/usr/demo/imq/

Linux

/opt/sun/mq/examples

Windows

IMQ_HOME/demo/

where IMQ_HOME is the Message Queue home directory

Example C Client Programs

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

Platform	Location
Solaris	`/opt/SUNWimq/demo/C/`
Linux	`/opt/sun/mq/examples/C/`
Windows	`IMQ_HOME/demo/C/` where `IMQ_HOME` is the Message Queue home directory

Platform

Location

Solaris

/opt/SUNWimq/demo/C/

Linux

/opt/sun/mq/examples/C/

Windows

IMQ_HOME/demo/C/

where IMQ_HOME is the Message Queue home directory

Example JMX Client Programs

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

Platform	Location
Solaris	`/opt/SUNWimq/demo/imq/jmx`
Linux	`/opt/sun/mq/examples/jmx`
Windows	`IMQ_HOME\demo\jmx` where `IMQ_HOME` is the Message Queue home directory

Platform

Location

Solaris

/opt/SUNWimq/demo/imq/jmx

Linux

/opt/sun/mq/examples/jmx

Windows

IMQ_HOME\demo\jmx

where IMQ_HOME is the Message Queue home directory

Online Help

Online help is available for the Message Queue command line utilities; seeChapter 13, Command Line Reference, in Sun Java System Message Queue 4.2 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 Java System Message Queue 4.2 Administration Guide.

Documentation, Support, and Training

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

Third-Party Web Site References

Where relevant, this manual refers to third-party URLs that 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 or alleged to be caused by or in connection with 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 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 7-digit or 9-digit number that can be found on the book’s title page or in the document's URL. For example, the part number of this book is 819-7758.)