Chapter 6 Message Queue

This chapter describes how to upgrade Message Queue software from previous Java ES versions to Java ES 2005 (Release 4): Sun Java System Message Queue 3 Enterprise Edition 2005Q4.

The chapter provides a general overview of Message Queue upgrade issues and procedures for the different upgrade paths supported by Java ES Release 4.This chapter covers the following:


Note	Message Queue commands used in this chapter are run with respect to the directory location of executable files.

Overview of Message Queue Upgrades

This section describes the following general aspects of Message Queue that impact upgrading to Java ES 2005Q4 (Release 4):

About Java ES Release 4 Message Queue

Java ES Release 4 Message Queue represents minor code fixes with no new features or enhancements. As such, Release 4 does not introduce any new compatibility issues (see Compatibility Issues).

Message Queue software includes two editions, a Platform Edition and an Enterprise Edition, each corresponding to a different feature set and licensed capacity. Enterprise edition is for deploying and running messaging applications in an enterprise production environment. Platform Edition is mainly for developing, debugging, and load testing messaging applications and components. The Platform Edition can be downloaded free from the Sun web site and is also bundled the Java ES Application Server platform. An upgrade from an earlier Java ES release version to Release 4 converts any installed Platform Edition to Enterprise Edition.

Message Queue Upgrade Roadmap


Note	Registry entries will still show it as platform edition as registry entries are not changed by upgrade. Upgradation will only upgrade the binaries.

Table 6-1 Upgrade Paths to Java ES Release 4 Message Queue 3.6 SP3 2005Q4
Java ES Release	Message Queue Version	General Approach	Re-configuration Required
Release 3	Sun Java System Message Queue 2005Q2 (3.6) Enterprise Edition only	Direct upgrade: Performed using <patchid>.exe.	None

In addition to the Java ES releases of Message Queue shown in Table 6-1, Message Queue Platform Edition is also bundled with Windows operating system software. Upgrade of the bundled versions of Message Queue to Release 4 Enterprise Edition can be performed by installing the patch.

Message Queue Data

Message Queue, like other Java ES components, makes use of various kinds of data that for any specific upgrade might need to be migrated to an upgraded version. The following table shows the type of data that could be impacted by an upgrade of Message Queue software.

Table 6-2 shows the location of data where, InstanceName identifies the name of the Message Queue broker instance with which the data is associated and <WIN-P> is the installation of MQ. e.g <Windowsdrive>/Sun/MessageQueue.

Table 6-2 Message Queue Data Usage
Data Category	Location	Usage
Broker instance configuration properties	<WIN-P>/var/instances/instanceName/props/config.properties	Broker and related services configurations
Persistent store for dynamic application data	<WIN-P>/var/instances/instanceName/fs350or a JDBC-accessible data store	Stores messages, destinations, durable subscriptions, transactions, and other dynamic data
Administered objects (object store)	local directory of your choice or an LDAP Directory Server	Objects used to configure client/broker connections
Security: user repository	<WIN-P>/var/instances/instanceName/etc/passwd or an LDAP directory server	Stores user data used for authentication and authorization
Security: access control file (default location)	<WIN-P>/var/instances/instanceName/etc/ accesscontrol.properties	Sets the rules that authorize user access to destinations and related capabilities
Security: passfile directory (default location)	<WIN-P>/var/instances/instanceName/etc/	Stores encrypted password information.
Security: broker’s keystore file location	etc/<WIN-P>/	Stores encrypted certificate information for secure messaging.

Compatibility Issues

Release 4 Message Queue introduces no new incompatibilities over Release 3. The following general Message Queue compatibility issues relate to versions earlier than Release 3.

Protocol Compatibility

Message Queue has a dependency on a web container to provide HTTP protocol support between Message Queue clients and broker. Due to a protocol change, when using Sun Java System Web Server to provide a web container for the Message Queue imqhttp.war application, you cannot upgrade the Web Server component without also upgrading Message Queue (see Post-Upgrade Tasks.).

Broker Compatibility

You can use earlier Message Queue config.properties files. You can also copy them to another location and consult the property settings they contain when you configure Release 4 Message Queue brokers.

Any persistent Message Queue data—messages, destinations, durable subscriptions—is automatically converted, if necessary, to Release 4 Message Queue data when starting up a broker for the first time. For example, any existing destinations will be converted, if necessary, to Release 4 Message Queue destinations, preserving existing attributes and using default values of new attributes.

Administered Object Compatibility

Release 4 Message Queue administered objects are identical to Release 3 administered objects. However, some Release 3 administered objects were renamed or enhanced with new attributes with respect to earlier versions.

Administration Tool Compatibility

Because of the addition of new commands and new administrative capabilities in Release 3, the Release 4 administration tools (the Administration Console and command line utilities) only work with Release 3 and Release 4 brokers.

Client Compatibility

Message Queue Dependencies

Message Queue dependencies on other Java ES components can impact the procedure for upgrading and re-configuring Message Queue software. Changes in Message Queue interfaces or functions, for example, could require upgraded version of components upon which Message Queue depends. The need to upgrade such components depends upon the specific upgrade path.

Shared components. Message Queue has dependencies on specific Java ES shared components (see Table 1-6).

Directory Server (optional). If you want to configure Message Queue to store administered objects and/or user data in an LDAP directory rather than locally, then you can use Directory Server for that purpose.

Web Container (optional). If you need HTTP messaging between client and broker, then Message Queue requires web container support from Java ES Web Server or from Java ES Application Server.

Upgrading Message Queue from Java ES Release 3

This section includes information about upgrading Message Queue from Java ES 2005Q1 (Release 3) to Java ES Release 4. The section covers the following topics:

Introduction

When upgrading Java ES Release 3 Message Queue to Release 4, consider the following aspects of the upgrade process:

General Upgrade Approach. The upgrade is performed using <patchid>.exe that replaces previous software packages with new ones and migrates configuration data from Release 3 automatically.

Upgrade Dependencies. While Message Queue has dependencies on a number of Java ES shared components (see Table 1-6 on page 39), Release 4 Message Queue is compatible with the Release 3 versions of all these components. Upgrade of these shared components is therefore optional with respect to upgrade of Message Queue to Release 4.

Message Queue Upgrade

This section describes how to perform a Message Queue upgrade from Java ES Release 3 to Java ES Release 4:

Pre-Upgrade Tasks

Before you upgrade Message Queue, perform the procedures described in the following sections.

Verify Current Version Information

You can determine the version and edition of Message Queue installed on your system by starting the Message Queue broker with the -version option:

Table 6-3 Message Queue Version Verification Outputs
Java ES Release	Message Queue Version Number
Release 3	Sun Java(tm) System Message Queue 3 2005Q1 Version: 3.6
Release 4	Sun Java(tm) System Message Queue 3 2005Q4 Version: 3.6 SP3

Upgrade Message Queue Dependencies

It is generally recommended that all Java ES components on a computer system (and in a computing environment) be upgraded to Java ES Release 4. However, because Message Queue does not require upgrading the Java ES Release 3 components upon on which it depends, this task is optional.

However, if you choose to upgrade all Message Queue dependencies, they should be upgraded in the following order, all before you upgrade Message Queue. You can skip any that might already have been upgraded.

Shared Components. Instructions for upgrading Java ES shared components to Release 4 are provided in Chapter 2, "Upgrading Java ES Shared Components".

Directory Server (optional). Instructions for upgrading Directory Server to Release 4 are provided in Chapter 3, "Directory Server and Administration Server".

Web Container Software (optional). Instructions for upgrading Web Server or Application Server are provided in Chapter 5, "Web Server" and Chapter 8, "Application Server", respectively.

Back Up Message Queue

There is no script for rolling back Message Queue to its pervious state. Because Release 4 data is compatible with Release 3 data, there is no reason to back up configuration data. In addition, there is no reason to back up the installed image because you can use the Release 3 installer should you need to roll back Release 4 Message Queue to Release 3.

Upgrading Message Queue

The upgrade of Message Queue software to Java ES Release 4 makes use of the mqupgrade script, which installs freshbitted packages that contain the patches shown in Table 1-3.

Stop any running Message Queue client applications.

If Message Queue is being used in an Application Server environment, shut down Application Server, as well.

Stop any running brokers. You will be prompted for the admin user name and password.

imqcmd shutdown bkr [-b hostName:port]

Also stop the Message Queue Broker service from the SCM if running.

If you do not want to preserve dynamic data, the Message Queue flat-file user repository, and the Message Queue access control file associated with each broker instance, remove this data using the following command.

imqbrokerd -name instanceName -remove instance

Otherwise, dynamic data and configuration information will be retained and used for Release 4 Message Queue.

Install the patch by running the executable <Patch-id>.exe.

Verifying the Message Queue Upgrade

After you finish the upgrade procedure, verify that it was successful by starting the Message Queue broker with the -version option.

The command returns the Java ES version number as well as the Message Queue-specific version number.

Post-Upgrade Tasks

If you have upgraded the web container and are using the Message Queue HTTP tunneling servlet, you may need to re-deploy it in the new web container. Otherwise, there has been no change to the HTTP tunneling servlet between Release 3 and Release 4, and you do not need to re-deploy it after upgrading Message Queue to Release 4. See the Message Queue Administration Guide, (http://docs.sun.com/doc/819-2571) for more information on HTTP support.

Rolling Back the Upgrade

No scripts are provided for rolling back Message Queue to its pre-upgrade state. The process must be performed manually using the following steps:

Stop any running Message Queue client applications.

Stop any running brokers. You will be prompted for the admin user name and password.

imqcmd shutdown bkr [-b hostName:port]

and stop the service from the SCM.

If you want to delete dynamic data, the Message Queue flat-file user repository, and the Message Queue access control file associated with each broker instance, remove this data using the following command.

imqbrokerd -name instanceName -remove instance

Run the uninstall_<patchid>.bat.

It will uninstall the patch and put back the original files. But it will not put back the configuration data, dynamic data, Message Queue flat file, user repository, etc.

Previous Contents Index Next
Sun Java Enterprise System Upgrade Guide for Microsoft Windows