Mirror of Apache ActiveMQ Artemis
Go to file
Martyn Taylor 3ea40b2d35 update copyright in src Notice 2016-06-09 12:20:22 +01:00
.settings ACTIVEMQ6-1 - Initial HornetQ Donation Commit 2014-11-10 10:31:25 -06:00
artemis-boot [maven-release-plugin] prepare for next development iteration 2016-06-09 11:25:03 +01:00
artemis-cli [maven-release-plugin] prepare for next development iteration 2016-06-09 11:25:03 +01:00
artemis-commons [maven-release-plugin] prepare for next development iteration 2016-06-09 11:25:03 +01:00
artemis-core-client [maven-release-plugin] prepare for next development iteration 2016-06-09 11:25:03 +01:00
artemis-distribution [maven-release-plugin] prepare for next development iteration 2016-06-09 11:25:03 +01:00
artemis-dto [maven-release-plugin] prepare for next development iteration 2016-06-09 11:25:03 +01:00
artemis-features [maven-release-plugin] prepare for next development iteration 2016-06-09 11:25:03 +01:00
artemis-jdbc-store [maven-release-plugin] prepare for next development iteration 2016-06-09 11:25:03 +01:00
artemis-jms-client [maven-release-plugin] prepare for next development iteration 2016-06-09 11:25:03 +01:00
artemis-jms-server [maven-release-plugin] prepare for next development iteration 2016-06-09 11:25:03 +01:00
artemis-journal [maven-release-plugin] prepare for next development iteration 2016-06-09 11:25:03 +01:00
artemis-maven-plugin [maven-release-plugin] prepare for next development iteration 2016-06-09 11:25:03 +01:00
artemis-native [maven-release-plugin] prepare for next development iteration 2016-06-09 11:25:03 +01:00
artemis-protocols [maven-release-plugin] prepare for next development iteration 2016-06-09 11:25:03 +01:00
artemis-ra [maven-release-plugin] prepare for next development iteration 2016-06-09 11:25:03 +01:00
artemis-rest [maven-release-plugin] prepare for next development iteration 2016-06-09 11:25:03 +01:00
artemis-selector [maven-release-plugin] prepare for next development iteration 2016-06-09 11:25:03 +01:00
artemis-server [maven-release-plugin] prepare for next development iteration 2016-06-09 11:25:03 +01:00
artemis-server-osgi [maven-release-plugin] prepare for next development iteration 2016-06-09 11:25:03 +01:00
artemis-service-extensions [maven-release-plugin] prepare for next development iteration 2016-06-09 11:25:03 +01:00
artemis-web [maven-release-plugin] prepare for next development iteration 2016-06-09 11:25:03 +01:00
artemis-website [maven-release-plugin] prepare for next development iteration 2016-06-09 11:25:03 +01:00
docs Note to escape & in XML JDBC Connection 2016-06-07 11:46:49 -04:00
etc Update Java version in example Eclipse config 2015-12-21 21:47:15 -05:00
examples [maven-release-plugin] prepare for next development iteration 2016-06-08 11:03:35 +01:00
integration [maven-release-plugin] prepare for next development iteration 2016-06-09 11:25:03 +01:00
scripts Allow override remote name in mergePR script 2016-04-08 10:03:19 -04:00
tests [maven-release-plugin] prepare for next development iteration 2016-06-09 11:25:03 +01:00
.gitignore ARTEMIS-27 / ARTEMIS-340 Add JDBC Storage Manager 2016-01-13 09:38:40 -05:00
.project More name changes to activemq 2014-11-19 16:01:54 -05:00
CMakeLists.txt ARTEMIS-163 First pass on the native AIO refactoring 2015-07-29 22:12:03 -04:00
LICENSE License updates including Base64 and JSON. 2015-03-16 14:30:28 +00:00
NOTICE update copyright in src Notice 2016-06-09 12:20:22 +01:00
README.md ARTEMIS-476 example fixes/docs 2016-04-13 10:53:14 -05:00
RELEASING.md extraTests version bump and RELEASING note 2015-12-21 09:48:14 +00:00
artemis_doap.rdf Update vendor to ASF 2015-05-30 08:37:28 +02:00
pom.xml [maven-release-plugin] prepare for next development iteration 2016-06-09 11:25:03 +01:00

README.md

ActiveMQ Artemis

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

Source

For details about the modifying the code, building the project, running tests, IDE integration, etc. see our Hacking Guide.

Building the ASYNC IO library

ActiveMQ Artemis provides two journal persistence types, NIO (which uses the Java NIO libraries), and ASYNCIO which interacts with the linux kernel libaio library. The ASYNCIO journal type should be used where possible as it is far superior in terms of performance.

ActiveMQ Artemis does not ship with the Artemis Native ASYNCIO library in the source distribution. These need to be built prior to running "mvn install", to ensure that the ASYNCIO journal type is available in the resulting build. Don't worry if you don't want to use ASYNCIO or your system does not support libaio, ActiveMQ Artemis will check at runtime to see if the required libraries and system dependencies are available, if not it will default to using NIO.

To build the ActiveMQ Artemis ASYNCIO native libraries, please follow the instructions in the artemis-native/README.

Documentation

Our documentation is always in sync with our releases at the Apache ActiveMQ Artemis website.

Or you can also look at the current master version on github.

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.

Each individual example can be run using this command from its corresponding directory:

$ mvn verify

If you wish to run groups of examples then use this command from a parent directory (e.g. examples/features/standard):

$ mvn -Pexamples verify

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