Skip to main content

WSO2 ESB Quick Reference - part I

WSO2 ESB is a lean, enterprise ready mediation engine which is built on top of the award winning WSO2 Carbon platform. Under the hood, WSO2 ESB uses the Apache Synapse open source ESB. This blog post is a quick reference to the users who are using WSO2 ESB for various enterprise integration scenarios. Main goal of writing this post is to give users a place to find all the required configurations quickly without reading much documentation.

1. Download and start WSO2 ESB


You can download from official WSO2 web site here. Once you download the ESB, you can extract the archive(zip) to your preferred location. Let's take the extracted location as ESB_HOME. You can start the WSO2 ESB with the following command from inside the bin directory (ESB_HOME/bin).

sh wso2server.sh (wso2server.bat in Windows)

2. Important folders you need to know from the ESB_HOME directory.


ESB_HOME/bin - includes the scripts which can be used to start the WSO2 ESB as a standalone server or as a sample execution server. This also includes a script to start tcpmon which is a monitoring application which can be used to capture various messages flowing from and to ESB.

ESB_HOME/repository/conf - includes the configuration files which can be used to configure ESB for various requirements.
carbon.xml - contains the basic configurations which are used for configuring WSO2 ESB related parameters
axis2/axis2.xml  - contains the basic configurations which are used for configuring axis2 server related parameters

ESB_HOME/samples/axis2Server - contains a sample axis2 server which is used to execute samples which are described in the documentation for understanding the capabilities of the ESB.

ESB_HOME/samples/axis2Client - contains a sample axis2 client which is used to execute samples which are described in the documentation for understanding the capabilities of the ESB.

ESB_HOME/repository/components/lib - this directory is used to place custom or 3rd party libraries which are used in extending the capabilities of WSO2 ESB. (Ex: Custom mediator, MB integration)

ESB_HOME/repository/components/dropins - this directory is used to place custom or 3rd party libraries which are built as OSGI bundles for extending the capabilities of WSO2 ESB (Ex: Custom mediator)

ESB_HOME/repository/components/plugins - contains the libraries which are necessary to run the WSO2 ESB. Most of the implementation libraries are stored in this directory.

ESB_HOME/repository/components/patches - this directory is used to place all the official patches provided by WSO2 to fix or improve the WSO2 ESB. It contains directories which are names as patchXXXX and these folders need to be properly numbered when applying patches at different stages of your deployment.

3. Important command options you need to know when starting the WSO2 ESB


-DapplyPatches
This option can be used to apply the given patches in to WSO2 ESB

-Dsetup
Clean the Registry and other configuration, recreate DB, re-populate the configuration, and start Carbon.

--debug [port]
This option can be used to start WSO2 ESB with the debug mode.

-DosgiConsole=[port]
 Start Carbon with Equinox OSGi console. If the optional 'port' parameter is provided, a  telnet port will be opened.

-Dcarbon.logs.path=[path]
 Define the path to keep Log files.

--version      
The version of the product you are running.


Labels:

Comments

Post a Comment

Popular posts from this blog

Understanding Threads created in WSO2 ESB

WSO2 ESB is an asynchronous high performing messaging engine which uses Java NIO technology for its internal implementations. You can find more information about the implementation details about the WSO2 ESB’s high performing http transport known as Pass-Through Transport (PTT) from the links given below. [1] http://soatutorials.blogspot.com/2015/05/understanding-wso2-esb-pass-through.html [2] http://wso2.com/library/articles/2013/12/demystifying-wso2-esb-pass-through-transport-part-i/ From this tutorial, I am going to discuss about various threads created when you start the ESB and start processing requests with that. This would help you to troubleshoot critical ESB server issues with the usage of a thread dump. You can monitor the threads created by using a monitoring tool like Jconsole or java mission control (java 1.7.40 upwards). Given below is a list of important threads and their stack traces from an active ESB server.  PassThroughHTTPSSender ( 1 Thread )
2 comments
Read more

WSO2 ESB tuning performance with threads

I have written several blog posts explaining the internal behavior of the ESB and the threads created inside ESB. With this post, I am talking about the effect of threads in the WSO2 ESB and how to tune up threads for optimal performance. You can refer [1] and [2] to understand the threads created within the ESB. [1] http://soatutorials.blogspot.com/2015/05/understanding-threads-created-in-wso2.html [2] http://wso2.com/library/articles/2012/03/importance-performance-wso2-esb-handles-nonobvious/ Within this blog post, I am discussing about the "worker threads" which are used for processing the data within the WSO2 ESB. There are 2 types of worker threads created when you start sending the requests to the server 1) Server Worker/Client Worker Threads 2) Mediator Worker (Synapse-Worker) Threads Server Worker/Client Worker Threads These set of threads will be used to process all the requests/responses coming to the ESB server. ServerWorker Threads will be used to pr
3 comments
Read more

How to configure timeouts in WSO2 ESB to get rid of client timeout errors

WSO2 ESB has defined some configuration parameters which controls the timeout of a particular request which is going out of ESB. In a particular  scneario, your client sends a request to ESB, and then ESB sends a request to another endpoint to serve the request. CLIENT->WSO2 ESB->BACKEND The reason for clients getting timeout is that ESB timeout is larger than client's timeout. This can be solved by either increasing the timeout at client side or by decreasing the timeout in ESB side. In any of the case, you can control the timeout in ESB using the below properties. 1) Global timeout defined in synapse.properties (ESB_HOME\repository\conf\) file. This will decide the maximum time that a callback is waiting in the ESB for a response for a particular request. If ESB does not get any response from Back End, it will drop the message and clears out the call back. This is a global level parameter which affects all the endpoints configured in ESB. synapse.global_timeout_inte
1 comment
Read more