Sun Java System Message Queue 4.3 Developer's Guide for C Clients

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.