Struts Cross Reference

STRUTS
CROSS
REFERENCE

Prepared by
Roger W. Barnes
Of
Project Refinery, Inc.

Page 1 of 1 Project Refinery, Inc.

 Struts Cross Reference

TABLE OF CONTENTS

OVERVIEW.................................................................................................................................. 3
STRUTS -[Link] ............................................................................................................. 4
[Link]..................................................................................................................................... 5
[Link]..................................................................................................... 6
[Link]................................................................................................. 9
[Link]............................................................................................................................. 10
[Link]........................................................................................................................ 11
[Link].............................................................................................. 12
[Link] .......................................................................................... 13
[Link] FILE .............................................................................. 14
TYPICAL STRUTS SYSTEM FLOW ..................................................................................... 15

Page 2 of 2 Project Refinery, Inc.

 Struts Cross Reference

Overview

The purpose of this document is to provide a cross reference of an example application using the
Struts framework. This document displays where information from the [Link] file
relate to Java Server Pages using the Struts tag libraries, and to Java classes extending both the
ActionForm and Action classes.

Page 3 of 3 Project Refinery, Inc.

 Struts Cross Reference

[Link]
<?xml version="1.0" encoding="ISO-8859-1" ?>
<!DOCTYPE struts-config PUBLIC
"-//Apache Software Foundation//DTD Struts Configuration 1.0//EN"
"[Link]

<struts-config>

<!-- ========== Form Bean Definitions =================================== -->

<form-beans>

<!-- Struts Example form bean -->

<form-bean name="StrutsInputFormBean"

type="[Link]" />

<form-bean name="StrutsDisplayFormBean"

type="[Link]" />

</form-beans>

<!-- ========== Global Forward Definitions ============================== -->

<global-forwards>
<forward name="Menu" path="/[Link]"/>
</global-forwards>
<!-- ========== Action Mapping Definitions ============================== -->
<action-mappings>

<!-- StrutsExample -->

<action path="/StrutsInputPath"

type="[Link]"

name="StrutsInputFormBean"
scope="request"

input="/[Link]">

<forward name="Next" path="/[Link]" />

</action>

<action path="/StrutsDisplayPath"

type="[Link]"

name="StrutsDisplayFormBean"
scope="request"

input="/[Link]" >
</action>

</action-mappings>
</struts-config>

Page 4 of 4 Project Refinery, Inc.

 Struts Cross Reference

[Link]
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE web-app
PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.2//EN"
"[Link]
<web-app id="WebApp">
<display-name>StrutsExampleWeb</display-name>
<!-- Action Servlet Configuration -->
<servlet id="Servlet_1">
<servlet-name>action</servlet-name>
<servlet-class>[Link]</servlet-class>
<init-param>
<param-name>application</param-name>

<param-value>strutsexample </param-value>
</init-param>
<init-param>
<param-name>config</param-name>

<param-value>WEB-INF/[Link] </param-value>
</init-param>
<init-param>
<param-name>debug</param-name>
<param-value>2</param-value>
</init-param>
<init-param>
<param-name>detail</param-name>
<param-value>2</param-value>
</init-param>
<init-param>
<param-name>validate</param-name>
<param-value>true</param-value>
</init-param>
<load-on-startup>2</load-on-startup>
</servlet>
<!-- Action Servlet Mapping -->
<servlet-mapping>
<servlet-name>action</servlet-name>
<url-pattern>*.do</url-pattern>
</servlet-mapping>

<!-- The Welcome File List -->

<welcome-file-list>
<welcome-file>[Link]</welcome-file>
</welcome-file-list>

<!-- Tag Library Descriptors -->

<taglib>
<taglib-uri>struts</taglib-uri>
<taglib-location>/WEB-INF/lib/[Link]</taglib-location>
</taglib>
<taglib>
<taglib-uri>WEB-INF/[Link]</taglib-uri>
<taglib-location>/WEB-INF/[Link]</taglib-location>
</taglib>
<taglib>
<taglib-uri>WEB-INF/[Link]</taglib-uri>
<taglib-location>/WEB-INF/[Link]</taglib-location>
</taglib>
<taglib>
<taglib-uri>WEB-INF/[Link]</taglib-uri>
<taglib-location>/WEB-INF/[Link]</taglib-location>
</taglib>
<taglib>
<taglib-uri>WEB-INF/[Link]</taglib-uri>
<taglib-location>/WEB-INF/[Link]</taglib-location>
</taglib>
<taglib>
<taglib-uri>WEB-INF/[Link]</taglib-uri>
<taglib-location>/WEB-INF/[Link]</taglib-location>
</taglib>
</web-app>

Page 5 of 5 Project Refinery, Inc.

 Struts Cross Reference

[Link]

package [Link];

import [Link];
import [Link];
import [Link];
import [Link];
import [Link];

/**
* The purpose of this class is to handle the input fields entered on a JSP.
* @author Roger W Barnes
* @version $Revision: 1.0 $ $Date: 2001/11/02 [Link] $
*/
public final class StrutsInputForm extends ActionForm {
/**
* The name.
*/
private String name = "";
/**
* The address.
*/
private String address = "";
/**
* The city.
*/
private String city = "";
/**
* The state.
*/
private String state = "";
/**
* The zipcode.
*/
private String zipcode = "";
/**
* The action.
*/
private String action = "";

/** END OF VARIABLES */

/**
* Gets the name
* @return Returns a String
*/
public String getName() {
return name;
}
/**
* Sets the name
* @param name The name to set
*/
public void setName(String name) {
[Link] = name;
}
/**
* Gets the address
* @return Returns a String

Page 6 of 6 Project Refinery, Inc.

 Struts Cross Reference

*/
public String getAddress() {
return address;
}
/**
* Sets the address
* @param address The address to set
*/
public void setAddress(String address) {
[Link] = address;
}
/**
* Gets the city
* @return Returns a String
*/
public String getCity() {
return city;
}
/**
* Sets the city
* @param city The city to set
*/
public void setCity(String city) {
[Link] = city;
}
/**
* Gets the state
* @return Returns a String
*/
public String getState() {
return state;
}
/**
* Sets the state
* @param state The state to set
*/
public void setState(String state) {
[Link] = state;
}
/**
* Gets the zipcode
* @return Returns a String
*/
public String getZipcode() {
return zipcode;
}
/**
* Sets the zipcode
* @param zipcode The zipcode to set
*/
public void setZipcode(String zipcode) {
[Link] = zipcode;
}

/**
* Gets the action
* @return Returns a String
*/
public String getAction() {
return action;

Page 7 of 7 Project Refinery, Inc.

 Struts Cross Reference

}
/**
* Sets the action
* @param action The action to set
*/
public void setAction(String action) {
[Link] = action;
}
/**
* Reset all properties to their default values.
*
* @param mapping The mapping used to select this instance
* @param request The servlet request we are processing
*/
public void reset(ActionMapping mapping, HttpServletRequest request) {
action = null;
}
/**
* Validate the properties of this form bean, and return an array of
* message keys for any errors we encounter.
*/
public ActionErrors validate(ActionMapping mapping,
HttpServletRequest request) {
ActionErrors errors = new ActionErrors();
/** Perform validation tests on the name field */
if ((name == null) || ([Link]() < 1))
[Link]("name", new ActionError("[Link]", name));
/** Perform validation tests on the address field */
if ((address == null) || ([Link]() < 1))
[Link]("address", new ActionError("[Link]", address));
/** Perform validation tests on the city field */
if ((city == null) || ([Link]() < 1))
[Link]("city", new ActionError("[Link]", city));
/** Perform validation tests on the state field */
if ((state == null) || ([Link]() < 1))
[Link]("state", new ActionError("[Link]", state));
/** Perform validation tests on the zipcode field */
if ((zipcode == null) || ([Link]() < 1))
[Link]("zipcode", new ActionError("[Link]", zipcode));
/** Perform validation tests on the action field */
if ((action == null) || ([Link]() < 1))
[Link]("action", new ActionError("[Link]", action));
return errors;
}
}

Page 8 of 8 Project Refinery, Inc.

 Struts Cross Reference

[Link]

package [Link];
import [Link];
import [Link];
import [Link];
import [Link];
import [Link];
import [Link];

/**
* Implementation of <strong>Action</strong> that handles the Index Account Action.
*
* @author Roger W Barnes
* @version $Revision: 1.0 $ $Date: 2002/03/11 [Link] $
*/

public final class StrutsInputAction extends Action {

/**
* Process the specified HTTP request, and create the corresponding HTTP
* response (or forward to another web component that will create it).
* Return an <code>ActionForward</code> instance describing where and how
* control should be forwarded, or <code>null</code> if the response has
* already been completed.
*
* @param servlet The ActionServlet making this request
* @param mapping The ActionMapping used to select this instance
* @param actionForm The optional ActionForm bean for this request (if any)
* @param request The HTTP request we are processing
* @param response The HTTP response we are creating
*
* @exception IOException if an input/output error occurs
* @exception ServletException if a servlet exception occurs
*/
public ActionForward perform(ActionMapping mapping,
ActionForm form,
HttpServletRequest request,
HttpServletResponse response)
{
/** Get a handle to the StrutsInputForm */
StrutsInputForm strutsForm = (StrutsInputForm) form;

/** Get the action from the form */

String action = [Link]();

/** Forward control to the specified success URI */

return ([Link](action));

}
}

Page 9 of 9 Project Refinery, Inc.

 Struts Cross Reference

[Link]

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

<%@ page language="java" %>
<%@ taglib uri="WEB-INF/[Link]" prefix="bean" %>
<%@ taglib uri="WEB-INF/[Link]" prefix="html" %>
<html:html>
<head>
<title><bean:message key="strutsexample.title1"/></title>
<META name="GENERATOR" content="IBM WebSphere Studio">
</head>
<body>

<html:form action="/StrutsInputPath" focus="name" >

<table width=750 cellspacing=0 cellpadding=2 border=2 >
<tr><td><font color="blue"><bean:message key="[Link]"/>:</font>
</td>
<td> <html:text property="name" size="40" maxlength="40"/> </td>
</tr>
<tr> <td>&nbsp;</td>
<td><font color=red><html:errors property="name"/></font></td>
</tr>
<tr> <td><font color="blue"><bean:message key="[Link]"/>:
</font></td>
<td><html:text property="address" size="40" maxlength="40"/></td>
</tr>
<tr> <td>&nbsp;</td>
<td><font color=red><html:errors property="address"/> </font></td>
</tr>
<tr> <td><font color="blue"><bean:message key="[Link]"/>:</font>
</td>
<td> <html:text property="city" size="20" maxlength="20"/> </td>
</tr>
<tr> <td>&nbsp;</td>
<td><font color=red><html:errors property="city"/></font></td>
</tr>
<tr> <td><font color="blue"><bean:message key="[Link]"/>:</font>
</td>
<td><html:text property="state" size="2" maxlength="2"/></td>
</tr>
<tr> <td>&nbsp;</td>
<td><font color=red><html:errors property="state"/></font></td>
</tr>
<tr> <td><font color="blue"><bean:message key="[Link]"/>:
</font></td>
<td><html:text property="zipcode" size="10" maxlength="10"/></td>
</tr>
<tr> <td>&nbsp;</td>
<td><font color=red><html:errors property="zipcode"/> </font></td>
</tr>
</table>

<table width=750 cellspacing=0 cellpadding=2 border=2 >

<tr>
<td align="center"><html:submit property="action" value="Next" /></td>
<td align="center"><html:submit property="action" value="Menu" /></td>
</tr>
</table>

</html:form>

</body>
</html:html>

Page 10 of 10 Project Refinery, Inc.

 Struts Cross Reference

[Link] p

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

<%@ page language="java" %>

<%@ taglib uri="WEB-INF/[Link]" prefix="bean" %>
<%@ taglib uri="WEB-INF/[Link]" prefix="html" %>

<html:html>
<head>
<title><bean:message key="strutsexample.title2"/></title>
<META name="GENERATOR" content="IBM WebSphere Studio">
</head>

<body>

<html:form action="/StrutsDisplayPath" focus="action" >

<table width=750 cellspacing=0 cellpadding=2 border=2 >

<tr>
<td><font color="blue"><bean:message key="[Link]"/>:</font>
</td>
<td> <bean:write property="name" name="StrutsInputFormBean" />
</td>
</tr>
<tr>
<td><font color="blue"><bean:message key="[Link]"/>:
</font>
</td>
<td> <bean:write property="address" name="StrutsInputFormBean" />
</td>
</tr>
<tr>
<td><font color="blue"><bean:message key="[Link]"/>:</font>
</td>
<td> <bean:write property="city" name="StrutsInputFormBean" />
</td>
</tr>
<tr>
<td><font color="blue"><bean:message key="[Link]"/>:</font>
</td>
<td> <bean:write property="state" name="StrutsInputFormBean" />
</td>
</tr>
<tr>
<td><font color="blue"><bean:message key="[Link]"/>:</font>
</td>
<td> <bean:write property="zipcode" name="StrutsInputFormBean" />
</td>
</tr>
</table>

<table width=750 cellspacing=0 cellpadding=2 border=2 >

<tr>
<td align="center">
<html:submit property="action" value="Menu" />
</td>
</tr>
</table>

</html:form>

</body>
</html:html>

Page 11 of 11 Project Refinery, Inc.

 Struts Cross Reference

[Link]

package [Link];

import [Link];
import [Link];
import [Link];
import [Link];
import [Link];

/**
* The purpose of this class is to handle the input fields entered on a JSP form page.
* @author Roger W Barnes
* @version $Revision: 1.0 $ $Date: 2001/11/02 [Link] $
*/
public final class StrutsDisplayForm extends ActionForm {
/**
* The action.
*/
private String action = "";
/**
* Gets the action
* @return Returns a String
*/
public String getAction() {
return action;
}
/**
* Sets the action
* @param action The action to set
*/
public void setAction(String action) {
[Link] = action;
}
/**
* Reset all properties to their default values.
*
* @param mapping The mapping used to select this instance
* @param request The servlet request we are processing
*/
public void reset(ActionMapping mapping, HttpServletRequest request) {
action = null;
}
/**
* Validate the properties of this form bean, and return an array of
* message keys for any errors we encounter.
*/
public ActionErrors validate(ActionMapping mapping,
HttpServletRequest request) {
ActionErrors errors = new ActionErrors();
/** Perform validation tests on the action field */
if ((action == null) || ([Link]() < 1))
[Link]("action", new ActionError("[Link]", action));
return errors;
}
}

Page 12 of 12 Project Refinery, Inc.

 Struts Cross Reference

[Link]

package [Link];

import [Link];
import [Link];
import [Link];
import [Link];
import [Link];
import [Link];

/**
* Implementation of <strong>Action</strong> that handles the Index Account Action.
*
* @author Roger W Barnes
* @version $Revision: 1.0 $ $Date: 2002/03/11 [Link] $
*/

public final class StrutsDisplayAction extends Action {

/**
* Process the specified HTTP request, and create the corresponding HTTP
* response (or forward to another web component that will create it).
* Return an <code>ActionForward</code> instance describing where and how
* control should be forwarded, or <code>null</code> if the response has
* already been completed.
*
* @param servlet The ActionServlet making this request
* @param mapping The ActionMapping used to select this instance
* @param actionForm The optional ActionForm bean for this request (if any)
* @param request The HTTP request we are processing
* @param response The HTTP response we are creating
*
* @exception IOException if an input/output error occurs
* @exception ServletException if a servlet exception occurs
*/
public ActionForward perform(ActionMapping mapping,
ActionForm form,
HttpServletRequest request,
HttpServletResponse response)
{
/** Get a handle to the StrutsExampleForm */
StrutsDisplayForm strutsForm = (StrutsDisplayForm) form;

/** Get the action from the form */

String action = [Link]();

/** Forward control to the specified success URI */

return ([Link](action));

}
}

Page 13 of 13 Project Refinery, Inc.

 Struts Cross Reference

[Link] File

strutsexample.title1=Struts Example Project - Input Form

strutsexample.title2=Struts Example Project - Display Page
[Link]=Enter Your Name
[Link]=Enter Your Address
[Link]=Enter Your City
[Link]=Enter Your State
[Link]=Enter Your Zip Code
[Link]=<li>You must enter Your Name.</li>
[Link]=<li>You must enter Your Address.</li>
[Link]=<li>You must enter Your City.</li>
[Link]=<li>You must enter Your State.</li>
[Link]=<li>You must enter Your Zip Code.</li>
[Link]=<li>You must click on the Next button.</li>
[Link]=
[Link]=

Page 14 of 14 Project Refinery, Inc.

 Struts Cross Reference

Typical Struts System Flow

§ A request comes in from a Java Server Page into the ActionServlet

§ The ActionServlet having already read the [Link] file, knows which form bean
relates to this JSP, and delegates work to the validate method of that form bean
§ The form bean performs the validate method to determine if all required fields have been
entered, and performs whatever other types of field validations that need to be performed
§ If any required field has not been entered, or any field does not pass validation, the form bean
generates ActionErrors, and after checking all fields returns back to the ActionServlet
§ The ActionServlet checks the ActionErrors that were returned from the form bean’s validate
method to determine if any errors have occurred. If errors have occurred, it returns to the
originating JSP displaying the appropriate errors
§ If no errors occurred in the validate method of the form bean, the ActionServlet passes
control to the appropriate Action class
§ The Action class performs any necessary business logic, and then forwards to the next
appropriate action (probably another JSP)

Page 15 of 15 Project Refinery, Inc.