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.
1.7 or 1.8 to build Camel 2.14 onwards
1.8 to build Camel 2.18 onwards
Maven Wrapper is used and bundled with Camel 2.21 onwards.
Otherwise, download and install Maven
Maven 3.1.1 or newer is required to build Camel 2.14 onwards
Maven 3.2.5 or newer is required to build Camel 2.18 onwards
Maven 3.3.3 or newer is required to build Camel 2.20 onwards
Get the latest source from Github
Prince should be in the executable PATH to generate the PDF documentation
To build camel maven has to be configured to use more memory
export MAVEN_OPTS="-Xms2048m -Xmx3584m"
set MAVEN_OPTS="-Xms2048m -Xmx3584m"
The following skips building the manual, the distro and does not execute the unit tests.
mvn clean install -Pfastinstall
mvn clean install -Pfastinstall,sourcecheck
If you prefer to use an IDE then you can auto-generate the IDE’s project files using maven plugins. e.g.
There are several ways to import the projects into Eclipse.
Starting with Camel 2.14.0, Camel can be imported into Eclipse using m2e Maven integration.
Before you start: It is important to run Eclipse with at least 4 GB of heap memory, otherwise the import process will fail. To increase the heap size, edit the "eclipse.ini" file and set the -Xmx parameter as follows:
[...] -Xms4G -Xmx4G
|For a better experience some users set 8 GB when all projects are loaded and opened.|
Cloning the Git Repository
Either follow instructions about getting the latest source, or clone the Git repository with Eclipse by selecting File → Import → Git / Projects from Git and Clone URI. Provide all repository details in the import wizard and clone the repository into a directory outside of the Eclipse workspace. Once cloning has completed, exit the import project wizard (i.e. simply select cancel when asked to select "Wizard for project import").
Import Maven Projects
Import Camel projects as Maven projects using m2e by selecting File → Import → Maven → Existing Maven Projects. Point the wizard to the root directory of the cloned repository. Eclipse will analyze all Camel projects and eventually present the following summary:
Simply confirm the import of all projects by clicking Finish. The import process will create Eclipse projects and automatically set up build paths using dependency details provided by the pom.xml files. Once completed, all Camel projects will be available in your workspace:
|As you can see main project is combined with multiple sub projects/modules (e.g. components, archetypes, tooling etc.). Many sub projects/modules are again categorized or packaged with another layer of sub modules and so on. Developers can import project/module which is relevant to them and work on it instead importing entire project which will consume memory and eventually slow down Eclipse. This approach is not only easy to import and work in eclipse as well as easy to test. Lets say you do some code changes in the camel-ftp component, then you can run the checks from within this directory.|
The maven-eclipse-plugin can be used to generate the .classpath/.project/.settings file that Eclipse need. To do this, run:
mvn process-test-sources eclipse:eclipse
mvn -Psetup.eclipse -Declipse.workspace.dir=/path/to/your/workspace
The latter is recommended as it would completely setup the workspace for you as well as provide options to wire in other projects also found in your workspace.
After running the above command, from within Eclipse, do File → Import → Existing Projects into Workspace, select the root camel checkout location and Eclipse should find all the projects.
Adding Camel Eclipse templates to your workspace
The above mentioned setup.eclipse profile does a few additional things to your workspace:
Adds the Camel code templates (see here)
Sets the M2_REPO variable in the workspace that points to your local Maven repository (i.e.,
~/.m2/repositoryon Unix and
c:\Documents and Settings\<user>\.m2\repositoryon Windows) which allows the jars to be resolved.
[[Building-Hint:specifytheworkspacelocationinyour.m2/settings.xml]] Hint: specify the workspace location in your .m2/settings.xml
You can add a profile to your .m2/settings.xml to specify your eclipse workspace location so you can avoid having to type that each time you need to update the projects.
<profiles> <profile> <id>setup.eclipse</id> <properties> <eclipse.workspace>/path/to/your/workspace</eclipse.workspace> </properties> </profile> </profiles>
To enable source style checking with checkstyle, build Camel with the -Psourcecheck parameter
mvn -Psourcecheck clean install
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 -Pfastinstall
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
mvn clean install -Pvalidate
Normally, when you execute the unit tests during your development cycle for a particular component, you are executing all the tests each time. This may become inefficient, when you are changing one class and the effect of this change is limited within the component having many unit tests. Ekstazi is a regression testing tool that can keep track of the test results and the changed classes so that unaffected tests can be skipped during the subsequent testing. For more details of Ekstazi, please refer to the Ekstazi page at http://www.ekstazi.org.
To use Ekstazi, you can run the tests with the maven profile ekstazi.
mvn test -Pekstazi