Developing Apache Rampart

This document provides information on how to use SVN to get an SVN checkout/update, make commits to the repository, etc., in the process of contributing to Apache projects (specifically Apache Rampart). Instructions on configuring IDEs for development and using Maven to build the project is also included here.

Content

Working with Subversion (SVN)

The Rampart development team uses Subversion (SVN) for source control. Subversion is a compelling replacement for CVS, developed under the auspices of the Tigris community and licensed under an Apache compatible license. To learn more about Subversion or to download the latest distribution, visit the Subversion project site. If you are looking for guidance on setting up and installing Subversion, please read the ASF Source Code Repositories page.

Checkout Axis2 from Subversion

To check out the latest version of Rampart from the Foundation's Subversion repository, you must use one of the following URLs depending on your level of access to the Rampart source code:

If you are a committer, make sure that you have selected an svnpasswd. To do this, you must log into svn.apache.org. For more information, please read the ASF Source Code Repositories page.

Once you have successfully installed Subversion, you can check out Rampart trunk by following these steps:

  1. Run svn co <repository URL> rampart where the repository URL is one of the URLs from the previous list.
  2. This step will check out the latest version of the Rampart Java codebase to a directory named "rampart". The second parameter to the svn co selects a directory to create on your local machine. If you want to checkout Rampart to a different directory, feel free to change rampart to any other directory name.
  3. To update your working copy to the latest version from the repository, execute the svn update command.
  4. If you would like to submit a patch, you can execute svn diff to create a unified diff for submission to the Rampart JIRA issue tracker.

Installing Maven 2

Rampart's build is based on Maven 2. Maven is a build system that allows for the reuse of common build projects across multiple projects. For information about obtaining, installing, and configuring Maven 2, please see the Maven project page. To use Maven to build the Axis2 project, Please install Maven2 and follow instructions here - Quick Guide to Maven for Axis 2.0

.

Configuring your IDE

The Rampart development team uses a variety of development tools from vi to emacs to eclipse to Intellij/IDEA. The following section is not an endorsement of a specific set of tools, it is simply meant as a pointer to ease the process of getting started with Rampart development.

  • Intellij IDEA - type mvn idea:idea. Generates the necessary IDEA .ipr, .iml and .iws project files
  • Eclipse- type mvn eclipse:eclipse. Then in Eclipse, setup a Classpath Variable for MAVEN_REPO, and select File > Import > Existing Projects into Workspace > Select root directory. Selecting the root of the Rampart source discovers all the modules and allows them to be imported as individual projects at once.