Mirror of Apache ActiveMQ Artemis
Go to file
Clebert Suconic 14d840de58 This closes #1431 2017-08-01 09:43:15 -04:00
.mvn/wrapper ARTEMIS-613 Artemis build enhancements 2016-07-05 15:13:35 -04: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 2017-07-24 21:21:18 -04:00
artemis-cdi-client [maven-release-plugin] prepare for next development iteration 2017-07-24 21:21:18 -04:00
artemis-cli Fix a typo in bootstrap-web-settings.txt 2017-08-01 09:43:14 -04:00
artemis-commons [maven-release-plugin] prepare for next development iteration 2017-07-24 21:21:18 -04:00
artemis-core-client [ARTEMIS-1311] Log messages without prefixed id code in artemis-core-client 2017-07-31 12:51:15 -04:00
artemis-core-client-all [maven-release-plugin] prepare for next development iteration 2017-07-24 21:21:18 -04:00
artemis-distribution [maven-release-plugin] prepare for next development iteration 2017-07-24 21:21:18 -04:00
artemis-dto [maven-release-plugin] prepare for next development iteration 2017-07-24 21:21:18 -04:00
artemis-features [maven-release-plugin] prepare for next development iteration 2017-07-24 21:21:18 -04:00
artemis-jdbc-store [maven-release-plugin] prepare for next development iteration 2017-07-24 21:21:18 -04:00
artemis-jms-client [maven-release-plugin] prepare for next development iteration 2017-07-24 21:21:18 -04:00
artemis-jms-client-all [maven-release-plugin] prepare for next development iteration 2017-07-24 21:21:18 -04:00
artemis-jms-server [maven-release-plugin] prepare for next development iteration 2017-07-24 21:21:18 -04:00
artemis-journal ARTEMIS-1312 TimedBuffer doubled timeout with blocking flush 2017-08-01 06:34:25 -04:00
artemis-junit [maven-release-plugin] prepare for next development iteration 2017-07-24 21:21:18 -04:00
artemis-maven-plugin [maven-release-plugin] prepare for next development iteration 2017-07-24 21:21:18 -04:00
artemis-native [maven-release-plugin] prepare for next development iteration 2017-07-24 21:21:18 -04:00
artemis-protocols [maven-release-plugin] prepare for next development iteration 2017-07-24 21:21:18 -04:00
artemis-ra ARTEMIS-1299 support commas in RA connection parameter values 2017-07-28 18:00:50 -04:00
artemis-rest [maven-release-plugin] prepare for next development iteration 2017-07-24 21:21:18 -04:00
artemis-selector [maven-release-plugin] prepare for next development iteration 2017-07-24 21:21:18 -04:00
artemis-server ARTEMIS-1306 clarify identity for authn failures 2017-07-28 18:00:06 -04:00
artemis-server-osgi [ARTEMIS-1309] Import johnzon.core package in the artemis-server-osgi bundle 2017-07-28 18:01:56 -04:00
artemis-service-extensions [maven-release-plugin] prepare for next development iteration 2017-07-24 21:21:18 -04:00
artemis-tools [maven-release-plugin] prepare for next development iteration 2017-07-24 21:21:18 -04:00
artemis-web [maven-release-plugin] prepare for next development iteration 2017-07-24 21:21:18 -04:00
artemis-website [maven-release-plugin] prepare for next development iteration 2017-07-24 21:21:18 -04:00
docs NO-JIRA: Update Logo 2017-07-25 01:51:01 +01:00
etc ARTEMIS-1189 - Fix checkstyle violations post checkstyle upgrade 2017-05-30 13:40:00 -04:00
examples [maven-release-plugin] prepare for next development iteration 2017-07-24 21:21:18 -04:00
integration/activemq-spring-integration [maven-release-plugin] prepare for next development iteration 2017-07-24 21:21:18 -04:00
scripts ARTEMIS-1265 Adding helper script for coverage tests 2017-07-24 15:11:19 -04:00
tests ARTEMIS-1312 TimedBuffer doubled timeout with blocking flush 2017-08-01 06:34:25 -04:00
.gitignore ARTEMIS-1129 Fixing tests after client all 2017-05-18 09:30:18 -04: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 ARTEMIS-565 Replace json.org with javax.json 2016-07-25 21:44:57 -04:00
NOTICE NO-JIRA: update notice 2017-03-09 09:07:09 -05:00
README.md Adding OWASP reporting into pom 2016-09-13 17:06:25 +01:00
RELEASING.md NO-JIRA: small update on Releasing procedure 2017-05-08 14:52:27 -04:00
artemis_doap.rdf Update vendor to ASF 2015-05-30 08:37:28 +02:00
mvnw ARTEMIS-613 Artemis build enhancements 2016-07-05 15:13:35 -04:00
mvnw.cmd ARTEMIS-613 Artemis build enhancements 2016-07-05 15:13:35 -04:00
pom.xml [maven-release-plugin] prepare for next development iteration 2017-07-24 21:21:18 -04: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

Open Web Application Security Project (OWASP) Report

If you wish to generate the report for CCV dependencies, you may run it with the -Powasp profile

$ mvn -Powasp verify

The output will be under ./target/dependency-check-report.html for each sub-module.