Building with Maven

Introduction

Even though Ant is the default build system of the Restlet project, several users have asked for Maven support. With Restlet 2.0, we adapted our source code structure and provided some Maven POM files to facilitate the life of Maven users.

Downloading the source code

The Restlet project stores all its source code in a Subversion repository hosted by the Tigris.org web site. You can get detailled instructions on how to setup a SVN client like Tortoise SVN on this page.

Note that you can download several versions of the source code. The most common one lives under the "/trunk/" directory in the Restlet SVN repository. It contains the latest code developed and may be broken from time to time and even contain critical bugs, it's the bleeding edge

Also, each released version is tagged in the repository for archival purpose. They are available under the "/tags" directory, for example "/tags/1.0b19/" contains a full snapshot of the project when the version 1.0 beta 19 was released!

Finally, there is a "/branch" directory that contains branches of the code of previous major and minor releases. A branch is used to maintain a publicly released version (for example Restlet 1.1) while working in parallel on a newer version (for example Restlet 2.0) in the trunk.

In order to build the Restlet modules with Maven, you do not need a full SVN working copy. You can just checkout the "modules" directory, such as "/trunk/modules/". This directory contains the parent POM file necessary for Maven usage.

From now on, we will use "%RESTLET_HOME%" as a shortcut for the location of the downloaded the modules source code on your computer, typically the local directory corresponding to the SVN "/trunk/modules" one.

Installing Maven

You can get the most up to date instruction directly from Maven's site, check this page.

Building the source code

In the shell, change the current dir to "%RESTLET_HOME%". Enter "mvn install" to launch the Maven build. Also, it is possible to build only a single module by changing the current directory to this module and entering "mvn install" as before.