How to install WSO2 Carbon Studio 1.0.0 in Eclipse

This short tutorial will explain how to install WSO2 Carbon Studio in Eclipse. WSO2 Carbon Studio is a comprehensive set of SOA tools, which are developed for the popular IDE, Eclipse. This gives a powerful environment to develop, test, deploy and run WSO2 Carbon based artifacts.
Date: Fri, 8th Oct, 2010
Level: Introductory
Reads: 4083 Comments: 0 | Login or register to post comments
Chathuri Wimalasena
Senior Software Engineer
WSO2
chathuriw's picture

Step 1

Download Eclipse IDE for Java EE Developer and extract it. You can use Eclipse Galileo or Eclipse Helios. If you are on windows start eclipse by double clicking eclipse.exe and if you are on linux, strat eclipse in the command line by running the command ./eclipse. When eclipse is starting, it will ask you to select a workspace location. You can point any folder for this.

After giving the workspace location, you will see your eclipse workbench as given below.

Step 2

You can install Carbon Studio in eclipse in two ways. One method is to download wso2-carbon-studio_1.0.14.zip and the other method is point to online update site for the installation.  To install, click on Help -> Install New Software.

Now you will get the Install wizard as below.

Select Add and you will get a dialog where you can point the archive file that you have downloaded or online repository URL.

For the Location text box, you can select the archive file you have downloaded by clicking on the Archive button or you can just point the online repo url. Select the preferred method and click OK.

 

Step 3

Now you will see, all the available features that are listed under the main category of WSO2 Carbon Studio. If you expand the main category, you will see the available tools related to each product.

If you select the main item WSO2 Carbon Studio, all the features included within will be installed. But with Carbon Studio, you have the capability to install features as per the product wise as well. Suppose you want only the Enterprice Service Bus (ESB) related tools, then you donot need to install full WSO2 Carbon Studio. You can select features releated ESB only. There are set of basic features that are common to all products. For example, running WSO2 Carbon Server inside eclipse can be considered as a common feature. Similarly you have to install Carbon Application Tools feature, no matter what product you have chosen since it is the Carbon Studio core feature which gives you the ability to create carbon application projects and carbon artifacts.

Let me give you a brief introduction of each feature that is available in Carbon Studio. If we list all the features, we have about ten features.

  • Business Process Server Tools  - Tools related to creating BPEL artifacts. This feature will integrate Eclipse BPEL Editor plugin as well.
  • Carbon Application Tools - Core carbon studio feature which gives you the capability to create carbon application projects  and artifacts. This can be considered as the foundation of all the other tools.
  • Carbon Server 3.0.x Tools - This feature gives you the capability to run Carbon 3.0.x based servers inside Eclipse.
  • Carbon Server 3.1.x Tools - Gives you the ability to run Carbon 3.1.x based servers inside Eclipse.
  • Carbon UI Component Tools - With this you can create Carbon UI components.
  • Data Services Tools - Tools related Data Services Server. With this you can create data service artifacts pointing to a data service descriptor (.dbs) file. You can edit and view your data service descriptor file with graphical tree view provided. You can create data services validator artifacts as well. 
  • Enterprise Service Bus Tools - This includes all the ESB related tools which provide you the ability to create sequences, proxy services, endpoints, local entries, synapse configurations etc. You can view and update created artifacts with the help of user friendly graphical editor in a very user friendly manner. At the same time, you can create ESB custom mediators as well.
  • Gadget Editor, Deployment and Testing Tools - This feature gives you the capability to create gadget artifacts with the integrated Open Social Development Environment Plugin which enables a gadget editor, deployment and testing.
  • Governance Registry Tools - With this feature you can create registry artifacts and browse a registry instance which is running remotely or locally. You have the capabilty to add resources, collections, check-in and utilize most of the governance registry related functionalities. At the same time we have the support for registry filters and registry handlers as advanced extensions.
  • Web Service Application Server Tools - This includes features related to Web Service Application Server. You can create Axis2 Services pointing a Java class,  axis2 archive file or web services project in the workspace. You have the capability to create a web service client and Axis2RPC Message Recievers as well.

 If you want to install customized Carbon Studio feature, project vise, what you have to do is select  the feature related to the preferred project, Carbon Application Tools and Carbon Server Tools. You may need to select Governance Registry Tools if you want to browse the registry while you are creating artifacts. 

In this tutorial, we will install the full Carbon Studio feature list for demonstration. Tick WSO2 Carbon Studio and you will see that all the other features get selected automatically. You may un-tick Contact all update sites during install to find required software if you are in Eclipse Helios. If you tick this, during the installation process, it will search for available plugins online and it can slow down the installation. If you are using latest Eclipse Java EE developer IDE it is recommended to deselect this option in order to install within a few minutes.

Click Next to navigate to the next step of the installation process.

 Step 4

All the features selected by you during the installation will be listed down here. Click Next.

Step 5

Accept Apache License and click Finish.

Step 6

You will see the installation in progress.

While the installation, you may get a security warning due to not signing the plugins. For the time being accept it and proceed.

When the installation is done, it will ask to restart or apply changes to the workspace. You can select either of them.

Next verify whether everything has been installed perfectly, by selecting File -> New -> Other. You will see a new catogery called WSO2 which includes sub catogeries like Artifacts, Carbon, DataService, ESB, Registry, WSAS, Other.

Congratulations !!!  You have successfully installed WSO2 Carbon Studio in Eclipse.