Sun Java System Message Queue 4.3 Installation Guide

Preface

This Sun Java^TM System Message Queue 4.3 Installation Guide provides instructions and general information needed to install the Sun Java System Message Queue 4.3 product.

This preface consists of the following sections:

Who Should Use This Book

This manual is intended for Message Queue administrators and application developers. Sun Java Enterprise System (JES) users may also need to refer to it for reference information about installed images.

Before You Read This Book

Before reading this manual, you should read the Message Queue Technical Overview, which describes the concepts, features, and components of Message Queue and the Message Queue Release Notes, which describe new features and enhancements, known issues and limitations, and other information related to the current Message Queue release.

How This Book Is Organized

Table P–1 describes the contents of this manual. All readers should read Chapter 1, Introduction, followed by the chapter pertaining to their own particular platform.

Table P–1 Contents of This Manual


Chapter/Appendix	Description
Chapter 1, Introduction	Describes Message Queue product editions, software modules, and supported platforms and components, as well as migration issues for those upgrading from a previous Message Queue release.
Chapter 2, Solaris Installation	Provides detailed instructions for installing and uninstalling Message Queue 4.3 on the Solaris platform, along with information on hardware requirements, package dependencies, installed directory structure, and the use of Solaris 10 zones to maintain multiple Message Queue installations.
Chapter 3, Linux Installation	Provides detailed instructions for installing and uninstalling Message Queue 4.3 on the Linux platform, along with information on hardware requirements, package (RPM) dependencies, and installed directory structure.
Chapter 4, AIX Installation	Provides detailed instructions for installing and uninstalling Message Queue 4.3 on the AIX platform, along with information on hardware requirements and installed directory structure.
Chapter 5, Windows Installation	Provides detailed instructions for installing and uninstalling Message Queue 4.3 on the Windows platform, along with information on hardware requirements and installed directory structure.
Appendix A, Command Line Options	Describes the command line options available for the Message Queue Installer.

Documentation Conventions

This section describes the following conventions used in Message Queue documentation:

Typographic Conventions

The following table describes the typographic conventions that are used in this book.

Table P–2 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.

Symbol Conventions

The following table explains symbols that might be used in this book.

Table P–3 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.

Shell Prompt Conventions

The following table shows the conventions used in Message Queue documentation for the default UNIX® system prompt and superuser prompt for the C shell, Bourne shell, Korn shell, and for the Windows operating system.

Table P–4 Shell PromptConventions


Shell	Prompt
C shell on UNIX, Linux, or AIX	`machine-name%`
C shell superuser on UNIX, Linux, or AIX	`machine-name#`
Bourne shell and Korn shell on UNIX, Linux, or AIX	`$`
Bourne shell and Korn shell superuser on UNIX, Linux, or AIX	`#`
Windows command line	`C:\>`

Directory Variable Conventions

Message Queue documentation makes use of three directory variables; two of which represent environment variables needed by Message Queue. (How you set the environment variables varies from platform to platform.)

The following table describes the directory variables that might be found in this book and how they are used on the Solaris, Linux, AIX, and Windows platforms. On AIX and Windows, Message Queue is installed in a directory referred to as mqInstallHome, and some of the directory variables in Table P–5 reference this mqInstallHome directory.

Note –

In this book, directory variables are shown without platform-specific environment variable notation or syntax (such as $IMQ_HOME on UNIX). Non-platform-specific path names use UNIX directory separator (/) notation.

Table P–5 Directory Variable Conventions


Variable	Description
`IMQ_HOME`	Message Queue home directory, if any: Unused on Solaris and Linux; because there is no `mqInstallHome` directory on these platforms, there is no corresponding Message Queue home directory. On AIX, `IMQ_HOME` denotes the directory `mqInstallHome/mq`, where `mqInstallHome` is specified when you install the product (by default, `home-directory/MessageQueue`). On Windows, `IMQ_HOME` denotes the directory `mqInstallHome\mq`, where `mqInstallHome` is specified when you install the product (by default, `C:\Program Files\Sun\MessageQueue`). Note – The information above applies only to the standalone installation of Message Queue. When Message Queue is installed and run as part of a Sun Java System Application Server installation, `IMQ_HOME` is set to `appServerInstallDir/imq`, where `appServerInstallDir` is the Application Server installation directory.
`IMQ_VARHOME`	Directory in which Message Queue temporary or dynamically created configuration and data files are stored; `IMQ_VARHOME` can be explicitly set as an environment variable to point to any directory or will default as described below: On Solaris, `IMQ_VARHOME` defaults to `/var/imq`. On Linux, `IMQ_VARHOME` defaults to `/var/opt/sun/mq`. On AIX, `IMQ_VARHOME` defaults to `mqInstallHome/var/mq`. On Windows, `IMQ_VARHOME` defaults to `mqInstallHome\var\mq`. Note – The information above applies only to the standalone installation of Message Queue. When Message Queue is installed and run as part of a Sun Java System Application Server installation, `IMQ_VARHOME` is set to `appServerDomainDir/imq`, where `appServerDomainDir` is the domain directory for the domain starting the Message Queue broker.
`IMQ_JAVAHOME`	An environment variable that points to the location of the Java runtime environment (JRE) required by Message Queue executable files: On Solaris, Message Queue looks for the latest JDK, but you can optionally set the value of `IMQ_JAVAHOME` to wherever the preferred JRE resides. On Linux, Message Queue looks for the latest JDK, but you can optionally set the value of `IMQ_JAVAHOME` to wherever the preferred JRE resides. On AIX, `IMQ_JAVAHOME` is set to point to an existing Java runtime when you perform Message Queue installation. On Windows, `IMQ_JAVAHOME` is set to point to an existing Java runtime if a supported version is found on the system when you perform Message Queue installation. If a supported version is not found, one will be installed.

Related Documentation

The information resources listed in this section provide further information about Message Queue in addition to that contained in this manual. The section covers the following resources:

Message Queue Documentation Set

The documents that comprise the Message Queue documentation set are listed in the following table in the order in which you might normally use them. These documents are available through the Sun documentation Web site at

http://www.sun.com/documentation/

Click “Software,” followed by “Application & Integration Services,” and then “Message Queue.”

For a content reference to topics with the Message Queue documentation set, see the Message Queue Documentation Center at the above location.

Table P–6 Message Queue Documentation Set


Document	Audience	Description
Sun Java System Message Queue 4.3 Technical Overview	Developers and administrators	Describes Message Queue concepts, features, and components.
Sun Java System Message Queue 4.3 Release Notes	Developers and administrators	Includes descriptions of new features, limitations, and known bugs, as well as technical notes.
Sun Java System Message Queue 4.3 Installation Guide	Developers and administrators	Explains how to install Message Queue software on Solaris, Linux, AIX, and Windows platforms.
Sun Java System Message Queue 4.3 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.
Sun Java System Message Queue 4.3 Administration Guide	Administrators, also recommended for developers	Provides background and information needed to perform administration tasks using Message Queue administration tools.
Sun Java System Message Queue 4.3 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).
Sun Java System Message Queue 4.3 Developer’s Guide for JMX Clients	Administrators	Provides programming and reference documentation for developers of JMX client programs using the Message Queue JMX API.

Java Message Service (JMS) Specification

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

http://java.sun.com/products/jms/docs.html

JavaDoc

JMS and Message Queue API documentation in JavaDoc format is included in your Message Queue installation at the locations shown in Table P–7, 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–7 JavaDoc Locations


Platform	Location
Solaris	`/usr/share/javadoc/imq/index.html`
Linux	`/opt/sun/mq/javadoc/index.html`
AIX	`IMQ_HOME/javadoc/index.html` [`IMQ_HOME` is the Message Queue home directory.]
Windows	`IMQ_HOME\javadoc\index.html`

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 files located in these directories and their subdirectories for descriptive information about the example applications.

Platform	Location
Solaris	`/usr/demo/imq/`
Linux	`/opt/sun/mq/examples`
AIX	`IMQ_HOME/demo/` [`IMQ_HOME` is the Message Queue home directory.]
Windows	`IMQ_HOME\demo\`

Example C Client Programs

Example C client applications are located in the following directories, depending on platform. See the README files located in these directories and their subdirectories for descriptive information about the example applications.

Platform	Location
Solaris	`/opt/SUNWimq/demo/C/`
Linux	`/opt/sun/mq/examples/C/`
AIX	`IMQ_HOME/demo/C/` [`IMQ_HOME` is the Message Queue home directory.]
Windows	`IMQ_HOME\demo\C\`

Example JMX Client Programs

Example Java Management Extensions (JMX) client applications are located in the following directories, depending on platform. See the README files located in these directories and their subdirectories for descriptive information about the example applications.

Platform	Location
Solaris	`/opt/SUNWimq/demo/imq/jmx`
Linux	`/opt/sun/mq/examples/jmx`
AIX	`IMQ_HOME/demo/jmx` [`IMQ_HOME` is the Message Queue home directory.]
Windows	`IMQ_HOME\demo\jmx`

Online Help

Online help is available for the Message Queue command line utilities; for details, see Chapter 15, Command Line Reference, in Sun Java System Message Queue 4.3 Administration Guide for details. The Message Queue graphical user interface (GUI) administration tool, the Administration Console, also includes a context-sensitive help facility; see the section “Administration Console Online Help” in Chapter 2, Quick-Start Tutorial, in Sun Java System Message Queue 4.3 Administration Guide.

Documentation, Support, and Training

The Sun Web site provides information about the following additional resources:

Third-Party Web Site References

Where relevant, this manual refers to third-party URLs that provide additional, related information.

Note –

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.

Searching Sun Product Documentation

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.

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 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 820-6361.