This Developer's Guide for JMX Clients describes the application programming interface provided in Oracle GlassFishTM 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:
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.
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.
Table P–1 describes the contents of this manual.
Table P–1 Book Contents
Chapter |
Description |
---|---|
Chapter 1, Introduction to JMX Programming for Message Queue Clients |
Introduces the basic concepts and principles of the Message Queue JMX interface. |
Provides code examples showing how to use the JMX application programming interface from within your Message Queue client applications. |
|
Provides detailed information on the attributes, operations, and notifications provided by Message Queue managed beans (MBeans). |
|
Lists the MBean attributes, operations, and notifications alphabetically, with references back to their descriptions in the body of the manual. |
This section describes the following conventions used in Message Queue documentation:
The following table describes the typographic conventions that are used in this book.
Table P–2 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 |
What you type, 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 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. |
The following table explains symbols that might be used in this book.
Table P–3 Symbol Conventions
Symbol |
Description |
Example |
Meaning |
---|---|---|---|
[ ] |
Contains optional arguments and command options. |
ls [-l] |
The -l option is not required. |
{ | } |
Contains 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 com.sun.javaRoot variable. |
- |
Joins simultaneous multiple keystrokes. |
Control-A |
Press the Control key while you press the A key. |
+ |
Joins consecutive multiple keystrokes. |
Ctrl+A+N |
Press the Control key, release it, and then press the subsequent keys. |
-> |
Indicates menu item selection in a graphical user interface. |
File -> New -> Templates |
From the File menu, choose New. From the New submenu, choose Templates. |
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.
Table P–4 Shell Prompt Conventions
Shell |
Prompt |
---|---|
C shell on UNIX, Linux, or AIX |
machine-name% |
C shell superuser on UNIX, Linux, or AIX |
machine-name# |
Bourne shell and Korn shell on UNIX, Linux, or AIX |
$ |
Bourne shell and Korn shell superuser on UNIX, Linux, or AIX |
# |
Windows command line |
C:\> |
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.
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:
The documents that constitute 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 Oracle GlassFish Server documentation web site at
Table P–6 Message Queue Documentation Set
Document |
Audience |
Description |
---|---|---|
Developers and administrators |
Describes Message Queue concepts, features, and components. |
|
Developers and administrators |
Includes descriptions of new features, limitations, and known bugs, as well as technical notes. |
|
Administrators, also recommended for developers |
Provides background and information needed to perform administration tasks using Message Queue administration tools. |
|
Oracle GlassFish Message Queue 4.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. |
Oracle GlassFish Message Queue 4.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). |
Oracle GlassFish Message Queue 4.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. |
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
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.
Table P–7 JavaDoc Locations
Message Queue provides a number of example client applications to assist developers.
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.
Installation Method |
Location |
---|---|
IPS image |
IMQ_HOME/examples [IMQ_HOME is the Message Queue home directory.] |
Solaris SVR4 packages |
/usr/demo/imq |
Linux RPM packages |
/opt/sun/mq/examples |
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.
Installation Method |
Location |
---|---|
IPS image |
IMQ_HOME/examples/C [IMQ_HOME is the Message Queue home directory.] |
Solaris SVR4 packages |
/opt/SUNWimq/demo/C |
Linux RPM packages |
/opt/sun/mq/examples/C |
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 is available for the Message Queue command line utilities; for details, see Chapter 16, Command Line Reference 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.
The Oracle web site provides information about the following additional resources:
Besides searching Oracle 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 Oracle web sites in your search (for example, java.sun.com and developers.sun.com), use “sun.com” in place of “docs.sun.com” in the search field.
Where relevant, this manual refers to third-party URLs that provide additional, related information.
Oracle is not responsible for the availability of third-party Web sites mentioned in this manual. Oracle 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. Oracle 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.