Installing & Using Qpid (Java)

Introduction

The information below details how to install and use the main Broker and Client packages.

...

If you want to use a newer version than an official release then you should check out the code from the Subversion repository and then consult the Build How To page.

Broker Install

Unpack the archive into any directory of your choice e.g c:/qpid

Once unpacked, the package will be installed in a directory with a release label (i.e. qpid-1.0-incubating-M2broker-0.5) and the directories underneath should look something like this:

...

qpid-server is a bash script which runs the broker on linux/unix. You should set the environment variable QPID_HOME to point at your install path e.g. C:/qpid/qpid-broker-1.0-incubating-M20.5. This enables the startup script to find default config files in the installed etc directory.

...

qpid-server.bat is a dos script which runs the broker on Windows. See note above about QPID_HOME.

create-example-ssl-stores(.sh/.bat) bash shell / dos batch script to create an example SSL keystore and truststore for use by the brokers JMX management connections, which now ship with SSL enabled by default. Either provide your own keystore by modifying the broker configuration, or run the appropriate script from the /etc directory to create example stores to allow initial broker startup. Alternatively you can modify the configuration files in /etc to turn SSL use off.

The other scripts in this directory can be safely ignored for now.

...

Contains all the jars used by the broker, mainly in their own subdirectories.

The brokerqpid-launchall.jar contains a manifest file which puts the requisite jars into the classpath for broker startup.

...

Contains the config files used by the broker on startup.

/client

This comes with the broker package at the moment and contains the client package. The client can also be downloaded independently. See client section below for details.

/doc

Contains javadoc for the broker.

If running on a unix or linux platform check that the appropriate permissions have been applied to the .sh scripts. If not, then update i.e. chmod 755 *.sh

...

• Make sure you have set the QPID_HOME variable as specified above, and QPID_WORK if you don't want the default
• Make sure you have provided an SSL keystore for the JMX management connections, or disabled the SSL usage, as detailed above in the 'broker install' section.
• One of the config files (persistent_config.xml or transient_config.xml) supplied in the etc directory one level below your root dir probably doesn't need modification and should be passed in using -c and the path to your config file
• Then run the qpid-server script from the root dir of your install. (The qpid-server script also supports cygwin environments.)

...

Checking the broker has started up

...

You can check that the broker has started up successfully by viewing the output it sends to stdout and looking for the start up port info: 2006-07-06 09:18:24,264 INFO  \[main\] server.Main info:

2009-07-15 14:04:49,411 WARN [main] management.JMXManagedObjectRegistry (JMXManagedObjectRegistry.java:187) - Starting JMX ConnectorServer on port '8999' (+9099) with SSL
2009-07-15 14:04:49,842 INFO [main] server.Main (Main.java:181279) - Starting Qpid .AMQP broker 2006Broker 0.5 build: xxxxxxx
2009-07-06 09:18:24,331 INFO  \[main\] 15 14:04:49,910 INFO [main] server.Main (Main.java:251387) - Qpid.AMQP listening on non-SSL address 0.0.0.0/0.0.0.0:5672Note that you may have to edit the log4j.xml in the /etc directory to add an appender for the server.Main class to see loggeds output like this on startup.

Anchor
runningonwindows runningonwindows

...