Installation

Introduction This document describes how to install the Java Broker on both Windows and UNIX platforms.

Prerequisites

Java Platform The Java Broker is an 100% Java implementation and as such it can be used on any operating system supporting Java 1.6 or higher. This includes Linux, Solaris, Mac OS X, and Windows XP/Vista/7/8. The broker has been tested with Java implementations from both Oracle and IBM. Whatever platform you chose, it is recommended that you ensure it is patched with any critical updates made available from the vendor. Verify that your JVM is installed properly by following these instructions.

Disk The Java Broker installation requires approximately 20MB of free disk space. The Java Broker also requires a working directory. The working directory is used for the message store, that is, the area of the file-system used to record persistent messages whilst they are passing through the Broker. The working directory is also used for the default location of the log file. The size of the working directory will depend on the how the Broker is used. The performance of the file system hosting the work directory is key to the performance of Broker as a whole. For best performance, choose a device that has low latency and one that is uncontended by other applications. Be aware that there are additional considerations if you are considering hosting the working directory on NFS. See for further details.

Memory Qpid caches messages on the heap for performance reasons, so in general, the Broker will benefit from as much heap as possible. However, on a 32bit JVM, the maximum addressable memory range for a process is 4GB, after leaving space for the JVM's own use this will give a maximum heap size of approximately ~3.7GB.

Operating System Account Installation or operation of Qpid does not require a privileged account (i.e. root on UNIX platforms or Administrator on Windows). However it is suggested that you use an dedicated account (e.g. qpid) for the installation and operation of the Java Broker.

Download

Broker Release You can download the latest qpid-java-broker-&qpidCurrentRelease;.tar.gz package from the Download Page. It is recommended that you confirm the integrity of the download by verifying the PGP signature matches that available on the site. Instrutions are given on the download page.

Optional Dependencies The broker has an optional message store implementations backed by Oracle BDB JE. If you wish to use these stores you will need to provide the optional Oracle BDB JE dependency. For more details, see

Installation on Windows Firstly, verify that your JVM is installed properly by following these instructions. Now chose a directory for Qpid broker installation. This directory will be used for the Qpid JARs and configuration files. It need not be the same location as the store used for the persistent messages or the log file (you will chose this location later). For the remainder this example we will assumed that location c:\qpid has been chosen. Now using WinZipWinZip is a Registered Trademark of WinZip International LLC (or similar) extract the Qpid package qpid-java-broker-&qpidCurrentRelease;.tar.gz into the directory. The extraction of the Qpid package will have created a directory qpid-broker-&qpidCurrentRelease; within c:\qpid Volume in drive C has no label Directory of c:\qpid\qpid-broker-&qpidCurrentRelease; 07/25/2012 11:22 PM . 09/30/2012 10:51 AM .. 09/30/2012 12:24 AM bin 08/21/2012 11:17 PM etc 07/25/2012 11:22 PM lib 07/20/2012 08:10 PM 65,925 LICENSE 07/20/2012 08:10 PM 3,858 NOTICE 07/20/2012 08:10 PM 1,346 README.txt 3 File(s) 71,129 bytes 5 Dir(s) 743,228,796,928 bytes free

Setting the working directory Qpid requires a work directory. This directory is used for the default location of the Qpid log file and is used for the storage of persistent messages. The work directory can be set on the command-line (for the lifetime of the command interpreter), but you will normally want to set the environment variable permanently via the Advanced System Settings in the Control Panel. set QPID_WORK=S:\qpidwork If the directory referred to by QPID_WORK does not exist, the Java Broker will attempt to create it on start-up.

Installation on UNIX platforms Firstly, verify that your JVM is installed properly by following these instructions. Now chose a directory for Qpid broker installation. This directory will be used for the Qpid JARs and configuration files. It need not be the same location as the store used for the persistent messages or the log file (you will chose this location later). For the remainder this example we will assumed that location /usr/local/qpid has been chosen. Extract the Qpid package qpid-java-broker-&qpidCurrentRelease;.tar.gz into the directory. mkdir /usr/local/qpid cd /usr/local/qpid tar xvzf qpid-java-broker-&qpidCurrentRelease;.tar.gz> The extraction of the Qpid package will have created a directory qpid-broker-x.x ls -la qpid-broker-&qpidCurrentRelease;/ total 152 drwxr-xr-x 8 qpid qpid 272 25 Jul 23:22 . drwxr-xr-x 45 qpid qpid 1530 30 Sep 10:51 .. -rw-r--r--@ 1 qpid qpid 65925 20 Jul 20:10 LICENSE -rw-r--r--@ 1 qpid qpid 3858 20 Jul 20:10 NOTICE -rw-r--r--@ 1 qpid qpid 1346 20 Jul 20:10 README.txt drwxr-xr-x 10 qpid qpid 340 30 Sep 00:24 bin drwxr-xr-x 9 qpid qpid 306 21 Aug 23:17 etc drwxr-xr-x 34 qpid qpid 1156 25 Jul 23:22 lib

Setting the working directory Qpid requires a work directory. This directory is used for the default location of the Qpid log file and is used for the storage of persistent messages. The work directory can be set on the command-line (for the lifetime of the current shell), but you will normally want to set the environment variable permanently the user's shell profile file (~/.bash_profile for Bash etc). If the directory referred to by QPID_WORK does not exist, the Java Broker will attempt to create it on start-up.