Maven: Development

This page describes how to compile Janus-related projects with Maven.

Maven

Maven is the compilation tool recommended by the Janus community. All Janus modules are provided in the form of Maven modules, which are accessible from the Maven repository of Janus.

What is Maven?

The Apache Maven project describes Maven as a "software project management and comprehension tool". Maven is used in thousands of open-source and commercial software projects to simplify building and understanding software of all stripes. Maven is great at doing command-line builds, understanding project structure and relationships, and sharing code in binary repositories. It's easy to write and configure a Maven plug-in for a given build task, and hundreds of plug-ins are available.

Maven and Eclipse IDE

Maven Integration for Eclipse provides tight integration for Maven into the IDE and providing the following features: launching Maven builds from within Eclipse, dependency management for Eclipse build path based on Maven's pom.xml, resolving Maven dependencies from the Eclipse workspace without installing to local Maven repository, automatic downloading of the required dependencies from the remote Maven repositories, wizards for creating new Maven projects, pom.xml and to enable Maven support on plain Java project, quick search for dependencies in Maven remote repositories, quick fixes in the Java editor for looking up required dependencies/jars by the class or package name.

In order to be able to create Janus projects directly from your IDE, you can add the Janus repository in Window -> Preferences -> Maven -> Archetypes. Click in "Add Remote Catalog ..." and set it like the following :

• Catalog file : http://www.janus-project.org/maven/archetype-catalog.xml
• Description : Janus Archetypes

Now you can create projects using the "Maven Project" wizard as illustrated by Figure 1.

Figure 1: Create a maven project with eclipse

If you are using snapshot version be sure to select the "Include snapshot archetypes" as illustrated by Figure 2.

Figure 2: Select Janus archetype

Maven Repository for Janus

Read-only access to the Maven repository of Janus is granted to the user community.

All janus-related jars are available at Maven repository for Janus.

Maven-related description of this repository:

<repository>
	<id>org.janus-project.maven</id>
	<name>Janus Project Snapshots</name>
	<url>http://www.janus-project.org/maven/</url>
</repository>

Compiling your Janus project with Maven

Firstly, you have to configure Maven on your computer, please follow the corresponding tutorial:

• Configure Maven on Linux Hosts
• Configure Maven on Windows Hosts

Note: do not take account of the first prerequisite 1.1, it is reserved to Janus core developers.

Then, you may follow the tutorial to create your first Janus application.