This Sun JavaTM System Message Queue 4.1 Administration Guide provides background and information needed by system administrators to set up and manage a Sun Java System Message Queue messaging system.
This preface consists of the following sections:
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 reading this guide, you should read the Sun Java System Message Queue 4.1 Technical Overview to become familiar with Message Queue’s 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.
Table P–1 describes the contents of this manual.
Table P–1 Contents of This Manual
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. Also describes how to set up a file or database to perform persistence functions. |
|
Describes broker management tasks. |
|
Describes management tasks relating to physical destinations. |
|
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 a cluster of Message Queue brokers. |
|
Describes security-related tasks, such as managing password files, authentication, authorization, and encryption. |
|
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). |
|
Appendix A,“ Platform-Specific Locations of Message Queue Data” |
Lists the locations of Message Queue files on each supported platform. |
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. |
This section describes various conventions used in Message Queue documentation.
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, 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. |
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. |
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 SolarisTM, Linux, and Windows platforms.
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.
The information resources listed in this section provide further information about Message Queue in addition to that contained in this manual.
Table P–5 lists the documents in the Message Queue documentation set, in the order in which you would normally use them. These documents are available through the Sun documentation Web site at
Click “Sun Java Systems,” followed by “Software,” “Application & Integration Services,” and then “Message Queue.”
Table P–5 Message Queue Documentation Set
Document |
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 by system administrators to set up and manage a Message Queue messaging system |
Message Queue Developer’s Guide for Java Clients |
Developers |
Provides information on developing Java client programs using Message Queue's Java application programming interface |
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) |
Message Queue Developer’s Guide for JMX Clients |
Developers |
Provides information on developing Java client programs using the Message Queue implementation of the Java Management Extensions (JMX) application programming interface |
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–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 providing sample application code are included in your Message Queue installation at the locations shown in Table P–7, depending on your platform. The README files located in these directories and their subdirectories provide descriptive information about the example applications.
Table P–7 Code Example Locations
Platform |
Location |
---|---|
Solaris |
/usr/demo/imq (Java examples) /opt/SUNWimq/demo (C examples) |
Linux |
/opt/sun/mq/examples |
Windows |
IMQ_HOME\demo where IMQ_HOME is the Message Queue home directory |
Online help is available for the Message Queue command line utilities; see Chapter 13, 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 Administration Console Online Help.
The Sun Web site provides information about the following additional resources:
Where relevant, this manual refers to third-party URLs that provide additional, related information.
Sun is not responsible for the availability of third-party Web sites mentioned in this manual. Sun 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. 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 the use of or reliance on any such content, goods, or services available on or through such sites or resources.
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
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-4467.)