Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

WSO2 products, such as The source code of WSO2 Application Server are shipped as binary packs, which contains a wide variety of features to support your enterprise requirements. You can easily download the binary distribution, and get started with the product immediately. 

However, as developers, if you want to enhance or modify certain features in the product, or introduce completely new functionality, you can do that by downloading the source code, making the necessary changes and building your own customized product.

The following topics describe this process:

Table of Contents
maxLevel3

...

The following instructions explain how you can download the source code for WSO2 Application Server 5.3.0 release. The complete source code used for this product release consists of a number of Git repositories, which are listed below along with the relevant branch.

Follow the steps given below to download each of the above repositories for AS 5.3.0.

...

Clone the relevant Git repository to a folder of your choice. The location of the extracted source is referred to as <gitrepo_SOURCE_HOME>. For example, to clone the Git repository for Carbon4 Kernel, use the following command:
git clone https://github.com/wso2/carbon4-kernel.git <carbon4kernel_SOURCE_HOME>

...

Navigate to the <gitrepo_SOURCE_HOME> directory using the following command:
cd <gitrepo_SOURCE_HOME>

...

Note

After the source code is downloaded, you can start editing. However, it is recommended to run a build prior to changing the source code to ensure that the download is complete.

Editing the source code

Now that you have downloaded the source code for the AS project from GitHub, you can prepare your development environment and do the required changes to the code. 

  1. To edit the source code in your IDE, set up your development environment by running one of the following commands:

  2. Add the required changes to the source code.

...

Ensure that the following prerequisites are in place before you build:

  1. Make sure the build server has an active Internet connection to download dependencies while building.
  2. Install Maven and JDK. See Installation Prerequisites for compatible versions. 
  3. Set the environment variable  MAVEN_OPTS=”-Xms1024m -Xmx4096m -XX:MaxPermSize=1024m” to avoid the Maven OutOfMemoryError.

Use the following maven commands to build your product:

CommandDescription
mvn clean install

The binary and source distributions.

mvn clean install -Dmaven.test.skip=true The binary and source distributions, without running any of the unit tests.
mvn clean install -Dmaven.test.skip=true -o
The binary and source distributions, without running any of the unit tests, in offline mode. This can be done only if you have already built the source at least once.

Committing your changes

You can contribute to WSO2 products by committing your changes to GitHub. Whether you are a committer or a non-committer, you can contribute with your code as explained in the Get Involved sectionas well as all other WSO2 products are maintained in GitHub repositories. If you are a developer, you can clone the source code from these Git repositories, and if required, you can do modifications and build a customized product on your own. WSO2 invites interested parties to contribute their changes and suggestions to WSO2. 

See the documentation on working with the source code for more information.