Monday, May 18, 2009

Let's build WSO2 Carbon from source code (For newbies to WSO2 Carbon)

WSO2 Carbon is the base platform for all WSO2 Java products.

Built on OSGi, Currently In Carbon there are 4 main SOA functionalities. They are as follows.

  1. WSO2 Web Services Application Server (WSAS)
  2. WSO2 Enterprise Service Bus (ESB)
  3. WSO2 Registry
  4. WSO2 Business Process Server (BPS)
Here are some advantages of building a Open Source Software from the source

If you are willing to develop WSO2 Carbon , it is essential to build WSO2 Carbon from source rather than using a binary distribution. Building from source ensures that the source exists and compiles properly, which is the basis of regular open-source development.

By compiling from source, if you find some code you are able to isolate patches to address such problems, without having to wait for upstream.

Although bytecode runs on every vm that supports the version of the bytecode in question it does not mean that the bytecode produced by different compilers is equal. Bytecode can be optimized too. By building from source, we make it easy to switch the compiler used to compile your installed java programs.

Let's start build Carbon from source code

First of all you need Subversion (SVN) which is a version control system widely used in open source software development. You can install SVN from here based on your operating system.

Then also you need to install the build tool called Apache Maven. It is a open source Apache build manager for java projects. You can install Apache Maven from here.

Go to WSO2 Oxygen Tank SVN repository. Here you will see all the SVN repositories for all WSO2 products.

For WSO2 Carbon you have to checkout the following SVN repositories one by one to a specific location in local hard disk.

For that use "svn checkout" command.
e.g. ...../carbon$ svn checkout
Now there will be a directory structure created as as follows.

Then you will realise that there is a specific directory for each checkout you made. In each of those dirctoriers you will find (at the root level) a file called "pom.xml". It represent the complete Maven project and using that you can build the project from the source code.

Before build the project first of all we need to install the following plugins and modules which enables you to build the above project source codes successfully. Those plugins source codes are also get downloaded when checking out the repository. You just have to install them using Maven.

For that go to "axis2" directory which is the first checkout you made. In that go to "modules/tool".
There you can see "axis2-aar-maven-plugin" and "axis2-mar-maven-plugin" named directories. In those directories you will see the pom.xml file for each. You have to go to those directories one at a time and build those plugins using Apache Maven with following commands in the console.

mvn clean install
(This is a command in Maven use to build the project with the help of "pom.xml" file and for more information use this Quick Guide)
After successfully install those plugins you can start to build the above checkedout projects one by one.

In console use command "mvn clean install -Dmaven.test.skip=true" in the root level of each directory as follows.

e.g. To build "axis2" go to the "axis2" directory , which is the directory the source is checked out from the repository
. In console use the command as follows.

  • $current-location/axis2$ mvn clean install -Dmaven.test.skip=true

Such that use the following commands under the given directories with the given sequence.

  • To build transports-> $curr.-location/2.0/transports$ mvn clean install -Dmaven.test.skip=true
  • To build wss4j-> $curr.-location/2.0/wss4j$ mvn clean install -Dmaven.test.skip=true
  • To build rampart-> $curr.-location/2.0/rampart$ mvn clean install -Dmaven.test.skip=true
  • To build sandesha-> $curr.-location/2.0/sandesha$ mvn clean install -Dmaven.test.skip=true
  • To build savan-> $curr.-location/2.0/savan$ mvn clean install -Dmaven.test.skip=true
  • To build synapse-> $curr.-location/2.0/synapse$ mvn clean install -Dmaven.test.skip=true
  • To build carbon-orbit-> $curr.-location/carbon-orbit$ mvn clean install -Dmaven.test.skip=true
  • To build carbon-> $curr.-location/carbon$ mvn clean install -Dmaven.test.skip=true
  • To build -carbon-components> $curr.-location/carbon-components$ mvn clean install -Dmaven.test.skip=true

Note - You have to build those 10 soucre directories one at a time and according to the given sequence as the later project source codes are depend on a prior project source codes. "ode" and "xmlsec" source directories are not required to be built.

After successfully building all 10 projects' source codes WSO2 Carbon is built from the source.

As well you can create IDE(Eclipse, IDEA, NetBeans) based projects using the Maven plugins.



Good work bro.
Keep it up.

Krishantha said...

Thanks lot denis..

If anybody get

[INFO] Error executing ant tasks

Embedded error: Warning: Could not find file /home/krishantha/svn/1.6-carbon/axis2/modules/addressing/target/addressing-1.5.mar to copy.

solution: please update the maven to 2.1.0

Anonymous said...
This comment has been removed by a blog administrator.
Matthew said...

Thanks for posting this. I would not have attempted this build without your instructions. they have gotten me nearly through the entire build, but I have run into a missing artifact during the build of carbon-components.
1) org.apache.ode.wso2:ode:jar:2.1.0.SNAPSHOT-wso2v1

Any clues as to where I might find this jar or how to build it so the build can find and use it?

Denis Weerasiri said...

@Matthew, Sorry for the delayed reply,
You need to build "ode" in "carbon-orbit". In root level pom.xml (in carbon-orbit directory) this "ode" is ignored to build as it needs to build only one carbon-component("bpel" in "carbon-component" directory). You have to manually build the "ode" located at the "carbon-orbit". Then the bundle you mentioned is created. Hope this will help.

Anonymous said...

Hello, i have followed your instructions step by step but, i still get the following error when building Synapse

#[INFO] ------------------------------------------------------------------------
[INFO] ------------------------------------------------------------------------
[INFO] Failed to resolve artifact.

1) org.wso2.caching:wso2caching-core:jar:3.1-SNAPSHOT

Try downloading the file manually from the project website.

Then, install it using the command:
mvn install:install-file -DgroupId=org.wso2.caching -DartifactId=wso2cachi
ng-core -Dversion=3.1-SNAPSHOT -Dpackaging=jar -Dfile=/path/to/file

could you help me please.
thanks in advanced

Matthew said...

@rodo Before building synapse, I had to build both

@Denis I have success! I think... The build process completed successfully, but I have not figured out where it put the project output so I can run it and test the Carbon platform with WSAS, ESB, Registry, and BPS. Do you have any tips for locating and running the output of the build?

Anonymous said...

thanks a lot for your fast answer. I did what you told me but now i get a new error when building carbon-components. i have already built "ode" in "carbon-orbit" but doesnt seem to help much.
[INFO] ------------------------------------------------------------------------
[INFO] ------------------------------------------------------------------------
[INFO] Failed to resolve artifact.

1) org.wso2.rule:rule-core:jar:1.0.0.SNAPSHOT

Try downloading the file manually from the project website.

Then, install it using the command:
mvn install:install-file -DgroupId=org.wso2.rule -DartifactId=rule-core -D
version=1.0.0.SNAPSHOT -Dpackaging=jar -Dfile=/path/to/file

thanks in advanced

Anonymous said...

thank to this blog i have managed to build carbon thank you a lot. Butnow the question is, how do i start it and how do i merge it with the other components like the registry? I would be very thankful if someone could post how to do this here or in the wso2 forum.

Denis Weerasiri said...

@Matthew, @rodo, Hi all,
First of all thanks for all your comments.

This comment will help to build other WSO2 products as well.

Regarding moving into other components like WSAS, ESB, BPS etc is pretty much same.
WSO2 Carbon is the platform for all the products I mentioned before.
Suppose if you wanna build a BPS component, then you need some carbon components(not all) related to BPS product and the carbon core bundles.

So just checkout the source code of the product (for BPS-
eg - svn checkout wso2-bps

For other products go to and you will find all the svn locations, for other products as well.
Now you will find the root level pom.xml.
Now run mvn clean install -Dmaven.test.skip=true.

After successfully building the WSO2 BPS, in "distribution/target" inside WSO2 BPS source you will find the WSO2 BPS product, which can be extracted and run.
If you go in to the "webapps/ROOT/WEB-INF/plugins/" in the extracted zip. You will find the carbon bundles which were built previously when building wso2-carbon are now in the BPS product.
Your custom bundles also can be added to there so that you can customize the product based on your own needs.

@Matthew- Thanks for mentioning to build 2.0\commons\caching and 2.0\commons\throttle. I'll modify the blog post.

Questions and feedbacks are more than welcome.

Kamakshi B said...

Kamakshi B (TCS):
We tried to create the binary from the wso2 source code (governance registry),referred to your blog which was quite helpful. But faced issues with respect to proxy settings - especially while doing a maven-clean/install, which would try to download certain artifacts from the external URLs mentioned in the POM.xml of the WSO2 maven projects.
Sorted it out by getting the required artifacts available in local nexus repository and changed the pom.xml to point to local URLs.
Thanks anyway!

Denis Weerasiri said...

Hi Kamakshi B,
So you were able to build WSO2 GReg?. Because this blog post is quite old the exact sequence may not work. So if you have troubles, please let me know.