Switch branches/tags
hornetq_2_2_2_Final_pending hornetq_2_0_0_CR1 hornetq_2_0_0_CR1_pending Pending_HornetQ_2_1_2_Final Hornetq_2_1_1_Final Hornetq_2_1_0_Final Hornetq_2_1_0_Final_pending Hornetq_2_1_0_CR1 Hornetq_2_1_0_CR1_pending HornetQ_2_3_2_FINAL HornetQ_2_3_1_FINAL HornetQ_2_3_0_FINAL HornetQ_2_3_0_CR2 HornetQ_2_3_0_CR1 HornetQ_2_3_0_Beta3 HornetQ_2_3_0_Beta2 HornetQ_2_3_0_Beta1 HornetQ_2_3_0_Alpha HornetQ_2_2_24_EAP_GA HornetQ_2_2_23_AS7_Final HornetQ_2_2_19_AS7_Final HornetQ_2_2_18_AS7_Final HornetQ_2_2_17_AS7_Final HornetQ_2_2_16_AS7_Final HornetQ_2_2_15_AS7_Final HornetQ_2_2_14_Final HornetQ_2_2_13_AS7_Final HornetQ_2_2_13_AS7_Final_Pending HornetQ_2_2_12_AS7_Final HornetQ_2_2_12_AS7_Final_Pending HornetQ_2_2_11_EAP_GA HornetQ_2_2_11_AS7_Final HornetQ_2_2_11_AS7_Final_Pending HornetQ_2_2_10_EAP_JBPAPP_8396 HornetQ_2_2_10_EAP_JBPAPP_8396_v4 HornetQ_2_2_10_EAP_JBPAPP_8396_v3 HornetQ_2_2_10_EAP_JBPAPP_8396_v2 HornetQ_2_2_10_EAP_BUILD2 HornetQ_2_2_10_EAP_BUILD1 HornetQ_2_2_10_AS7_Final HornetQ_2_2_10_AS7_Final_pending HornetQ_2_2_9_AS7_Final HornetQ_2_2_8_EAP_GA HornetQ_2_2_8_EAP_CR3 HornetQ_2_2_8_EAP_CR2 HornetQ_2_2_8_EAP_CR1 HornetQ_2_2_7_Final HornetQ_2_2_7_Final_pending HornetQ_2_2_6_Final HornetQ_2_2_6_Final_pending HornetQ_2_2_5_Final HornetQ_2_2_5_Final_pending HornetQ_2_2_5_EAP_GA HornetQ_2_2_4_EAP_GA HornetQ_2_2_3_EAP_GA HornetQ_2_2_2_Rest-Final-Examples HornetQ_2_2_2_Final HornetQ_2_2_2_Final_pending HornetQ_2_2_2_EAP_CR4 HornetQ_2_2_2_EAP_CR3 HornetQ_2_2_2_EAP_CR2 HornetQ_2_2_2_EAP_CR1 HornetQ_2_2_1_EAP_GA HornetQ_2_2_0_QA4 HornetQ_2_2_0_QA3 HornetQ_2_2_0_QA2 HornetQ_2_2_0_QA1 HornetQ_2_2_EAP_GA HornetQ_2_2_EAP_CR1 HornetQ_2_1_2_Final HornetQ_2_1_1_Final HornetQ_2_1_0_Final HornetQ_2_1_0_CR1 HornetQ_2_1_0_CR1_pending HornetQ_2_1_0_Beta3 HornetQ_2_1_0_Beta2 HornetQ_2_1_0_Beta1 HornetQ_2_1_0_Beta1_Pending HornetQ_2_0_0_GA HornetQ_2_0_0_GA_pending HornetQ_2_0_0_CR3 HornetQ_2_0_0_CR3_pending HornetQ_2_0_0_CR2 HornetQ_2_0_0_CR1 HornetQ_2_0_0_Beta5 HornetQ_Rest_2_2_2_Final-Examples@10435 HornetQ_Rest_2_2_2_Final-Examples
Nothing to show
Find file
Fetching contributors…
Cannot retrieve contributors at this time
172 lines (107 sloc) 5.5 KB


If you need information about the HornetQ project please go to

This file describes some minimum 'stuff one needs to know' to get started coding in this project.


The project's source code is hosted at:

Git usage:

Pull requests should be merged without fast forwards '--no-ff'. An easy way to achieve that is to use

% git config branch.master.mergeoptions --no-ff


The minimum required Maven version is 3.0.0.

Do note that there are some compatibility issues with Maven 3.X still unsolved 1. This is specially true for the 'site' plugin 2.


To run the unit tests:

% mvn -Phudson-tests test

Generating reports from unit tests:

% mvn install site

Running tests individually

% mvn -Phudson-tests -DfailIfNoTests=false -Dtest=<test-name> test

where <test-name> is the name of the Test class without its package name


To run an example firstly make sure you have run

% mvn -Prelease install

If the project version has already been released then this is unnecessary.

then you will need to set the following maven options, on Linux by

export MAVEN_OPTS="-Xmx1024m -XX:MaxPermSize=512m"

and the finally run the examples by

% mvn verify

You can also run individual examples by running the same command from the directory of which ever example you want to run. NB for this make sure you have installed examples/common.

Recreating the examples

If you are trying to copy the examples somewhere else and modifying them. Consider asking Maven to explicitly list all the dependencies:

# if trying to modify the 'topic' example:
cd examples/jms/topic && mvn dependency:list

To build a release artifact

% mvn -Prelease install

To build the release bundle

% mvn -Prelease package


We recommend using Eclipse Kepler (4.3), due to the built-in support for Maven and Git. Note that there are still some Maven plugins used by sub-projects (e.g. documentation) which are not supported even in Eclipse Kepler (4.3).

Eclipse m2e is already included in "Eclipse IDE for Java Developers", or it can be installed from Eclipse Kepler release repository.

Annotation Pre-Processing

HornetQ uses JBoss Logging and that requires source code generation from Java annotations. In order for it to 'just work' in Eclipse you need to install the Maven Integration for Eclipse JDT Annotation Processor Toolkit m2e-apt. See this JBoss blog post for details.

M2E Connector for Javacc-Maven-Plugin

Eclipse Indigo (3.7) has out-of-the-box support for it.

As of this writing, Eclipse Kepler (4.3) still lacks support for Maven's javacc plugin. The available m2e connector for javacc-maven-plugin requires a downgrade of Maven components to be installed. manual installation instructions (as of this writing you need to use the development update site). See this post for how to do this with Eclipse Juno (4.2).

The current recommended solution for Eclipse Kepler is to mark javacc-maven-plugin as ignored by Eclipse, run Maven from the command line and then modify the project hornetq-core-client adding the folder target/generated-sources/javacc to its build path.

Use Project Working Sets

Importing all HornetQ subprojects will create too many projects in Eclipse, cluttering your Package Explorer and Project Explorer views. One way to address that is to use Eclipse's Working Sets feature. A good introduction to it can be found at a Dzone article on Eclipse Working Sets.

Code Formatting

Eclipse code formatting and (basic) project configuration files can be found at the etc/ folder. You should manually copy them after importing all your projects:

for settings_dir in `find . -type d -name .settings`; do
   \cp -v etc/org.eclipse.jdt.* $settings_dir

Do not use the maven-eclipse-plugin to copy the files as it conflicts with m2e.

GitHub procedures

The best way to submit changes to HornetQ is through pull requests on GitHub. After review a pull request should either get merged or be rejected.

When a pull request needs to be reworked, say you have missed something, the pull request is then closed. When you finished addressing the required changes you should reopen your original pull request and it will then be re-evaluated. At that point if the request is approved we will then merge it.

Make sure you always rebase your branch on master before submitting pull requests.