Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

HornetQ is an open source project to build a multi-protocol, embeddable, very high performance, clustered, asynchronous messaging system.

branch: master

Merge pull request #1618 from jbertram/master

Clarify documentation regarding message grouping and FIFO semantics
latest commit 52f1af23ac
clebertsuconic clebertsuconic authored
Octocat-spinner-32 .settings Delete checked-in Eclipse project files.
Octocat-spinner-32 distribution add missing module 'hornetq-selector'
Octocat-spinner-32 docs Clarify documentation regarding message grouping and FIFO semantics
Octocat-spinner-32 etc Update checkstyle plugin to 2.12
Octocat-spinner-32 examples 'JEE' and 'jee' are not valid abbreviations for 'Java Enterprise Edit…
Octocat-spinner-32 hornetq-bootstrap More logging cleanup after dependency upgrade
Octocat-spinner-32 hornetq-commons HORNETQ-1337 - Policy Fail may drop messages before it sends the exce…
Octocat-spinner-32 hornetq-core-client HORNETQ-1338 - a few fixes to throw XAExceptions properly
Octocat-spinner-32 hornetq-jms-client Source in the apollo-selector module and refactor to be under the org…
Octocat-spinner-32 hornetq-jms-server More logging cleanup after dependency upgrade
Octocat-spinner-32 hornetq-journal fix apostrophes which can break logging messages
Octocat-spinner-32 hornetq-native Back to snapshot - 2.5.0-snapshot
Octocat-spinner-32 hornetq-protocols fix apostrophes which can break logging messages
Octocat-spinner-32 hornetq-ra More logging cleanup after dependency upgrade
Octocat-spinner-32 hornetq-rest More logging cleanup after dependency upgrade
Octocat-spinner-32 hornetq-selector Source in the apollo-selector module and refactor to be under the org…
Octocat-spinner-32 hornetq-server HORNETQ-1342 - Clean up DuplicateIDCache on queue removal
Octocat-spinner-32 hornetq-service-sar More logging cleanup after dependency upgrade
Octocat-spinner-32 hornetq-tools Cleaup logging after upgrade: use non-deprecated annotations, remove …
Octocat-spinner-32 integration More logging cleanup after dependency upgrade
Octocat-spinner-32 scripts update on script
Octocat-spinner-32 tests HORNETQ-1342 - Clean up DuplicateIDCache on queue removal
Octocat-spinner-32 .gitignore Ignore more Eclipse generated files
Octocat-spinner-32 .project Delete checked-in Eclipse project files.
Octocat-spinner-32 NOTICE replaced a load of JBoss Messaging references
Octocat-spinner-32 README.md Spelling fixes.
Octocat-spinner-32 RELEASING.md updating release instructions for upload binaries
Octocat-spinner-32 pom.xml restore doc build to release profile
Octocat-spinner-32 quorum.patch https://issues.jboss.org/browse/HORNETQ-1339 - improve quorum support
README.md

HornetQ

If you need information about the HornetQ project please go to

http://community.jboss.org/wiki/HornetQ

http://www.jboss.org/hornetq/

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

Source

The project's source code is hosted at:

https://github.com/hornetq

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

Maven

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.

Tests

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

Examples

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

Eclipse

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
done

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.

Something went wrong with that request. Please try again.