Java AMQP Client Library Build Instructions

This section describes the process for obtaining a copy of the RabbitMQ Java AMQP client source code, as well as instructions for building the Java client from source.

Obtaining the source


  • Either download a released source code distribution from the download page, or
  • Check the code out directly from our GitHub repositories:
    $ git clone https://github.com/rabbitmq/rabbitmq-codegen.git rabbitmq_codegen
    $ git clone https://github.com/rabbitmq/rabbitmq-java-client.git

If you choose to download a released source code distribution, be aware that the code-generation module is a dependency of the Java client library.

Required Libraries and Tools

In order to build RabbitMQ Java AMQP client library, you will need a few tools.

The Java client libraries requires a recent version of Python and simplejson.py (an implementation of a JSON reader and writer in Python), for generating AMQP 0-9-1 framing code. simplejson.py is included as a standard json library in the Python core since 2.6 release.

Additionally, for building the Java client libraries, you will need

Building the Java client libraries

Ensure JAVA_HOME is correctly set and that the rabbitmq-java-client and rabbitmq_codegen directories are in the same directory. Change to the rabbitmq-java-client directory and launch the build:

$ cd rabbitmq-java-client
$ mvn clean package -Ddeps.dir=../ -DskipTests
The generated JAR file will be in target.

This procedure is enough if you want to build the Java Client yourself. If you want to make significant changes or contribute to the Java Client, please follow the instructions on the library repository. They cover among others how to properly run the test suite.