Preface
This book explains how to install Sun Java System Message Queue 3 2005Q1 (3.6), Platform Edition (formerly Sun ONE Message Queue).
This preface contains the following sections:
Who Should Use This Book
The audience for this guide is Sun Java System Message Queue developers and administrators. This book has some fundamental information that users should be able to use installing either Enterprise Edition or Platform Edition. For reference information such as installed images, Enterprise Edition users should refer to this book.
Before You Read This Book
You should read the Message Queue Release Notes for hardware and software requirements for your platform, and for information on supported third-party software components. The Message Queue Release Notes also describe new features and enhancements, known issues and limitations, and other information related to this release of Message Queue.
How This Book Is Organized
All users should read the introduction and then the appropriate platform-specific chapter. Table 1 briefly describes the contents of each chapter:
Table 1 Book Contents
Chapter
|
Description
|
Chapter 1, "Introduction"
|
Explains the Message Queue editions, the Message Queue software modules, and the installed directory structure, as well as compatibility issues for those upgrading from a previous Message Queue release.
|
Chapter 2, "Solaris Installation"
|
Explains the hardware and software requirements, defaults, and installation procedure for Solaris, as well as how to uninstall the product on this platform.
|
Chapter 3, "Linux Installation"
|
Explains the hardware and software requirements, defaults, and installation procedure for Linux, as well as how to uninstall the product on this platform.
|
Conventions Used In This Book
This section provides information about the conventions used in this document.
Text Conventions
Table 2 Document Conventions
Format
|
Description
|
italics
|
Italicized text represents a placeholder. Substitute an appropriate clause or value where you see italic text. Italicized text is also used to designate a document title, for emphasis, or for a word or phrase being introduced.
|
monospace
|
Monospace text represents example code, commands that you enter on the command line, directory, file, or path names, error message text, class names, method names (including all elements in the signature), package names, reserved words, and URLs.
|
[]
|
Square brackets to indicate optional values in a command line syntax statement.
|
ALL CAPS
|
Text in all capitals represents file system types (GIF, TXT, HTML and so forth), environment variables (IMQ_HOME), or acronyms (JDK, JSP).
|
Key+Key
|
Simultaneous keystrokes are joined with a plus sign: Ctrl+A means press both keys simultaneously.
|
Key-Key
|
Consecutive keystrokes are joined with a hyphen: Esc-S means press the Esc key, release it, then press the S key.
|
Directory Variable Conventions
Message Queue makes use of three directory variables; how they are set varies from platform to platform. Table 3 describes these variables and summarizes how they are used on the Solaris, Windows, and Linux platforms.
Table 3 Message Queue Directory Variables
Variable
|
Description
|
IMQ_HOME
|
This is generally used in Message Queue documentation to refer to the Message Queue base directory (root installation directory):
- On Solaris and Linux, there is no root Message Queue installation directory. Therefore, IMQ_HOME is not used in Message Queue documentation to refer to file locations on Solaris and Linux.
- On Windows, the root Message Queue installation directory is set by the Message Queue installer (by default, as C:\Sun\MessageQueue).
- On Windows, for Sun Java System Application Server, the root Message Queue installation directory is /imq under the Application Server base directory.
|
IMQ_VARHOME
|
This is the /var directory in which Message Queue temporary or dynamically-created configuration and data files are stored. It can be set as an environment variable to point to any directory.
- On Solaris, IMQ_VARHOME defaults to the /var/imq directory.
- On Solaris, for Sun Java System Application Server, Evaluation Edition, IMQ_VARHOME defaults to the IMQ_HOME/var directory.
- On Linux, IMQ_VARHOME defaults to the /var/opt/sun/mq directory
- On Windows IMQ_VARHOME defaults to the IMQ_HOME\var directory.
- On Windows, for Sun Java System Application Server, IMQ_VARHOME defaults to the IMQ_HOME\var directory.
|
IMQ_JAVAHOME
|
This is an environment variable that points to the location of the Java runtime (JRE) required by Message Queue executables:
- On Solaris, IMQ_JAVAHOME looks for the java runtime in the following order, but a user can optionally set the value to wherever the required JRE resides.
Solaris 8 or 9: /usr/jdk/entsys-j2se /usr/jdk/jdk1.5.* /usr/jdk/j2sdk1.5.* /usr/j2se Solaris 10: /usr/jdk/entsys-j2se /usr/java /usr/j2se
- On Linux, Message Queue first looks for the java runtime in the following order, but a user can optionally set the value of IMQ_JAVAHOME to wherever the required JRE resides.
/usr/jdk/entsys-j2se /usr/java/jre1.5.* /usr/java/jdk1.5.* /usr/java/jre1.4.2* /usr/java/j2sdk1.4.2*
- On Windows, IMQ_JAVAHOME will be set to point to an existing Java runtime in C:\Program Files\Java if a supported version is found. If a supported version is not found, then one will be installed.
|
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 (/).
Related Documentation
In addition to this guide, Message Queue provides additional documentation resources.
The Message Queue Documentation Set
The documents that comprise the Message Queue documentation set are listed in Table 4 in the order in which you would normally use them.
Table 4 Message Queue Documentation Set
Document
|
Audience
|
Description
|
Message Queue Installation Guide
|
Developers and administrators
|
Explains how to install Message Queue software on Solaris and 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
|
Describes Message Queue concepts, features, and components.
|
Message Queue 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.
|
Message Queue Administration Guide
|
Administrators, also recommended for developers
|
Provides background and information needed to perform administration tasks using Message Queue administration tools.
|
Message Queue 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).
|
Online Help
Message Queue 3 2005Q1 includes command-line utilities for performing Message Queue message service administration tasks. To access the online help for these utilities, see the Message Queue Administration Guide.
Message Queue 3 2005Q1 also includes a graphical user interface (GUI) administration tool, the Administration Console (imqadmin). Context sensitive online help is included in the Administration Console.
JavaDoc
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 such as Netscape or Internet Explorer. It includes standard JMS API documentation as well as Message Queue-specific APIs for Message Queue administered objects (see Chapter 3 of the Message Queue Developer’s Guide for Java Clients), which are of value to developers of messaging applications.
Example Client Applications
Message Queue provides a number of example client applications to assist developers.
Example Java Client Applications
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
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 Java Message Service (JMS) Specification
The JMS specification can be found at the following location:
The specification includes sample client code.
Related Third-Party Web Site References
Third-party URLs are referenced in this document and provide additional, related information.
|
Note
|
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 by or in connection with the use of or reliance on any such content, goods, or services that are available on or through such sites or resources.
|
|
Sun Welcomes Your Comments
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 document title and part number. The part number is a seven-digit or nine-digit number that can be found on the title page of the book or at the top of the document.