| <!DOCTYPE html> |
| |
| |
| <!-- |
| | Generated by Apache Maven Doxia Site Renderer 2.0.0 from src/site/xdoc/git.xml at 2025-03-05 |
| | Rendered using Apache Maven Fluido Skin 2.0.0-M11 |
| --> |
| <html xmlns="http://www.w3.org/1999/xhtml" lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1" /> |
| <meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0" /> |
| <title>Developing Apache Axis2 – Apache Axis2</title> |
| <link rel="stylesheet" href="./css/apache-maven-fluido-2.0.0-M11.min.css" /> |
| <link rel="stylesheet" href="./css/site.css" /> |
| <link rel="stylesheet" href="./css/print.css" media="print" /> |
| <script src="./js/apache-maven-fluido-2.0.0-M11.min.js"></script> |
| </head> |
| <body> |
| <div class="container-fluid container-fluid-top"> |
| <header> |
| <div id="banner"> |
| <div class="pull-left"><div id="bannerLeft"><h1><a href="http://www.apache.org/"><img class="class java.lang.Object" src="http://www.apache.org/images/asf_logo_wide.png" /> Apache Axis2</a></h1></div></div> |
| <div class="pull-right"><div id="bannerRight"><h1><a href="./"><img class="class java.lang.Object" src="images/axis.jpg" /></a></h1></div></div> |
| <div class="clear"><hr/></div> |
| </div> |
| |
| <div id="breadcrumbs"> |
| <ul class="breadcrumb"> |
| <li id="publishDate">Last Published: 2025-03-04<span class="divider">|</span> |
| </li> |
| <li id="projectVersion">Version: 2.0.0<span class="divider">|</span></li> |
| <li><a href="http://www.apache.org" class="externalLink">Apache</a><span class="divider">/</span></li> |
| <li><a href="index.html">Axis2/Java</a><span class="divider">/</span></li> |
| <li class="active">Developing Apache Axis2</li> |
| </ul> |
| </div> |
| </header> |
| <div class="row-fluid"> |
| <header id="leftColumn" class="span2"> |
| <nav class="well sidebar-nav"> |
| <ul class="nav nav-list"> |
| <li class="nav-header">Axis2/Java</li> |
| <li><a href="index.html">Home</a></li> |
| <li><a href="download.html">Downloads</a></li> |
| <li><a href="javascript:void(0)"><span class="icon-chevron-down"></span>Release Notes</a> |
| <ul class="nav nav-list"> |
| <li><a href="release-notes/1.6.1.html">1.6.1</a></li> |
| <li><a href="release-notes/1.6.2.html">1.6.2</a></li> |
| <li><a href="release-notes/1.6.3.html">1.6.3</a></li> |
| <li><a href="release-notes/1.6.4.html">1.6.4</a></li> |
| <li><a href="release-notes/1.7.0.html">1.7.0</a></li> |
| <li><a href="release-notes/1.7.1.html">1.7.1</a></li> |
| <li><a href="release-notes/1.7.2.html">1.7.2</a></li> |
| <li><a href="release-notes/1.7.3.html">1.7.3</a></li> |
| <li><a href="release-notes/1.7.4.html">1.7.4</a></li> |
| <li><a href="release-notes/1.7.5.html">1.7.5</a></li> |
| <li><a href="release-notes/1.7.6.html">1.7.6</a></li> |
| <li><a href="release-notes/1.7.7.html">1.7.7</a></li> |
| <li><a href="release-notes/1.7.8.html">1.7.8</a></li> |
| <li><a href="release-notes/1.7.9.html">1.7.9</a></li> |
| <li><a href="release-notes/1.8.0.html">1.8.0</a></li> |
| <li><a href="release-notes/1.8.1.html">1.8.1</a></li> |
| <li><a href="release-notes/1.8.2.html">1.8.2</a></li> |
| <li><a href="release-notes/2.0.0.html">2.0.0</a></li> |
| </ul></li> |
| <li><a href="modules/index.html">Modules</a></li> |
| <li><a href="tools/index.html">Tools</a></li> |
| <li class="nav-header">Documentation</li> |
| <li><a href="docs/toc.html">Table of Contents</a></li> |
| <li><a href="docs/installationguide.html">Installation Guide</a></li> |
| <li><a href="docs/quickstartguide.html">QuickStart Guide</a></li> |
| <li><a href="docs/userguide.html">User Guide</a></li> |
| <li><a href="docs/jaxws-guide.html">JAXWS Guide</a></li> |
| <li><a href="docs/pojoguide.html">POJO Guide</a></li> |
| <li><a href="docs/spring.html">Spring Guide</a></li> |
| <li><a href="docs/webadminguide.html">Web Administrator's Guide</a></li> |
| <li><a href="docs/migration.html">Migration Guide (from Axis1)</a></li> |
| <li class="nav-header">Resources</li> |
| <li><a href="faq.html">FAQ</a></li> |
| <li><a href="articles.html">Articles</a></li> |
| <li><a href="http://wiki.apache.org/ws/FrontPage/Axis2/" class="externalLink">Wiki</a></li> |
| <li><a href="refLib.html">Reference Library</a></li> |
| <li><a href="apidocs/index.html">Online Java Docs</a></li> |
| <li class="nav-header">Get Involved</li> |
| <li><a href="overview.html">Overview</a></li> |
| <li class="active"><a>Checkout the Source</a></li> |
| <li><a href="mail-lists.html">Mailing Lists</a></li> |
| <li><a href="release-process.html">Release Process</a></li> |
| <li><a href="guidelines.html">Developer Guidelines</a></li> |
| <li><a href="siteHowTo.html">Build the Site</a></li> |
| <li class="nav-header">Project Information</li> |
| <li><a href="team-list.html">Project Team</a></li> |
| <li><a href="issue-tracking.html">Issue Tracking</a></li> |
| <li><a href="https://github.com/apache/axis-axis2-java-core" class="externalLink">Source Code</a></li> |
| <li><a href="thanks.html">Acknowledgements</a></li> |
| <li class="nav-header">Apache</li> |
| <li><a href="http://www.apache.org/licenses/LICENSE-2.0.html" class="externalLink">License</a></li> |
| <li><a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink">Sponsorship</a></li> |
| <li><a href="http://www.apache.org/foundation/thanks.html" class="externalLink">Thanks</a></li> |
| <li><a href="http://www.apache.org/security/" class="externalLink">Security</a></li> |
| </ul> |
| </nav> |
| <div class="well sidebar-nav"> |
| <div id="poweredBy"> |
| <div class="clear"></div> |
| <div class="clear"></div> |
| <a href="https://maven.apache.org/" class="builtBy" target="_blank"><img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" /></a> |
| </div> |
| </div> |
| </header> |
| <main id="bodyColumn" class="span10"> |
| |
| |
| <section><a id="Introduction"></a> |
| <h1>Introduction</h1> |
| |
| <p> |
| This document provides information on how to use Git to get a |
| GitHub 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> |
| </section> |
| <section><a id="Working_with_GitHub_.28Git.29"></a> |
| <h1>Working with GitHub (Git)</h1> |
| |
| <p> |
| The Axis2 development team uses GitHub (Git) for source |
| control. |
| </p> |
| </section> |
| <section><a id="Checkout_Axis2_from_Git"></a> |
| <h1>Checkout Axis2 from Git</h1> |
| |
| <p> |
| To check out the latest version of Axis2 from the Foundation's |
| GitHub repository, you must use the following URL: |
| </p> |
| |
| <ul> |
| |
| <li><b>If you are a committer or not a committer, the link is the same:</b> <a href="https://github.com/apache/axis-axis2-java-core" class="externalLink">https://github.com/apache/axis-axis2-java-core</a></li> |
| </ul> |
| |
| <p> |
| Once you have successfully installed Git, you can check |
| out Axis2 trunk by following these steps: |
| </p> |
| |
| <ol style="list-style-type: decimal;"> |
| |
| <li>Run <strong>git clone <repository URL></strong> where |
| the repository URL from the previous list.</li> |
| |
| <li>This step will check out the latest version of the Axis2 Java |
| codebase to a directory named "axis-axis2-java-core".</li> |
| </ol> |
| </section> |
| <section><a id="Installing_Maven_3"></a> |
| <h1>Installing Maven 3</h1> |
| |
| <p> |
| Axis2's build is based on Maven 3. 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 3, please see the <a href="http://maven.apache.org" class="externalLink">Maven project page</a>. |
| To use Maven to build the Axis2 project, Please install |
| <a href="http://maven.apache.org/download.html" class="externalLink">Maven2</a> and |
| follow instructions here - <a href="maven-help.html">Quick Guide to Maven for Axis 2.0</a>. |
| </p> |
| </section> |
| <section><a id="Configuring_your_IDE"></a> |
| <h1>Configuring your IDE</h1> |
| |
| <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> |
| <section><a id="Intellij_IDEA"></a> |
| <h2>Intellij IDEA</h2> |
| |
| <p> |
| Type <strong>mvn idea:idea</strong>. Generates the necessary IDEA .ipr, .iml |
| and .iws project files. |
| </p> |
| </section> |
| <section><a id="Eclipse"></a> |
| <h2>Eclipse</h2> |
| |
| <p> |
| We recommend using <a href="http://maven.apache.org/plugins/maven-eclipse-plugin/" class="externalLink">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 |
| (<code>bundle</code>, <code>aar</code> and <code>mar</code> 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 <code>generate-sources</code> and |
| <code>generate-resources</code> phases, but fails to locate them if they |
| are generated during the <code>generate-test-sources</code> and |
| <code>generate-test-resources</code> phases. This is due to a limitation in Maven 2 (see |
| <a href="http://jira.codehaus.org/browse/MECLIPSE-37" class="externalLink">MECLIPSE-37</a> |
| for more information). Executing the <code>eclipse:eclipse</code> goal after |
| the <code>process-test-resources</code> phase is also not enough because of |
| <a href="http://jira.codehaus.org/browse/MDEP-259" class="externalLink">MDEP-259</a>. The |
| best is to execute it after the <code>install</code> phase. The <code>skipTests</code> |
| property can be used to skip the execution of the unit tests (<code>maven.test.skip</code> |
| is not appropriate here because it also skips some of the goals configured |
| in the <code>generate-test-sources</code> and <code>generate-test-resources</code> phases). |
| </li> |
| </ul> |
| |
| <p> |
| To summarize, use the following command to prepare the Axis2 sources for |
| import into Eclipse: |
| </p> |
| |
| <pre>mvn -DskipTests=true install eclipse:eclipse</pre> |
| |
| <p> |
| As usual, before importing the projects into Eclipse, check that a Classpath Variable |
| for <code>M2_REPO</code> 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> |
| </section> |
| </section> |
| |
| </main> |
| </div> |
| </div> |
| <hr/> |
| <footer> |
| <div class="container-fluid"> |
| <div class="row-fluid"> |
| <p>© 2004–2025 |
| <a href="https://www.apache.org/">The Apache Software Foundation</a> |
| </p> |
| </div> |
| </div> |
| </footer> |
| </body> |
| </html> |
