This site contains the documentation that is relevant to older WSO2 product versions and offerings.
For the latest WSO2 documentation, go to

Event-Driven Consumer

This section explains, through an example scenario, how the Event-Driven Consumer EIP can be implemented using the ESB Profile of WSO2 Enterprise Integrator (WSO2 EI). The following topics are covered:

Introduction to Event-Driven Consumer 

The Event-Driven Consumer EIP allows an application to automatically consume messages as they become available. For more information, refer to

Figure 1: Event-Driven Consumer EIP 

Example scenario

This EIP is also referred to as an asynchronous receiver. This example scenario demonstrates how an event will be triggered based on the availability of the receiver and a message will be consumed by the receiver.

The diagram below depicts how to simulate the example scenario using the ESB Profile of WSO2 EI.

Figure 2: Example Scenario of the Event-Driven Consumer EIP

Before digging into implementation details, let's take a look at the relationship between the example scenario and the Event-Driven Consumer EIP by comparing their core components.

Event-Driven Consumer EIP (Figure 1)Event-Driven Consumer Example Scenario (Figure 2)
SenderSimple Stock Quote Client
MessageSimple Stock Quote Request
Event Driven ConsumerEvent Mediator
ReceiverSimple Stock Quote Service

Environment setup

  1. Download and install the ESB Profile of WSO2 Enterprise Integrator (EI). For a list of prerequisites and step-by-step installation instructions, go to Installing the Product in WSO2 EI Documentation.
  2. Start an instance of Sample Axis2 server. For instructions, go to Starting the Axis2 server in WSO2 EI Documentation.
  3. Follow the steps below to create an event.
    • Start the ESB Profile and log into its management console UI (https://localhost:9443/carbon ).
    • Select the Topics menu from the Main menu and then select the Add sub menu.
    • Enter EventConsumerTopic as the name of the topic, and then click Add Topic.
    • Click EventConsumerTopic in the topic browser tree, and then click Subscribe to create a static subscription.
    • Enter the value http://localhost:9000/services/SimpleStockQuoteService in the Event Sink URL field and click Subscribe.

ESB configuration

On the Management Console of the ESB Profile, navigate to the Main menu and click Source View in the Service Bus section . Next, copy and paste the following configuration to the source view. Then you can explore the example scenario 

<definitions xmlns="">
   <sequence name="fault">
      <log level="full">
         <property name="MESSAGE" value="Executing default &#34;fault&#34; sequence"/>
         <property name="ERROR_CODE" expression="get-property('ERROR_CODE')"/>
         <property name="ERROR_MESSAGE" expression="get-property('ERROR_MESSAGE')"/>
   <sequence name="main">
      <event topic="EventConsumerTopic"/>

Simulating the sample scenario

  1. Send a request using the Stock Quote client to the ESB as follows:

    ant stockquote -Dtrpurl=http://localhost:8280 -Dsymbol=foo

    For information on the Stock Quote Client and its operation modes, see Stock Quote Client in the WSO2 EI Documentation.

  2. After sending the request, note that a message accepting the request is displayed on the Stock Quote service's console. This is triggered as an event when the message is published into the topic EventConsumerTopic that you created earlier. All subscribers will receive the topic. 

How the implementation works

Let's investigate the elements of the ESB configuration in detail. The line numbers below are mapped with the ESB configuration provided above.

  • event [line 13 in ESB config] - Allows you to define a set of subscribers to receive messages when the topic subscribes to receives a message. Also, see Eventing.