ActiveMQ provides a Maven2 plugin to easily startup a JMS broker. It is useful to quickly boot up a message broker in your Maven2 project for debugging or for doing integration tests.

 How to Use

Replace the 5.1 version string with the version of your choosing, eg: 5.0, 5.3-SNAPSHOT

In your Maven2 project, just type:

 mvn org.apache.activemq.tooling:maven-activemq-plugin:5.1:run

This will download the 5.1 version of the plugin, and spin up a broker using a simple configuration url of the form broker:(tcp://localhost:61616)?useJmx=false&persistent=false. The necessary ActiveMQ jars will automatically be downloaded by Maven.

If you require a more advanced configuration with spring support, the jetty webconsole or with embedded camel you can add the plugin in your pom.xml and provide the required optional dependencies. For the default conf/activemq.xml, the following dependencies are required :

 <build>    
    <plugins>
      <plugin>
        <groupId>org.apache.activemq.tooling</groupId>
        <artifactId>maven-activemq-plugin</artifactId>
        <version>5.1</version>
        <configuration>
          <configUri>xbean:file:../conf/activemq.xml</configUri>
          <fork>false</fork>
          <systemProperties>
            <property>
              <name>javax.net.ssl.keyStorePassword</name>
              <value>password</value>
            </property>
            <property>
              <name>org.apache.activemq.default.directory.prefix</name>
              <value>./target/</value>
            </property>
          </systemProperties>
        </configuration>
        <dependencies>
	  <dependency>
            <groupId>org.springframework</groupId>
	    <artifactId>spring</artifactId>
  	    <version>2.5.5</version>
	  </dependency>
	  <dependency>
            <groupId>org.mortbay.jetty</groupId>
            <artifactId>jetty-xbean</artifactId>
            <version>6.1.11</version>
         </dependency> 	
         <dependency>
           <groupId>org.apache.camel</groupId>
           <artifactId>camel-activemq</artifactId>
           <version>1.1.0</version>
         </dependency>
	</dependencies>			
      </plugin>
    </plugins>
</build>

 and run it using:

 mvn activemq:run

 Configuration Options

Name Default Description
configUri broker:(tcp://localhost:61616)?useJmx=false&persistent=false The broker configuration URI that will be use to startup the broker. For more information, refer here
fork false If true, start up the broker in a separate thread, enabling maven to continue processing (Useful for integration testing).
systemProperties none Additional system properties that will be set.

 Note: By default, the broker plugin will set activemq.base, activemq.home, org.apache.activemq.default.directory.prefix, derby.system.home to ./target/. This means that all data folders will be created there, hence will easily be deleted by running mvn clean.

Graphic Design By Hiram