Preface
This book explains how to install Sun™ ONE Message Queue (MQ) 3.0, and this preface contains the following sections:
Audience for This Guide
The audience for this guide is MQ developers and administrators.
Organization of This Guide
All users should read the introduction and then the appropriate platform-specific chapter. The following table briefly describes the contents of each chapter:
Table 1 Book Contents
|
Chapter
|
Description
|
|
Chapter 1 "Introduction
|
Explains the MQ editions, supported platforms and products, the MQ software modules, and the installed directory structure.
|
|
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.
|
|
Chapter 4 "Windows Installation
|
Explains the hardware and software requirements, defaults, and installation procedure for Windows (2000 and XP), as well as how to uninstall the product on this platform.
|
Conventions
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 URL's.
|
[]
|
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 (MQ, 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.
|
Environment Variable Conventions
MQ makes use of three environment variables—but how they are used varies from platform to platform. Table 3 describes these environment variables and summarizes how they are used on the Solaris, Windows, and Linux platforms.
Table 3 MQ Environment Variables
|
Environment Variable
|
Description
|
|
IMQ_HOME
|
This is generally the root MQ installation directory in which all installed files are placed:
On Solaris, there is no root MQ installation directory. IMQ_HOME is not used by MQ software and is not used in MQ documentation to refer to file locations on Solaris.
On Solaris, for Sun ONE Application Server, Evaluation Edition, IMQ_HOME is not used by MQ software, but is used in MQ documentation to refer to the root MQ installation directory (an imq subdirectory under the Application Server installation root directory).
On Windows, IMQ_HOME is used by MQ software and is also used in MQ documentation to refer to the root MQ installation directory. The value of IMQ_HOME is set by the MQ installer (by default, as C:\Program Files\Sun Microsystems\Message Queue 3.0).
On Linux, IMQ_HOME is not used by MQ software, but is used in MQ documentation to refer to the root MQ installation directory (by default, an imq subdirectory under /opt).
|
|
IMQ_VARHOME
|
This refers to the /var directory in which MQ temporary or dynamically-created configuration and data files are stored:
On Solaris, IMQ_VARHOME defaults to the /var/imq directory, but a user can optionally set the value to any directory.
On Solaris, for Sun ONE Application Server, Evaluation Edition, IMQ_VARHOME defaults to IMQ_HOME/var, but a user can optionally set the value to any directory.
On Windows IMQ_VARHOME defaults to IMQ_HOME/var, but a user can optionally set the value to any directory.
On Linux, IMQ_VARHOME defaults to IMQ_HOME/var, but a user can optionally set the value to any directory.
|
|
IMQ_JAVAHOME
|
This refers to the location of the Java runtime (JRE 1.4) required by MQ executables:
On Solaris, IMQ_JAVAHOME defaults to the /usr/j2se/jre directory, but a user can optionally set the value to wherever JRE 1.4 resides.
On Windows, IMQ_JAVAHOME defaults to IMQ_HOME/jre, but a user can optionally set the value to wherever JRE 1.4 resides.
On Linux, IMQ_JAVAHOME defaults to the /usr/java/j2sdk1.0/jre directory, but a user can optionally set the value to wherever JRE 1.4 resides.
|
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). All path names use UNIX file separator notation (/).
Other Documentation Resources
In addition to this guide, MQ provides additional documentation resources.
The MQ Documentation Set
The documents that comprise the MQ documentation set are listed in Table 4 in the order in which you would normally use them.
Table 4 MQ Documentation Set
|
Document
|
Audience
|
Description
|
|
MQ Installation Guide
|
Developers and administrators
|
Explains how to install MQ software on Solaris, Linux, and Windows platforms.
|
|
Release Notes
|
Developers and administrators
|
Includes descriptions of new features, limitations, and known bugs, as well as technical notes.
|
|
MQ Developer's Guide
|
Developers
|
Provides a quick-start tutorial and programming information relevant to the MQ implementation of JMS.
|
|
MQ Administrator's Guide
|
Administrators, also recommended for developers
|
Provides background and information needed to perform administration tasks using MQ administration tools.
|
Example Client Applications
A number of example applications that provide sample client application code are included in the following location:
-
IMQ_HOME/demo (/usr/demo/imq on Solaris)
See the README file located in that directory and in each of its subdirectories.
Previous
Contents
Next