Sun logo      Previous      Contents     

Sun ONE Message Queue 3.5 Installation Guide

Chapter 4
Windows Installation

This chapter explains the following topics as they apply to a Windows installation:


Hardware and Software Requirements

At a minimum, your Windows system should satisfy the requirements indicated in the following table.

Table 4-1  Hardware and Software Requirements for Windows 

Component

Requirements

Operating system

Windows XP Professional, 2000 Professional SP3, 2000 Advanced Server SP3, .NET Server 2003 Enterprise Edition

CPU

Intel Pentium 2

RAM

256 Mbytes

Disk space

The self-extracting installation file is approximately 25 Mbytes.

The temporary directory used for extracting the installation files requires an additional 45 Mbytes.

The installed product requires approximately 45 Mbytes. MQ, however, may need more space if the broker stores persistent messages locally.

Java 2 Standard Edition (J2SE)

See Table 1-1 for the supported versions of the Java Runtime Environment (JRE) and Java Software Development Kit (JDK) that are supported on Windows.

The MQ installation program will (optionally) install the required JRE version in IMQ_HOME\jre.


Installing MQ on Windows

The Sun ONE Message Queue product can be downloaded from the Sun ONE website or installed from the product CD-ROM.

The following instructions explain how to install the MQ product either by downloading from the Sun ONE website or using the CD-ROM.


Note

If you are upgrading from MQ 3.0.x versions, it is recommended that you first uninstall MQ software as described in the MQ Installation Guide of the appropriate version, before installing MQ 3.5.

If you are upgrading from MQ 2.0, it is recommended that you first uninstall MQ 2.0 software, as described in the MQ 2.0 Installation Guide, before installing MQ 3.5. Also check the MQ 3.0.1 Release Notes for information about migrating any existing MQ 2.0 data you wish to preserve.

If you are installing MQ after a previous uninstall, check that any references to the previous MQ installation have been removed from the system’s PATH environment variable.


Installed Directory Structure

The install image below reflects a full (“Typical”) Windows installation. This image might vary if you perform a partial installation.


Note

File locations for MQ bundled with Sun ONE Application Server, may differ from locations specified in Table 4-2.


Table 4-2  Installed Directory Structure: Windows 

Windows1

Contents

.\COPYRIGHT.TXT

Copyright text file

.\LICENSE.TXT

License text file

.\LICENSEREADME\THIRDPARTY-
LICENSEREADME.TXT

License for third party software distributed by MQ: DOM4J, Apache Commons Logging

.\README.TXT

README text file

.\bin\

On Windows, the executable files have a .exe filename extension. This directory also includes the utility to install and uninstall the broker as a Windows Service (imqsvcadmin) as well other executables (imqbrokersvc).

Contains the executables for the broker (imqbrokerd) and the following MQ administration tools:

  • Administration Console (imqadmin)
  • Command (imqcmd)
  • Object Manager (imqobjmgr)
  • User Manager (imqusermgr)
  • Database Manager (imqdbmgr)
  • Key Tool (imqkeytool)

.\lib\

Contains files that support the MQ Java client runtime:

/*.jar  jar files used to build and run Java JMS client applications

/*.war  war files used for HTTP servlet deployment

/*.rar  rar files used for MQ resource adapter

.\lib\

Contains files used to support MQ tools and processes:

/ext  location for placing files needed for plug-in persistence capability

/props  subdirectory contains the broker’s default configuration files

/help  subdirectory contains MQ help files

/images

.\etc\

Contains license files and instance template files.

.\var\

Working storage directory for MQ.

/instances  subdirectory which will contain configuration files, log files, access control files, flat-file user repository, and file-based persistent data stores for each broker instance

.\javadoc\

Contains the MQ and JMS API documentation distributed as Javadoc (HTML)

.\demo\

Source code for and instructions on how to run Java client example applications:

.\include\

Header files needed to support MQ C clients (Enterprise Edition only)

.\lib\

Libraries needed to support MQ C clients (Enterprise Edition only)2

.\demo\C\

Examples for writing C clients (Enterprise Edition only)

.\jre\

The JRE 1.4 files (on Windows only)

1. Paths are relative to IMQ_HOME (see "Directory Variable Conventions").

2. See Table 1-2 for the versions of NSPR and NSS needed to support the C-API.

Installing From CD-ROM or the Web

Follow these steps to install MQ 3.5 on Windows.

    To Install MQ on Windows
  1. Quit any other programs you are running.
  2. Download the distribution into a temporary working directory.
  3. If you are installing from CD-ROM, insert the CD into the CD-ROM drive.

  4. In the Windows Explorer, double-click the imq3_5-edition-win.exe file
  5. where edition takes one of the following values: plt or ent, depending on whether you are installing the Platform Edition or Enterprise Edition, respectively.

    The installation file is extracted and setup is launched. If you are installing from CD-ROM, the setup program is started automatically.

  6. Read the license agreement. Installation and use of the product is subject to acceptance of the license agreement.
  7. Follow the setup program’s instruction to select installation options.
    1. Select the type of installation.
      • Compact Includes only the files necessary to run the broker, administration, and client applications. No documentation or example client applications are installed.
      • Custom  Lets you specify which MQ modules you want to install. Your options include the broker, Java client runtime, administration tools, MQ resource adapter, documentation, example client applications, Java runtime, and C client runtime (Enterprise Edition).
      • Typical    Installs all files, including broker, client runtime, administration tools, documentation, example client applications, and Java runtime.
      • Upgrade Platform Edition (Enterprise Only)   Installs only the files necessary to enable Enterprise Edition features. This option does not overwrite the MQ files already installed, and does not modify the configuration of your messaging system.
    2. Select a location for the installation.
    3. Select or create a folder for the Windows Start > Programs menu.
    4. Choose whether or not to install the broker as a Windows service. If you choose to install the broker as a Windows service, the broker will be started automatically at system startup and run in the background. This option requires Windows Administrator Group privileges.
    5. If you choose not to install the broker as a Windows service now but later change your mind, you can use the imqsvcadmin utility to do so. See the MQ Administrator’s Guide for information on using the imqsvcadmin utility.

  8. Verify installation by choosing Start > Programs > Sun ONE Message Queue 3.5 >Message Broker to run the broker.
  9. You can also compile and run example applications located in the
    c:\Program Files\Sun\MessageQueue3\demo directory. See the MQ Java Client Developer’s Guide.


Installation Defaults

The following table indicates the installation defaults for Windows.

Table 4-3  Windows Installation Defaults 

Installation directory

The product is installed, by default, into the following directory:

C:\Program Files\Sun\MessageQueue3

Environment Variables

IMQ_HOME: The installer automatically sets the IMQ_HOME environment variable to the installation directory.

IMQ_VARHOME: The IMQ_VARHOME environment variable defaults to IMQ_HOME\var.

IMQ_JAVAHOME: The IMQ_JAVAHOME environment variable defaults to IMQ_HOME\jre.

PATH: The installer automatically sets PATH to %PATH%;%IMQ_HOME%\bin. This enables you to run utilities, such as imqbrokerd, imqcmd, and imqobjmgr without specifying the entire path.


Troubleshooting Installation Problems

If the MQ installation program does not complete successfully on your Windows platform, try the following remedies. These apply regardless of whether you installed the product from CD-ROM or downloaded it from the Web.

    To Troubleshoot Installation Problems on Windows
  1. Use the Windows Task Manager to end the MQ installation program.
  2. Clear any temporary directories (for example, temp or tmp).
  3. Start the MQ installation again, being certain to install to the same directory as the initial installation attempt.

If your Windows installation of the MQ product is still not successful, try this more comprehensive procedure:

  1. Use the Windows Task Manager to end the MQ installation program.
  2. Clear any temporary directories (for example, temp or tmp).
  3. In the Services control panel, temporarily stop any non-Windows network-related services (for example, a Solstice NFS Server service).
  4. Delete the Message Queue 3.0 directory and all its contents.
  5. In your Systems control panel, remove all references to MQ 3.0 from your environment settings.
  6. Restart your Windows operating system.
  7. Reinstall MQ in the same directory location as the initial failed installation.
  8. Reset any services in the Services (Control Panel) that you stopped in Step 3.


Upgrading from Platform to Enterprise Edition

MQ comes in two editions, as explained in "Product Editions".

To upgrade from the Platform Edition to the Enterprise Edition, you need to first purchase the Enterprise Edition, and then install, as described below, the Enterprise Edition license contained in the distribution, plus the C-API packages, if you wish to write C client programs. Installation of this software does not overwrite the MQ 3.5 modules already installed and does not modify the configuration of your MQ messaging system.

You can upgrade from the Platform Edition to the Enterprise Edition by installing the Enterprise Edition.

    To Upgrade to Enterprise Edition on Windows
  1. Stop any running brokers.
  2. imqcmd shutdown bkr -u name -p password [-b hostName:port]

  3. Follow the installation procedure explained in "Installing MQ on Windows." Choose the Upgrade Platform Edition option when it appears on your screen.
  4. This setup does not overwrite the MQ modules installed, and does not modify the configuration of your MQ messaging system.


Where To Go Next

Read the README and MQ Release Notes files.

For an overview of Sun ONE Message Queue concepts, a brief introduction to writing and compiling a client application, see the MQ Java Client Developer’s Guide

For details on configuring brokers and managing an MQ messaging system, see the MQ Administrator’s Guide.

For class and member information used when writing a client application, browse the API documentation in the IMQ_HOME/javadoc directory.

To uninstall the product, see the following section.


Uninstalling MQ on Windows

The following instructions explain how to uninstall MQ on Windows.

    To Remove MQ on Windows
  1. Stop any running client applications.
  2. Stop any running brokers.
  3. imqcmd shutdown bkr -u name -p password [-b hostName:port]

    If you had installed the broker as a Windows service, you can stop it as follows:

    • From the Windows Start menu, choose Settings, then Control Panel.
    • Double-click the Administrative Tools icon, then the Services icon.
    • In the Services panel, select the MQ Broker entry, then click Stop.
    • Close the Services panel.
  4. Unless you want to retain dynamic data, the MQ flat file user repository, and the MQ access control file associated with each broker instance, remove this data using the following command.
  5. imqbrokerd -name instanceName -remove instance

  6. Remove the Sun ONE Message Queue product by choosing Start > Programs > Sun ONE Message Queue 3.5 >Uninstall.
  7. After Uninstall completes, remove any leftover files.
  8. The Windows Uninstall utility does not remove files or directories created as a result of using MQ, such as instance configuration files or a flat-file data store.

  9. Manually remove MQ references from your environment.
    • From the Windows Start menu, choose Settings.
    • In the Control Panel, double-click the System icon.
    • On the Environment page, select the PATH environment variable and remove the Message Queue 3.5 reference from the value.
    • Click Set then OK.



Previous      Contents     


Copyright 2003 Sun Microsystems, Inc. All rights reserved.