Building Camel from Source

Camel uses Maven as its build and management tool. If you don't fancy using Maven you can use your IDE directly or Download a distribution or JAR.

Prequisites

Required:

  • Download and install Maven.
    (Maven 2.2.1 or better is required to build Camel 2.5 onwards).
  • Get the latest Source
  • Java 1.6 or better
    (Java 1.5 is @deprecated and no longer supported from Camel 2.7 onwards)

Optional:

  • Prince should be in the executable PATH to generate the PDF documentation

Maven options

To build camel maven has to be configured to use more memory

set MAVEN_OPTS=-Xmx1024m -XX:MaxPermSize=512m

A normal build

mvn install

A normal build without running tests

mvn clean install -Dtest=false

Doing a Quick Build

Available as of Camel 2.6

The following skips building the manual, the distro and does not execute the unit tests.

mvn install -Pfastinstall

Using an IDE

If you prefer to use an IDE then you can auto-generate the IDE's project files using maven plugins. e.g.

mvn eclipse:eclipse

or

mvn idea:idea

Adding Camel Eclipse templates to your workspace

mvn -Psetup.eclipse -Declipse.workspace.dir=/path/to/your/workspace

You can also find some helpful notes on usage here.

Importing into Eclipse

If you have not already done so, you will need to make Eclipse aware of the Maven repository so that it can build everything. In the preferences, go to Java->Build Path->Classpath and define a new Classpath Variable named M2_REPO that points to your local Maven repository (i.e., ~/.m2/repository on Unix and c:\Documents and Settings\<user>\.m2\repository on Windows).

You can also get Maven to do this for you:

mvn eclipse:configure-workspace -Declipse.workspace=/path/to/the/workspace/ 

Building with checkstyle

To enable source style checking with checkstyle, build Camel with the -Psourcecheck parameter

mvn -Psourcecheck clean install

Building source jars

If you want to build jar files with the source code, that for instance Eclipse can important so you can debug the Camel code as well. Then you can run this command from the camel root folder:

mvn clean source:jar install -Dtest=false

Building with Spring 2.5.6

From Camel 2.4.0, we switch the default Spring version to 3.0.x, If you want Camel to be build against Spring 2.5.6 you have to build with the maven profile spring-2.x.

mvn clean install -Pspring-2.x

You may want to skip testing and do a fast build

mvn clean install -Pspring-2.x -Dtest=false

Note: Spring 2.x is no longer supported from Camel 2.7 onwards. The spring-2.x profile has been removed.

Working with features

If you change anything in the features.xml from platform/karaf you can run a validation step to ensure the generated features.xml file is correct. You can do this running the following maven goal from the platform directory.

mvn clean install -Pvalidate

See Also

© 2004-2011 The Apache Software Foundation.
Apache Camel, Camel, Apache, the Apache feather logo, and the Apache Camel project logo are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.
Graphic Design By Hiram