Wednesday, 8 August 2012

Struts 2 ajax example

This is 7 of 8 part of struts 2 tutorial.In this tutorial we will see how we can use ajax in our webApplication in struts 2 framework.

Tutorial Content:

Part-1:Introduction to struts 2
Part-2:configuring struts 2 in eclipse
Part-3:Struts 2 hello world example
Part-4:Login page with validation in struts 2
Part-5:Struts 2 interceptors with example
Part-6:File upload in struts 2
Part-7:Struts 2 ajax example
Part-8:Struts 2 spring 3 integration example

Ajax Support in struts 2:

Struts 2 provides in-built support to ajax using dojo toolkit library. It comes with dojo ajax APIs which you can use to support ajax.For ajax support you need to add following jar to your classpath struts2-dojo-plugin.jar.
AutoCompleter Example:
Create project named "autoCompleteInStruts2".For configuring struts 2 in your eclipse ide please refer configuring struts 2 link.
We will create textbox which will autocomplete and suggest input.
Project structure:

Action class :
Create action class named under package org.arpit.javaPostsForLearning in src folder. It will get called for our AutoCompleter example.
copy following content to

package org.arpit.javaPostsForLearning;
import java.util.ArrayList;
import com.opensymphony.xwork2.ActionSupport;

public class AutoCompleteAction extends ActionSupport{

 public ArrayList<String> listOfStates=new ArrayList<String>();
 public String state;
 public String execute()
  return SUCCESS;

 public void populatelistOfStates()
 {// i am taking few states here with same first can have all states
  listOfStates.add("Madhya Pradesh");


We will create one jsp named "autoComplete.jsp" under WebContent folder.
Copy following code into autoComplete.jsp

<%@ page language="java" contentType="text/html; charset=ISO-8859-1"
    <%@taglib uri="/struts-dojo-tags" prefix="sx"%>
    <%@taglib uri="/struts-tags" prefix="s"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "">
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Auto complete example</title>
<body bgcolor="lightblue">
<h2></>Welcome to India</h2>
<sx:autocompleter size="1" name="state" list="listOfStates" showDownArrow="false" label="Choose state"></sx:autocompleter>
<s:submit ></s:submit>

Now here <%@taglib uri="/struts-dojo-tags" prefix="sx"%> is a directive used in jsp for including dojo ajax tag files.
 <sx :autocompleter> tag is used for having textbox or dropdown in jsp. So on writing few characters it will show you relevant options. In this,showDownArrow property indicates whether to show dropdown or not. Here we are setting it to false so that we will get textbox same as we see on google.


There will be no major changes in struts.xml .It will be same type of url action mapping
Create struts.xml in src folder.
Copy following content in struts.xml

<?xml version="1.0" encoding="UTF-8" ?>
    "-//Apache Software Foundation//DTD Struts Configuration 2.0//EN"
     <package name="default" extends="struts-default" namespace="/">
        <action name="AutoComplete" class="org.arpit.javaPostsForLearning.AutoCompleteAction" >
            <result name="success">autoComplete.jsp</result>


It will be also same as in previous posts.
Copy following content in web.xml.

<?xml version="1.0" encoding="UTF-8"?>

<web-app id="WebApp_ID" version="2.4" xmlns="" xmlns:xsi="" xsi:schemaLocation="">


 <url-pattern>/*</url-pattern>    </filter-mapping>




Run Application:

Right click on project->run as->run on server.
copy http://localhost:8080/autoCompleteInStruts2/AutoComplete link to  browser and press enter
we will get following screen.

Enter 'm' in textbox and we will get following screen.

Extending above example :

We will extend above example such that when we click submit on autocomplete.jsp,we will be directed to welcome page for submitted state.

Adding another action file:

Create new action file named "" 
copy following code in

package org.arpit.javaPostsForLearning;
import com.opensymphony.xwork2.ActionSupport;
public class WelcomeToState extends ActionSupport{

    public String state;

    public String execute()

        return SUCCESS;
 so in autoComplete.jsp add action="welcomeTostate" in <s:form> tag.
<s:form action="WelcomeTostate">

Adding new JSP file:

create new jsp file in Webcontent folder named "WelcomeToState.jsp"
copy following code to WelcomeToState.jsp.

<%@ page language="java" contentType="text/html; charset=ISO-8859-1"
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "">
<%@taglib uri="/struts-tags" prefix="s" %>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Welcome to state</title>
<body bgcolor="lightblue">
Welcome to <s:property value="state"/>

 Now in struts2.xml in <package> tag add following action mapping

<action name="WelcomeToState" class="org.arpit.javaPostsForLearning.WelcomeToState" >
            <result name="success">WelcomeToState.jsp</result>

Run application again:

Follow above steps(under run application heading) for running application.

Choose Maharastra and click on submit

Source code:

Source:Download without jars files
Source + lib: Download with jars files