Differences between revisions 3 and 4
Revision 3 as of 2007-03-01 05:45:14
Size: 2284
Editor: dhcp64-134-214-164
Comment:
Revision 4 as of 2007-03-01 05:50:53
Size: 2811
Editor: dhcp64-134-214-164
Comment:
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
==Introduction== == Introduction ==
Line 17: Line 17:
==Sample Walk Through== == Sample Walk Through ==
Line 25: Line 25:
*decorators.xml - Add *decorators.xml - Add excludes for the /xal-actions/* and *.xal files, otherwise they would get templated.

*xap/ajax-index.html - This file includes the code to bootstrap XAP and is the file you open to run the application.

*xap/ajax-index.xal - Initial UI layout and Managed Client Object definition.

*xap/xal-actions/listPeople.ftl - Contains the xModify and XAL markup used to a display table of person objects.

*xap/xal-actions/newPeople.ftl - Contains the xModify and XAL markup used to cisplay a form to create a new person.

Introduction

This page describes how to integrate [http://incubator.apache.org/xap Apache XAP] with [http://struts.apache.org Struts2]. I use the Person Manager struts sample to illustrate how to upgrade an html application to use XAP. Overall the integration is quite simple. I was able to repurpose all of the Java code (Data Model, ActionHandlers) from the sample. All that needed to be done was to re-write the *.ftl files to output a combination of <strong>xModify</strong> and <strong>XAL</strong> instead of html.

I have uploaded a zip file of the converted Person Manager application to my people directory. [http://people.apache.org/~bbuffone/share/xap-struts-example.zip Download the XAP Person Manager Code] To run the code unzip the archive ontop of the an exploded version of the struts2-showcase-2.0.6.war. You can then run the sample by going to http://<server-address>:<port>/struts2-showcase-2.0.6/xap/ajax-index.html

The reason why integration with web frameworks is so easy, is that the XAP client retrieves the markup used to describe the application from the server and then renders it entirely on the client. This is the opposite of other Ajax toolkits where:

*You either are responsible for moving data from the server to the client using XHR and updating the UI with JavaScript code

*The markup is down convert into HTML and JavaScript on the server as in some JSF implementation.

By rendering the markup on the client the developer can reuse alot of existing code they already have in there application. Most of the time the Model and the controller code is reused. This leave developers to only change the view layer of their application. This is exactly what I did in the conversion of the Person Manager Sample.

Another reason that integration is fairly seamless with web frameworks is that XAP communicates with the server in the same manner that a HTML application does through the use of HTTP get and posts.

Sample Walk Through

In the example there are the following files

*struts.xml - Added an include to the struts-xap.xml file

*struts-xap.xml - Created action handlers for my XAP application. I used the existing ActionHandler and beans from the person manager example.

*decorators.xml - Add excludes for the /xal-actions/* and *.xal files, otherwise they would get templated.

*xap/ajax-index.html - This file includes the code to bootstrap XAP and is the file you open to run the application.

*xap/ajax-index.xal - Initial UI layout and Managed Client Object definition.

*xap/xal-actions/listPeople.ftl - Contains the xModify and XAL markup used to a display table of person objects.

*xap/xal-actions/newPeople.ftl - Contains the xModify and XAL markup used to cisplay a form to create a new person.

xap/XAPStruts (last edited 2009-09-20 23:07:09 by localhost)