JavaScript is required to for searching.
Skip Navigation Links
Exit Print View
Oracle GlassFish Server Message Queue 4.5 Administration Guide
search filter icon
search icon

Document Information

Preface

Part I Introduction to Message Queue Administration

1.  Administrative Tasks and Tools

2.  Quick-Start Tutorial

Part II Administrative Tasks

3.  Starting Brokers and Clients

4.  Configuring a Broker

5.  Managing a Broker

6.  Configuring and Managing Connection Services

7.  Managing Message Delivery

8.  Configuring Persistence Services

9.  Configuring and Managing Security Services

10.  Configuring and Managing Broker Clusters

11.  Managing Administered Objects

12.  Configuring and Managing Bridge Services

13.  Monitoring Broker Operations

14.  Analyzing and Tuning a Message Service

15.  Troubleshooting

Part III Reference

16.  Command Line Reference

17.  Broker Properties Reference

18.  Physical Destination Property Reference

19.  Administered Object Attribute Reference

20.  JMS Resource Adapter Property Reference

21.  Metrics Information Reference

22.  JES Monitoring Framework Reference

Part IV Appendixes

A.  Distribution-Specific Locations of Message Queue Data

B.  Stability of Message Queue Interfaces

C.  HTTP/HTTPS Support

D.  JMX Support

E.  Frequently Used Command Utility Commands

Index

Preface

This Oracle GlassFish Server Message Queue 4.5 Administration Guide provides background and information needed by system administrators to set up and manage an Oracle GlassFish Server Message Queue messaging system.

This preface consists of the following sections:

Who Should Use This Book

This guide is intended for administrators and application developers who need to perform Message Queue administrative tasks. A Message Queue administrator is responsible for setting up and managing a Message Queue messaging system, especially the message broker at the heart of the system.

Before You Read This Book

Before reading this guide, you should read the Oracle GlassFish Server Message Queue 4.5 Technical Overview to become familiar with the Message Queue implementation of the Java Message Service specification, with the components of the Message Queue service, and with the basic process of developing, deploying, and administering a Message Queue application.

How This Book Is Organized

Table P-1 describes the contents of this manual.

Table P-1 Book Contents

Chapter/Appendix
Description
Introduces Message Queue administrative tasks and tools.
Provides a hands-on tutorial to acquaint you with the Message Queue Administration Console.
Describes how to start the Message Queue broker and clients.
Describes how configuration properties are set and read, and gives an introduction to the configurable aspects of the broker.
Describes broker management tasks.
Describes configuration and management tasks relating to the broker's connection services.
Describes how to create and manage physical destinations and manage other aspects of message delivery.
Describes how to set up a file-based or JDBC-based data store to perform persistence services.
Describes security-related tasks, such as managing password files, authentication, authorization, and encryption.
Describes how to set up and manage a cluster of Message Queue brokers.
Describes the object store and shows how to perform tasks related to administered objects (connection factories and destinations).
Describes how to set up and manage The JMS and STOMP bridge services.
Describes how to set up and use Message Queue monitoring facilities.
Describes techniques for analyzing and optimizing message service performance.
Provides suggestions for determining the cause of common Message Queue problems and the actions you can take to resolve them.
Provides syntax and descriptions for Message Queue command line utilities.
Describes the configuration properties of Message Queue message brokers.
Describes the configuration properties of physical destinations.
Describes the configuration properties of administered objects (connection factories and destinations).
Describes the configuration properties of the Message Queue Resource Adapter for use with an application server.
Describes the metric information that a Message Queue message broker can provide for monitoring, turning, and diagnostic purposes. .
Lists Message Queue attributes that are accessible by means of the Java Enterprise System Monitoring Framework (JESMF).
Lists the locations of Message Queue files and provides information about the location of Message Queue files in previous releases.
Describes the stability of various Message Queue interfaces.
Describes how to set up and use the Hypertext Transfer Protocol (HTTP) for Message Queue communication.
Describes Message Queue’s administrative support for client programs using the Java Management Extensions (JMX) application programming interface
Lists some frequently used Message Queue Command utility (imqcmd) commands.

Documentation Conventions

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

Typographic Conventions

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.

Symbol Conventions

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.

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.

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:\>

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

Variable
Description
IMQ_HOME
The Message Queue home directory:
  • For installations of Message Queue bundled with GlassFish Server, IMQ_HOME is as-install-parent/mq, where as-install-parent is the parent directory of the GlassFish Server base installation directory, glassfish3 by default.

  • For installations of Open Message Queue, IMQ_HOME is mqInstallHome/mq.

IMQ_VARHOME
The directory in which Message Queue temporary or dynamically created configuration and data files are stored; IMQ_VARHOME can be explicitly set as an environment variable to point to any directory or will default as described below:
  • For installations of Message Queue bundled with GlassFish Server, IMQ_VARHOME defaults to as-install-parent/glassfish/domains/domain1/imq.

  • For installations of Open Message Queue, IMQ_HOME defaults to mqInstallHome/var/mq.

IMQ_JAVAHOME
An environment variable that points to the location of the Java runtime environment (JRE) required by Message Queue executable files. By default, Message Queue looks for and uses the latest JDK, but you can optionally set the value of IMQ_JAVAHOME to wherever the preferred JRE resides.

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

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

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.
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.
Developers
Provides programming and reference documentation for developers of C client programs using the Message Queue C implementation of the JMS API (C-API).
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

JavaDoc

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.

Example Client Applications

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

Example Java Client Applications

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 Programs

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 JMX Client Programs

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

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.

Documentation, Support, and Training

The Oracle 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 - 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.