Creating a JSON client for AXIS2

This post will try to explain how to develop a sample for Axis2 that uses the JSON module in Axis2. Before you read this blog post read this article to get a understanding about Axis2 JSON module
Creating the folder structure

Before we start to do anything lets create the folder structure that will be needed to create the sample. For this sample we will create a folder structure simmilar to the structure given below

The resources folder will contain the axis2.xml and the Java code will be added in to src/samples/googleservices/JSONSearch. We will look into each part separately.

Before we start working on the sample there are a few simple things that we have to do. Since we will be using the Yahoo Boss API to retrive the search results in JSON format, we need to acquire a API-Key that is needed when using the Boss API. You can create a Yahoo Boss API-Key here, this should not take more than 5 minutes if you already have a Yahoo account.
Now that we have a Yahoo Boss API-Key we can go onto implementing the sample. First lets take a look at the java class that does all the logic of the sample we will name the class "JSONSearchModel". 

package sample.yahooservices.JSONSearch;
package sample.yahooservices.JSONSearch;

import org.apache.axis2.Constants;
import org.apache.axis2.transport.http.HTTPConstants;
import org.apache.axis2.context.ConfigurationContextFactory;
import org.apache.axis2.context.ConfigurationContext;
import org.apache.axis2.addressing.EndpointReference;
import org.apache.axis2.client.Options;
import org.apache.axis2.client.ServiceClient;

import java.util.Iterator;

public class JSONSearchModel {
     * HTML Header to desplay snippet text
    private String beginHTML = "Search Results";

     * HTML footer
    private String endHTML = "";

     * Store the texts read by NavigationURL of soap
    private String snippet;

    * The App id 
    private final static String appIdString = "YOUR_API_KEY";

    public String searchYahoo(String query, String format) {
        try {
            snippet = beginHTML;
     query = query.replaceAll(" ","%20");
            String epr = ""+query;
            File configFile = new File("resources/axis2.xml");
            ConfigurationContext configurationContext = ConfigurationContextFactory
                    .createConfigurationContextFromFileSystem(null, configFile

            ServiceClient client = new ServiceClient(configurationContext, null);
            Options options = new Options();
            options.setTo(new EndpointReference(epr));
            options.setProperty(Constants.Configuration.MESSAGE_TYPE, HTTPConstants.MEDIA_TYPE_X_WWW_FORM);
            options.setProperty(Constants.Configuration.HTTP_METHOD, Constants.Configuration.HTTP_METHOD_GET);
            OMElement response = client.sendReceive(getPayloadForYahooSearchCall(query, format));
            return snippet;

        } catch (Exception e) {
            snippet = "<h2>Error occurred during the invocation to Yahoo search service</h2>" +
                    "" + e.getMessage() + "
" + endHTML;
        return snippet;

    private static OMElement getPayloadForYahooSearchCall(String queryStr, String formatStr) throws UnsupportedEncodingException {
        OMFactory fac = OMAbstractFactory.getOMFactory();
        OMElement rootElement = fac.createOMElement("webSearch", null);

        OMElement appId = fac.createOMElement("appid", null, rootElement);

        OMElement outputType = fac.createOMElement("format", null, rootElement);

        if (formatStr != null && formatStr.length() != 0) {
            OMElement format = fac.createOMElement("format", null, rootElement);
            format.setText(URLEncoder.encode(formatStr, "UTF-8"));
        return rootElement;

    private void generateSnippet(OMElement response) {
        String title = null;
        String summary = null;
        String clickUrl = null;
        String url = null;
        OMElement result = null;
        //get an iterator for Result elements
        Iterator itr = response.getChildElements();
        Iterator innerItr;
        while (itr.hasNext()) {
            result = (OMElement);
            innerItr = result.getChildElements();
            if (innerItr.hasNext()) {
                title = ((OMElement);
                summary = ((OMElement);
                url = ((OMElement);
                clickUrl = ((OMElement);
                if (title != null) {
                    snippet += ""+title+""+summary+url;
        snippet += endHTML;

This is the code snippet for the "JSONSearchModel" class, lets take a look at each part of the class separately. As you can see we have our API-Key as a string that will be used later.
now lets take a look at the method "searchYahoo" this method takes in two String parameters query and format, query is the search query specified by the user and the format is the data retrieval format in this case it would be JSON. Then using the query the endpoint reference is created(this is because the Boss API v1 does not specify the query as a parameter). Then a service client is created using configurations specified in the axis2.xml (we will look at the axis2.xml later) then the options are set such as the message type and Http method in this case that is GET. Then using the "getPayloadForYahooSearchCall" method to create a OMElement that has all the parameter including the API-Key and data format a request is send through the client and a response OMElement is received and this OMElement is parsed using method "generateSnippet" to create a  HTML snippet.

This snippet is displayed in the UI. The following two class are used to generate the user interface i will not go into explaining the logic in these classes.
package sample.yahooservices.JSONSearch;

import javax.swing.*;
import javax.swing.event.HyperlinkListener;
import javax.swing.event.HyperlinkEvent;
import java.awt.*;
import java.awt.event.ActionListener;
import java.awt.event.ActionEvent;

public class UserInterface extends JPanel implements HyperlinkListener {

    private JEditorPane jep;
    private JScrollPane scrollPane;

    private JTextField schField;
    private JTextField formatField;

    private JButton schButton;
    private JButton backButton;

    private JLabel schLabel;
    private JLabel formatLabel;

    private JSONSearchModel model;
    private JSONSearchClient parent;

    private String response;
    public UserInterface(JSONSearchClient parent) {
        this.parent = parent;
        model =  new JSONSearchModel();

        schButton.addActionListener(new ActionListener() {
            public void actionPerformed(ActionEvent e) {

        backButton.addActionListener(new ActionListener() {
            public void actionPerformed(ActionEvent e) {

        Container pane = parent.getContentPane();


    public void initComponents() {
        schLabel = new JLabel("Search for");
        schLabel.setBounds(20, 10, 80, 25);
        schField = new JTextField();
        schField.setBounds(90, 10, 250, 25);

        formatLabel = new JLabel("format");
        formatLabel.setBounds(350, 10, 50, 25);
        formatField = new JTextField();
        formatField.setBounds(400, 10, 100, 25);

        backButton = new JButton("Back to Results");
        backButton.setBounds(670, 10, 150, 25);

        schButton =  new JButton("Search");
        schButton.setBounds(510, 10, 150, 25);

        jep = new JEditorPane();

        scrollPane = new JScrollPane(jep);
        scrollPane.setBounds(10, 80, (JSONSearchClient.width - 30), (JSONSearchClient.height - 160));


    private void handleSearch(){
        String query = schField.getText();

            response = model.searchYahoo(query, formatField.getText());

    private void handleBack(){

    public void hyperlinkUpdate(HyperlinkEvent he) {
        if (he.getEventType() == HyperlinkEvent.EventType.ACTIVATED) {
            try {
            catch (Exception e) {
                  JOptionPane.showMessageDialog(parent, "Page could not be loaded",
                                "Page Error", JOptionPane.ERROR_MESSAGE);


package sample.yahooservices.JSONSearch;

import javax.swing.*;
import java.awt.*;

public class JSONSearchClient extends JFrame {
    public static int width;
    public static int height;

    public JSONSearchClient(String title) throws HeadlessException {

        this.getContentPane().add(new UserInterface(this));

    public static void main(String[] args) {
        Dimension screenSize = Toolkit.getDefaultToolkit().getScreenSize();
        width = screenSize.width;
        height = screenSize.height;
        JSONSearchClient form = new JSONSearchClient("Axis2 Yahoo-JSON Search Client");

        int left = (width) / 2;
        int top = (height) / 2;
        form.setLocation(left, top);
        form.setSize(width, height);


Now lets take a look at the axis2.xml configuration file. This is where all the configuration information is specified. We will look at the important parts of the xml and explain why they are there.I have also removed the comments that were included in the axis2.xml but comments are there in the zip file of the sample.
<axisconfig name="AxisJava2.0">
    <parameter name="hotdeployment">true</parameter>
    <parameter name="hotupdate">false</parameter>
    <parameter name="enableMTOM">false</parameter>
    <parameter name="enableSwA">false</parameter>
    <parameter name="ConfigContextTimeoutInterval">30</parameter>
    <parameter name="sendStacktraceDetailsWithFaults">false</parameter>
    <parameter name="DrillDownToRootCauseForFaultReason">false</parameter>
    <parameter name="userName">admin</parameter>
    <parameter name="password">axis2</parameter>
    <parameter name="manageTransportSession">false</parameter>

    <parameter locked="true" name="enableRESTInAxis2MainServlet">false</parameter>

    <parameter locked="true" name="disableREST">false</parameter>

    <parameter locked="true" name="disableSeparateEndpointForREST">false</parameter>

        <messagereceiver class="org.apache.axis2.receivers.RawXMLINOnlyMessageReceiver" mep="">
        <messagereceiver class="org.apache.axis2.receivers.RawXMLINOutMessageReceiver" mep="">
        <messageformatter class="org.apache.axis2.transport.http.SOAPMessageFormatter" contenttype="application/soap+xml">
        <messageformatter class="org.apache.axis2.json.JSONMessageFormatter" contenttype="application/json">
        <messageformatter class="org.apache.axis2.json.JSONBadgerfishMessageFormatter" contenttype="application/json/badgerfish">
        <messageformatter class="org.apache.axis2.json.JSONMessageFormatter" contenttype="text/javascript">
        <messageformatter class="org.apache.axis2.transport.http.XFormURLEncodedFormatter" contenttype="application/x-www-form-urlencoded">
        <messagebuilder class="org.apache.axis2.json.JSONOMBuilder" contenttype="application/json">
        <messagebuilder class="org.apache.axis2.json.JSONBadgerfishOMBuilder" contenttype="application/json/badgerfish">
        <messagebuilder class="org.apache.axis2.json.JSONOMBuilder" contenttype="text/javascript">
    <transportreceiver class="org.apache.axis2.transport.http.SimpleHTTPServer" name="http">
        <parameter name="port">8080</parameter>
    <transportsender class="org.apache.axis2.transport.local.LocalTransportSender" name="local">
    <transportsender class="org.apache.axis2.transport.http.CommonsHTTPTransportSender" name="http">
        <parameter name="PROTOCOL">HTTP/1.1</parameter>
        <parameter name="Transfer-Encoding">chunked</parameter>
    <transportsender class="org.apache.axis2.transport.http.CommonsHTTPTransportSender" name="https">
        <parameter name="PROTOCOL">HTTP/1.1</parameter>
        <parameter name="Transfer-Encoding">chunked</parameter>

    <phaseorder type="InFlow">
        <phase name="Transport">
            <handler class="org.apache.axis2.dispatchers.RequestURIBasedDispatcher" name="RequestURIBasedDispatcher">
                <order phase="Transport">
            <handler class="org.apache.axis2.dispatchers.SOAPActionBasedDispatcher" name="SOAPActionBasedDispatcher">
                <order phase="Transport">
        <phase name="Security">
        <phase name="PreDispatch">
        <phase class="org.apache.axis2.engine.DispatchPhase" name="Dispatch">
            <handler class="org.apache.axis2.dispatchers.AddressingBasedDispatcher" name="AddressingBasedDispatcher">
            <handler class="org.apache.axis2.dispatchers.RequestURIOperationDispatcher" name="RequestURIOperationDispatcher">

            <handler class="org.apache.axis2.dispatchers.SOAPMessageBodyBasedDispatcher" name="SOAPMessageBodyBasedDispatcher">
        <phase name="OperationInPhase">
 <phase name="soapmonitorPhase">
    <phaseorder type="OutFlow">
 <phase name="soapmonitorPhase">
        <phase name="OperationOutPhase">
        <phase name="PolicyDetermination">
        <phase name="MessageOut">
        <phase name="Security">
    <phaseorder type="InFaultFlow">
        <phase name="PreDispatch">
        <phase class="org.apache.axis2.engine.DispatchPhase" name="Dispatch">
            <handler class="org.apache.axis2.dispatchers.RequestURIBasedDispatcher" name="RequestURIBasedDispatcher">

            <handler class="org.apache.axis2.dispatchers.SOAPActionBasedDispatcher" name="SOAPActionBasedDispatcher">

            <handler class="org.apache.axis2.dispatchers.AddressingBasedDispatcher" name="AddressingBasedDispatcher">
            <handler class="org.apache.axis2.dispatchers.RequestURIOperationDispatcher" name="RequestURIOperationDispatcher">

            <handler class="org.apache.axis2.dispatchers.SOAPMessageBodyBasedDispatcher" name="SOAPMessageBodyBasedDispatcher">
        <phase name="OperationInFaultPhase">
 <phase name="soapmonitorPhase">
    <phaseorder type="OutFaultFlow">
 <phase name="soapmonitorPhase">
        <phase name="OperationOutFaultPhase">
        <phase name="PolicyDetermination">
        <phase name="MessageOut">
Now Lets take a look at some of the important parts of the xml.The first few lines are to set a few parameter that will be needed such as time outs and to enable and disable some parameters.
        <messagereceiver class="org.apache.axis2.receivers.RawXMLINOnlyMessageReceiver" mep=""></messagereceiver>
        <messagereceiver class="org.apache.axis2.receivers.RawXMLINOutMessageReceiver" mep=""></messagereceiver>
This is the tag that sets the default message receivers for this service here "RawXMLINOnlyMessageReceiver" has to be used and the reason is due implementation decision if you want to read more about why "RawXMLINOnlyMessageReceiver" has to be used read this blog post.

        <messageformatter class="org.apache.axis2.transport.http.SOAPMessageFormatter" contenttype="application/soap+xml"></messageformatter>
        <messageformatter class="org.apache.axis2.json.JSONMessageFormatter" contenttype="application/json"></messageformatter>
        <messageformatter class="org.apache.axis2.json.JSONBadgerfishMessageFormatter" contenttype="application/json/badgerfish"></messageformatter>
        <messageformatter class="org.apache.axis2.json.JSONMessageFormatter" contenttype="text/javascript"></messageformatter>
        <messageformatter class="org.apache.axis2.transport.http.XFormURLEncodedFormatter" contenttype="application/x-www-form-urlencoded">


This tag sets the Message formatters in this example we will be using the "XFormURLEncodedFormatter" which is mapped to the message type we set in the "JSONSearchModel" class when setting options for the service client.Although there are a few other message formatters defined in this xml the following part would be sufficent to run the sample
               <messageformatter class="org.apache.axis2.transport.http.XFormURLEncodedFormatter" contenttype="application/x-www-form-urlencoded">

Since we are using a remote service, we have to know the exact JSON content type that is used by that service, and we have to use that content type in your client as well.The Yahoo search service sends the response as a “Mapped” formatted JSON string with the content type “text/javascript”. This content type is mapped with the JSONOMBuilder in the axis2.xml using the following lines.

        <messagebuilder class="org.apache.axis2.json.JSONOMBuilder" contenttype="application/json"></messagebuilder>
        <messagebuilder class="org.apache.axis2.json.JSONBadgerfishOMBuilder" contenttype="application/json/badgerfish"></messagebuilder>
        <messagebuilder class="org.apache.axis2.json.JSONOMBuilder" contenttype="text/javascript"></messagebuilder>
There are a few more tags in the axis2.xml file but i will not try to explain them because they are out of the scope of this tutorial.
Now that we have all the parts ready all we need is the ant script that will run the sample. The ant script for this sample will look like this.
<project default="run.client" name="YahooJSONSearchSample">
 <property environment="env"></property>
 <property name="axis2.home" value="../../"></property>
 <property name="axis2.repo" value="${axis2.home}/repository"></property>
 <property name="build.dir" value="build"></property>
 <property name="client.classes.dir" value="${build.dir}/classes"></property>
 <path id="axis.classpath">
  <fileset dir="${axis2.home}/lib">
   <include name="*.jar">
  <pathelement location="build/yahooJSONSearch.jar">

 <target name="compile">
  <mkdir dir="${client.classes.dir}">
  <javac destdir="${client.classes.dir}" srcdir="src">
   <classpath refid="axis.classpath">
  <jar destfile="${build.dir}/yahooJSONSearch.jar">
   <fileset dir="${build.dir}/classes">
 <target depends="compile" name="run.client">
  <java classname="sample.yahooservices.JSONSearch.JSONSearchClient" classpathref="axis.classpath" fork="true">
   <jvmarg value="-Daxis2.repo=${axis2.repo}">
 <target name="clean">
  <delete dir="build">

You can find the zipped source code of the sample here and you can download the latest Axis2 version here.

Popular posts from this blog

How to set up a Apache Spark cluster in your local machine

Writing Unit Tests to test JMS Queue listener code with ActiveMQ

Apache Hadoop MapReduce - Detailed word count example from scratch