|Skip Navigation Links|
|Exit Print View|
|Oracle GlassFish Server Message Queue 4.5 Developer's Guide for JMX Clients|
This Developer's Guide for JMX Clients describes the application programming interface provided in Oracle GlassFish Server 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
Table P-1 describes the contents of this manual.
Table P-1 Book Contents
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
The following table explains symbols that might be used in this book.
Table P-3 Symbol 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.
Table P-4 Shell Prompt 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. Some of these variables refer to the directory mqInstallHome, which is the directory where Message Queue is installed to when using the installer or unzipped to when using a zip-based distribution.
Note - 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.
Table P-5 Directory Variable Conventions
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 Server documentation web site at
Table P-6 Message Queue Documentation Set
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 Message Queue installations at IMQ_HOME/javadoc/index.html. This documentation can be viewed in any HTML browser. It includes standard JMS API documentation as well as Message Queue–specific APIs.
Message Queue provides a number of example client applications to assist developers.
Example Java client applications are included in Message Queue installations at IMQ_HOME/examples. See the README files located in this directory and its subdirectories for descriptive information about the example applications.
Example C client applications are included in Message Queue installations at IMQ_HOME/examples/C. See the README files located in this directory and its subdirectories for descriptive information about the example applications.
Example Java Management Extensions (JMX) client applications are included in Message Queue installations at IMQ_HOME/examples/jmx. See the README files located in this directory and its 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, in Oracle GlassFish Server Message Queue 4.5 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 Oracle GlassFish Server Message Queue 4.5 Administration Guide.
The Oracle web site provides information about the following additional resources:
Where relevant, this manual refers to third-party URLs that provide additional, related information.
Note - 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.