This documentation is for WSO2 Enterprise Service Bus version 4.8.1 . View documentation for the latest release.

All docs This doc

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Introduction

This sample introduces the concept of tasks and demonstrates how a simple trigger works. Here the MessageInjector class is used, which injects a specified message to the ESB environment. You can write your own task class implementing the org.apache.synapse.startup.Task interface and implement the execute method to run the task.

Prerequisites

For a list of prerequisites, see Prerequisites to Start the ESB Samples.

Building the sample

The XML configuration for this sample is as follows: 

Code Block
languagehtml/xmllinenumberstrue
<?xml version="1.0" encoding="UTF-8"?>
<definitions xmlns="http://ws.apache.org/ns/synapse">
    <task class="org.apache.synapse.startup.tasks.MessageInjector" name="CheckPrice">
        <property name="to" value="http://localhost:9000/services/SimpleStockQuoteService"/>
        <property name="soapAction" value="urn:getQuote"/>
        <property name="message">
            <m0:getQuote xmlns:m0="http://services.samples" xmlns="http://ws.apache.org/ns/synapse">
                <m0:request>
                    <m0:symbol>IBM</m0:symbol>
                </m0:request>
            </m0:getQuote>
        </property>
        <trigger interval="5"/>
    </task>
    <sequence name="main">
        <in>
            <send/>
        </in>
        <out>
            <log level="custom">
                <property name="Stock_Quote_on" expression="//ns:return/ax21:lastTradeTimestamp/child::text()"
                          xmlns:ax21="http://services.samples/xsd" xmlns:ns="http://services.samples"/>
                <property name="For_the_organization" expression="//ns:return/ax21:name/child::text()"
                          xmlns:ax21="http://services.samples/xsd" xmlns:ns="http://services.samples"/>
                <property name="Last_Value" expression="//ns:return/ax21:last/child::text()"
                          xmlns:ax21="http://services.samples/xsd" xmlns:ns="http://services.samples"/>
            </log>
        </out>
    </sequence>
</definitions>

Objective:

Introduce the concept of tasks and how simple trigger works.

Prerequisites:

You will need access to build the SimpleStockQuoteService as mentioned above and start the sample axis2 server before staring ESB.

When ever ESB gets This configuration file  synapse_sample_300.xml is available in the <ESB_HOME>/repository/samples directory.

To build the sample

  1. Build and deploy the back-end service SimpleStockQuoteService. For instructions on deploying sample back-end services, see Deploying sample back-end services.

  2.  Start the Axis2 server. For instructions on starting the Axis2 server, see Starting the Axis2 server.

Executing the sample

The synapse_sample_300.xml configuration adds a scheduled task to the ESB runtime. When the ESB is started and initialized, this task will run periodically in every 5 second intervals. You could can limit the number of times that you want the task to run this task by adding a count attribute with an integer as the value, if . If the count is not present as in this sample this , the task will run forever.

You can write your own task class implementing the org.apache.synapse.startup.Task interface and implementing the execute method to do the task. For this particular sample, we have used the MessageInjector, which just injects a message specified in to the ESB environment.

...

hiddentrue

...

Analyzing the output

You will see that the Axis2 server generates a quote every 5 seconds and that the ESB receives the stock quote response. This is because the injected message is sent to the sample Axis2 server which sends back a response to the ESB.