Previous Contents Next |
Sun Java System Message Queue 3.5 SP1 Installation Guide

> ## Preface

> This book explains how to install Sun Java™ System Message Queue 3.5 SP1 (formerly Sun™ ONE Message Queue), and this preface contains the following sections:

> - Audience for This Guide
> - Organization of This Guide
> - Conventions
> - Other Documentation Resources

> ##

> Audience for This Guide

> The audience for this guide is Sun Java System Message Queue 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 Message Queue editions, supported platforms and products, the Message Queue 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, 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 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, 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. On Windows, the root Message Queue installation directory is set by the Message Queue installer (by default, as C:\Program Files\Sun\MessageQueue3). On Windows, for Sun Java System Application Server, the root Message Queue installation directory is /imq under the Application Server base directory. On 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 Linux.
> 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 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. On Linux, IMQ_VARHOME defaults to the /var/opt/imq 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 defaults to the /usr/j2se/jre directory, but a user can optionally set the value to wherever the required JRE resides. On Windows, IMQ_JAVAHOME defaults to IMQ_HOME\jre, but a user can optionally set the value to wherever the required JRE resides. On Linux, Message Queue first looks for the java runtime in the /usr/java/j2sdk Version directory, and then looks in the /usr/java/j2re Version directory, but a user can optionally set the value of IMQ_JAVAHOME to wherever the required JRE 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). Path names generally use UNIX directory separator notation (/).

> ##

> Other Documentation Resources

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

> ### 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/imq/demo/
> 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/imq/demo/C/
> Windows | IMQ_HOME\demo\C\

> Previous Contents Next

> Copyright 2004 Sun Microsystems, Inc. All rights reserved.