This Sun Java SystemTM Message Queue Administration Guide provides background and information needed by system administrators to set up and manage a Sun Java System Message QueueTM messaging system.
This manual 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 manual, you should read the Sun Java System Message Queue 3.7 UR1 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
Part/Chapter |
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 security-related tasks, such as managing password files, authentication, authorization, and encryption. |
|
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 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. . |
|
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. |
|
Lists some frequently used Message Queue Command utility (imqcmd) commands. |
The documents that comprise the Message Queue documentation set are listed in the following table in the order in which you would normally use them.
Table P–2 Message Queue Documentation Set
Document |
Audience |
Description |
---|---|---|
Developers and administrators |
Explains how to install Message Queue software on Solaris, Linux, and Windows platforms. |
|
Developers and administrators |
Includes descriptions of new features, limitations, and known bugs, as well as technical notes. |
|
Developers and administrators |
Describes Message Queue concepts, features, and components. |
|
Sun Java System Message Queue 3.7 UR1 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. |
Administrators, also recommended for developers |
Provides background and information needed to perform administration tasks using Message Queue administration tools. |
|
Sun Java System Message Queue 3.7 UR1 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). |
Message Queue 3.7 UR1 includes command-line utilities for performing Message Queue message service administration tasks.
Message Queue 3.7 UR1 also includes a graphical user interface (GUI) administration tool, the Administration Console (imqadmin). Context-sensitive help is included in the Administration Console; see Administration Console Online Help.
JMS and Message Queue API documentation in JavaDoc format is provided at the following location:
Platform |
Location |
---|---|
Solaris |
/usr/share/javadoc/imq/index.html |
Linux |
/opt/sun/mq/javadoc/index.html |
Windows |
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 for Message Queue administered objects, which are of value to developers of messaging applications.
Message Queue provides a number of example client applications to assist developers.
Example Java client applications are located in the following directories, depending on platform. See the README file located in these directories and in each of their subdirectories.
Platform |
Location |
---|---|
Solaris |
/usr/demo/imq/ |
Linux |
/opt/sun/mq/examples |
Windows |
IMQ_HOME/demo/ |
Example C client applications are located in the following directories, depending on platform. See the README file located in these directories.
Platform |
Location |
---|---|
Solaris |
/opt/SUNWimq/demo/C/ |
Linux |
/opt/sun/mq/examples/C/ |
Windows |
IMQ_HOME/demo/C/ |
The JMS specification can be found at the following location:
The specification includes sample client code.
Message Queue makes use of three directory variables; how they are set varies from platform to platform. Table P–3 describes these variables and how they are used on the Solaris, Linux, and Windows platforms.
The information in Table P–3 applies only to the standalone installation of Message Queue. When Message Queue is installed and run as part of an Application Server installation, the values of the directory variables are set differently: IMQ_HOME is set to appServer_install_dir/imq (where appServer_install_dir is the Application Server installation directory), and IMQ_VARHOME to appServer_domainName_dir/imq (where appServer_domainName_dir is the domain directory for the domain starting the Message Queue broker.
In this guide, IMQ_HOME, IMQ_VARHOME, and IMQ_JAVAHOME are shown without platform-specific environment variable notation or syntax (for example, $IMQ_HOME on UNIX). Path names generally use UNIX directory separator notation (/).
The following table describes the typographic conventions that are used in this book.
Table P–4 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 shows the default UNIX® system prompt and superuser prompt for the C shell, Bourne shell, Korn shell, and Windows operating system.
Table P–5 Shell Prompts
Shell |
Prompt |
---|---|
C shell |
machine_name% |
C shell for superuser |
machine_name# |
Bourne shell and Korn shell |
$ |
Bourne shell and Korn shell for superuser |
# |
Windows |
C:\ |
The following table explains symbols that might be used in this book.
Table P–6 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 Sun web site provides information about the following additional resources:
Documentation (http://www.sun.com/documentation/)
Support (http://www.sun.com/support/)
Training (http://www.sun.com/training/)
Besides searching Sun 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 Sun web sites in your search (for example, java.sun.com, www.sun.com, and developers.sun.com), use “sun.com” in place of “docs.sun.com” in the search field.
Third-party URLs are referenced in this document and provide additional, related information.
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 that are available on or through such sites or resources.
Sun is interested in improving its documentation and welcomes your comments and suggestions. To share your comments, go to http://docs.sun.com and click Send Comments. In the online form, provide the full document title and part number. 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.