Apache Camel: Camel Maven Plugin

Camel Maven Plugin

The Camel Maven Plugin allows you to run your Enterprise Integration Patterns inside Maven along with being able to support Visualisation along with integration of the Visualisation diagrams into the standard maven reports for your project.

Goals Supported

Documentation	Reference	Description
camel:run	camel:run	Boots up Camel in a new JVM using the Spring configuration at *META-INF/spring/.xml** and runs your routing rules
camel:embedded	camel:embedded	Boots up Camel in the same JVM as Maven using the Spring configuration at *META-INF/spring/.xml** and runs your routing rules
camel:dot	camel:dot	Generates DOT files and then HTML, PNG, SVG files for your EIP routing rules with integration into Maven Reports

You may override the default Spring application context file uri META-INF/spring/*.xml by using the applicationContextUri property in the camel-maven-plugin configuration. Paths may be split using a semi-colon (;).

<plugin>
  <groupId>org.apache.camel</groupId>
  <artifactId>camel-maven-plugin</artifactId>
  <configuration>
    <applicationContextUri>META-INF/spring/*.xml;YOUR_FILE_NAME_IN_THE_CLASS_PATH.xml</applicationContextUri>
  </configuration>
</plugin>

File based spring configuration files

In Camel 1.4 loading file based spring context files is also supported. You configure this with the new option fileApplicationContextUri. Paths may be split using a semi-colon (;). This is usable for projects that is web applications and you store spring configuration files in WEB-INF.

<plugin>
  <groupId>org.apache.camel</groupId>
  <artifactId>camel-maven-plugin</artifactId>
  <configuration>
    <fileApplicationContextUri>src/main/webapp/WEB-INF/camel*.xml</fileApplicationContextUri>
  </configuration>
</plugin>

Integration into Maven Reports

If you add the camel-maven-plugin to your <reporting> section of your pom you will automatically get the Visualisation reporting generated for your project as part of the regular maven site generation.

For example add the following into your pom

<project>
  ...
  <reporting>
    <plugins>
      <plugin>
        <groupId>org.apache.camel</groupId>
        <artifactId>camel-maven-plugin</artifactId>
      </plugin>
    </plugins>
  </reporting>  
</project>

Then when you run

mvn site

Your context will be booted up via the META-INF/spring/*.xml files, the DOT file generated and a nice HTML report created.

GraphViz DOT required

Note to get the nice HTML, PNG and SVG outputs from the DOT files you will need to install the GraphViz DOT executable and add it to your PATH so that the plugin can invoke DOT to generate the PNG/SVG files.

For more details see the camel:dot.

Camel Maven Plugin

Goals Supported

File based spring configuration files

Integration into Maven Reports

Overview

Documentation

Search

Community

Developers