How to add a WSO2 Carbon Server to Carbon Studio

You can add WSO2 Carbon Servers to Carbon Studio and deploy, un-deploy artifacts created within it. This is how its done.

1. You need to have a binary distribution of a WSO2 Carbon Server with you. For this post I will be using WSO2 Gadget Server. Download it from here and extract.

2. Install Carbon Studio in you Eclipse IDE as described in here.

3. In the 'Server view', right click and Select New > Server and the "New Server" wizard will appear.

4. Scroll down in the servers types until you see 'WSO2' at the very bottom. Expand this and there will be two server types. 
   i. WSO2 Carbon 3.0.1 based Server
  ii. WSO2 Carbon 3.1 based Servers
Select the server type based on the binary you had extracted in step 1 above. I will be using 'WSO2 Carbon 3.0.1 based Server' which matches the distribution I downloaded in step 1.

5. After selecting the server type, you can change the 'Server's host name', 'Server Name' if you want or can leave with defaults.

6. Then we need to set the 'Server runtime environment'. Click on the 'Add..' link next to 'Server runtime environment' field and it will open up a window for you to select the runtime.

In this, browse for you Carbon Home, that is you need to browse for the location where you extracted the Carbon Server distribution. Press 'Finish' and return to parent window.

7. In the parent window proceed to the next step, where it asks you to set the ports for your server. You can accept default or change as you wish. In my case I am changing the first two ports as the Gadget Server runs on 8080/8443 by default.

You also can enable options such as;
  i. Bring up the carbon home in the browser when this server starts -
This will launch the server's admin console in you browse.

 ii. Enable hot update of published server modules -
Hot update feature will be enabled where all changes you do to your deployed modules will be updated then and there (without you restarting the server).

iii.Enable osgi console -
osgi prompt will appear at the server start-up and you will be able run osgi commands on the start-up console.

8. In the next step it will give you a panel where you can add/remove applications to your server. For the time being let's not add applications now and we'll only start the server. So press 'Finish'.

9. Now you'll find your server appearing in the 'Server view'. Right click on it and select start from the menu. And the server will be gracefully started !.

Author : Yumani Ranaweera, Associate Technical Lead, WSO2 Inc.