<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> | |
<!-- Generated by Apache Maven Doxia at Apr 17, 2012 --> | |
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> | |
<head> | |
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> | |
<title>Apache Axis2 - | |
Developing Apache Axis2</title> | |
<style type="text/css" media="all"> | |
@import url("./css/maven-base.css"); | |
@import url("./css/maven-theme.css"); | |
@import url("./css/site.css"); | |
</style> | |
<link rel="stylesheet" href="./css/print.css" type="text/css" media="print" /> | |
<meta name="Date-Revision-yyyymmdd" content="20120417" /> | |
<meta http-equiv="Content-Language" content="en" /> | |
</head> | |
<body class="composite"> | |
<div id="banner"> | |
<a href="http://www.apache.org/" id="bannerLeft"> | |
<img src="http://www.apache.org/images/asf_logo_wide.png" alt="Apache Axis2" /> | |
</a> | |
<a href="" id="bannerRight"> | |
<img src="images/axis.jpg" alt="Apache Axis2" /> | |
</a> | |
<div class="clear"> | |
<hr/> | |
</div> | |
</div> | |
<div id="breadcrumbs"> | |
<div class="xleft"> | |
<span id="publishDate">Last Published: 2012-04-17</span> | |
| <span id="projectVersion">Version: 1.6.2</span> | |
</div> | |
<div class="xright"> <a href="index.html" title="Axis2/Java">Axis2/Java</a> | |
| | |
<a href="http://www.apache.org" class="externalLink" title="Apache">Apache</a> | |
</div> | |
<div class="clear"> | |
<hr/> | |
</div> | |
</div> | |
<div id="leftColumn"> | |
<div id="navcolumn"> | |
<h5>Axis2/Java</h5> | |
<ul> | |
<li class="none"> | |
<a href="index.html" title="Home">Home</a> | |
</li> | |
</ul> | |
<h5>Downloads</h5> | |
<ul> | |
<li class="none"> | |
<a href="download.cgi" title="Releases">Releases</a> | |
</li> | |
<li class="none"> | |
<a href="modules/index.html" title="Modules">Modules</a> | |
</li> | |
<li class="none"> | |
<a href="tools/index.html" title="Tools">Tools</a> | |
</li> | |
</ul> | |
<h5>Documentation</h5> | |
<ul> | |
<li class="none"> | |
<a href="docs/toc.html" title="Table of Contents">Table of Contents</a> | |
</li> | |
<li class="none"> | |
<a href="docs/installationguide.html" title="Installation Guide">Installation Guide</a> | |
</li> | |
<li class="none"> | |
<a href="docs/quickstartguide.html" title="QuickStart Guide">QuickStart Guide</a> | |
</li> | |
<li class="none"> | |
<a href="docs/userguide.html" title="User Guide">User Guide</a> | |
</li> | |
<li class="none"> | |
<a href="docs/jaxws-guide.html" title="JAXWS Guide">JAXWS Guide</a> | |
</li> | |
<li class="none"> | |
<a href="docs/pojoguide.html" title="POJO Guide">POJO Guide</a> | |
</li> | |
<li class="none"> | |
<a href="docs/spring.html" title="Spring Guide">Spring Guide</a> | |
</li> | |
<li class="none"> | |
<a href="docs/webadminguide.html" title="Web Administrator's Guide">Web Administrator's Guide</a> | |
</li> | |
<li class="none"> | |
<a href="docs/migration.html" title="Migration Guide (from Axis1)">Migration Guide (from Axis1)</a> | |
</li> | |
</ul> | |
<h5>Resources</h5> | |
<ul> | |
<li class="none"> | |
<a href="faq.html" title="FAQ">FAQ</a> | |
</li> | |
<li class="none"> | |
<a href="articles.html" title="Articles">Articles</a> | |
</li> | |
<li class="none"> | |
<a href="http://wiki.apache.org/ws/FrontPage/Axis2/" class="externalLink" title="Wiki">Wiki</a> | |
</li> | |
<li class="none"> | |
<a href="refLib.html" title="Reference Library">Reference Library</a> | |
</li> | |
<li class="none"> | |
<a href="api/index.html" title="Online Java Docs">Online Java Docs</a> | |
</li> | |
</ul> | |
<h5>Get Involved</h5> | |
<ul> | |
<li class="none"> | |
<a href="overview.html" title="Overview">Overview</a> | |
</li> | |
<li class="none"> | |
<strong>Checkout the Source</strong> | |
</li> | |
<li class="none"> | |
<a href="mail-lists.html" title="Mailing Lists">Mailing Lists</a> | |
</li> | |
<li class="none"> | |
<a href="release-process.html" title="Release Process">Release Process</a> | |
</li> | |
<li class="none"> | |
<a href="guidelines.html" title="Developer Guidelines">Developer Guidelines</a> | |
</li> | |
<li class="none"> | |
<a href="siteHowTo.html" title="Build the Site">Build the Site</a> | |
</li> | |
</ul> | |
<h5>Project Information</h5> | |
<ul> | |
<li class="none"> | |
<a href="team-list.html" title="Project Team">Project Team</a> | |
</li> | |
<li class="none"> | |
<a href="issue-tracking.html" title="Issue Tracking">Issue Tracking</a> | |
</li> | |
<li class="none"> | |
<a href="http://svn.apache.org/viewvc/axis/axis2/java/core/trunk/" class="externalLink" title="Source Code">Source Code</a> | |
</li> | |
<li class="none"> | |
<a href="thanks.html" title="Acknowledgements">Acknowledgements</a> | |
</li> | |
<li class="none"> | |
<a href="http://www.apache.org/licenses/LICENSE-2.0.html" class="externalLink" title="License">License</a> | |
</li> | |
<li class="none"> | |
<a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsorship">Sponsorship</a> | |
</li> | |
<li class="none"> | |
<a href="http://www.apache.org/foundation/thanks.html" class="externalLink" title="Thanks">Thanks</a> | |
</li> | |
<li class="none"> | |
<a href="http://www.apache.org/security/" class="externalLink" title="Security">Security</a> | |
</li> | |
</ul> | |
<a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy"> | |
<img class="poweredBy" alt="Built by Maven" src="./images/logos/maven-feather.png" /> | |
</a> | |
</div> | |
</div> | |
<div id="bodyColumn"> | |
<div id="contentBox"> | |
<!-- ~ Licensed to the Apache Software Foundation (ASF) under one | |
~ or more contributor license agreements. See the NOTICE file | |
~ distributed with this work for additional information | |
~ regarding copyright ownership. The ASF licenses this file | |
~ to you under the Apache License, Version 2.0 (the | |
~ "License"); you may not use this file except in compliance | |
~ with the License. You may obtain a copy of the License at | |
~ | |
~ http://www.apache.org/licenses/LICENSE-2.0 | |
~ | |
~ Unless required by applicable law or agreed to in writing, | |
~ software distributed under the License is distributed on an | |
~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | |
~ KIND, either express or implied. See the License for the | |
~ specific language governing permissions and limitations | |
~ under the License. --> | |
<div class="section"><h2>Introduction<a name="Introduction"></a></h2> | |
<p> | |
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 Axis2). | |
Instructions on configuring IDEs for development and using Maven to | |
build the project is also included here. | |
</p> | |
</div> | |
<div class="section"><h2>Working with Subversion (SVN)<a name="Working_with_Subversion_SVN"></a></h2> | |
<p> | |
The Axis2 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 <a class="externalLink" href="http:///subversion.tigris.org">Subversion project | |
site</a>. If you are looking for guidance on setting up and | |
installing Subversion, please read the ASF <a class="externalLink" href="http://www.apache.org/dev/version-control.html">Source | |
Code Repositories page</a>. | |
</p> | |
</div> | |
<div class="section"><h2>Checkout Axis2 from Subversion<a name="Checkout_Axis2_from_Subversion"></a></h2> | |
<p> | |
To check out the latest version of Axis2 from the Foundation's | |
Subversion repository, you must use one of the following URLs | |
depending on your level of access to the Axis2 source code: | |
</p> | |
<ul> | |
<li><b>If you are not a committer:</b> <a class="externalLink" href="http://svn.apache.org/repos/asf/axis/axis2/java/core/trunk/">http://svn.apache.org/repos/asf/axis/axis2/java/core/trunk/</a></li> | |
<li><b>If you are a committer:</b> <a class="externalLink" href="https://svn.apache.org/repos/asf/axis/axis2/java/core/trunk/">https://svn.apache.org/repos/asf/axis/axis2/java/core/trunk/</a></li> | |
</ul> | |
<p> | |
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 <a class="externalLink" href="http://www.apache.org/dev/version-control.html">Source Code Repositories page</a>. | |
</p> | |
<p> | |
Once you have successfully installed Subversion, you can check | |
out Axis2 trunk by following these steps: | |
</p> | |
<ol style="list-style-type: decimal"> | |
<li>Run <b>svn co <repository URL> axis2</b> where | |
the repository URL is one of the URLs from the previous list.</li> | |
<li>This step will check out the latest version of the Axis2 Java | |
codebase to a directory named "axis2". The second parameter to the | |
<b>svn co</b> selects a directory to create on your local | |
machine. If you want to checkout Axis2 to a different directory, | |
feel free to change axis2 to any other directory name.</li> | |
<li>To update your working copy to the latest version from the | |
repository, execute the <b>svn update</b> command.</li> | |
<li>If you would like to submit a patch, you can execute | |
<b>svn diff</b> to create a unified diff for submission | |
to the Axis2 JIRA issue tracker.</li> | |
</ol> | |
</div> | |
<div class="section"><h2>Installing Maven 2<a name="Installing_Maven_2"></a></h2> | |
<p> | |
Axis2'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 <a class="externalLink" href="http://maven.apache.org">Maven project page</a>. | |
To use Maven to build the Axis2 project, Please install | |
<a class="externalLink" href="http://maven.apache.org/download.html">Maven2</a> and | |
follow instructions here - <a href="maven-help.html">Quick Guide to Maven for Axis 2.0</a>. | |
</p> | |
</div> | |
<div class="section"><h2>Configuring your IDE<a name="Configuring_your_IDE"></a></h2> | |
<p> | |
The Axis2 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 | |
Axis2 development. | |
</p> | |
<div class="section"><h3>Intellij IDEA<a name="Intellij_IDEA"></a></h3> | |
<p> | |
Type <b>mvn idea:idea</b>. Generates the necessary IDEA .ipr, .iml | |
and .iws project files. | |
</p> | |
</div> | |
<div class="section"><h3>Eclipse<a name="Eclipse"></a></h3> | |
<p> | |
We recommend using <a class="externalLink" href="http://maven.apache.org/plugins/maven-eclipse-plugin/">maven-eclipse-plugin</a> | |
to import the Axis2 sources into Eclipse. This works best with the following | |
combinations of versions and settings: | |
</p> | |
<ul> | |
<li> | |
Early versions of Maven 2 have issues with non standard packagings | |
(<tt>bundle</tt>, <tt>aar</tt> and <tt>mar</tt> in the case of Axis2) | |
in multi-module builds. While this has no impact on the normal Maven | |
build, it prevents the Maven Eclipse plugin from identifying modules | |
with these packagings as Java projects. Therefore it is recommended | |
to use Maven 2.2.x or 3.0.x to execute the Maven Eclipse plugin. | |
</li> | |
<li> | |
By default, the Maven Eclipse plugin only imports generated sources | |
and resources created during the <tt>generate-sources</tt> and | |
<tt>generate-resources</tt> phases, but fails to locate them if they | |
are generated during the <tt>generate-test-sources</tt> and | |
<tt>generate-test-resources</tt> phases. This is due to a limitation in Maven 2 (see | |
<a class="externalLink" href="http://jira.codehaus.org/browse/MECLIPSE-37">MECLIPSE-37</a> | |
for more information). Executing the <tt>eclipse:eclipse</tt> goal after | |
the <tt>process-test-resources</tt> phase is also not enough because of | |
<a class="externalLink" href="http://jira.codehaus.org/browse/MDEP-259">MDEP-259</a>. The | |
best is to execute it after the <tt>install</tt> phase. The <tt>skipTests</tt> | |
property can be used to skip the execution of the unit tests (<tt>maven.test.skip</tt> | |
is not appropriate here because it also skips some of the goals configured | |
in the <tt>generate-test-sources</tt> and <tt>generate-test-resources</tt> phases). | |
</li> | |
</ul> | |
<p> | |
To summarize, use the following command to prepare the Axis2 sources for | |
import into Eclipse: | |
</p> | |
<div><pre>mvn -DskipTests=true install eclipse:eclipse</pre></div> | |
<p> | |
As usual, before importing the projects into Eclipse, check that a Classpath Variable | |
for <tt>M2_REPO</tt> is configured in Eclipse. Then select File > Import > Existing Projects | |
into Workspace > Select root directory. Selecting the root of | |
the Axis source discovers all the modules and allows them to be | |
imported as individual projects at once. | |
</p> | |
</div> | |
</div> | |
</div> | |
</div> | |
<div class="clear"> | |
<hr/> | |
</div> | |
<div id="footer"> | |
<div class="xright">Copyright © 2004-2012 | |
<a href="http://www.apache.org/">The Apache Software Foundation</a>. | |
All Rights Reserved. | |
</div> | |
<div class="clear"> | |
<hr/> | |
</div> | |
</div> | |
</body> | |
</html> |