EQUIP2 WebApp Index

Chris Greenhalgh, 2007-01-29; last updated 2007-10-24

Introduction

This CVS module houses templates, documentation and samples for using EQUIP2 in Web applications based on J2EE & Spring Framework.

The top-level directory (../) contains Java source and JSPs which are generally useful in EQUIP2 web applications, currently:

• the forms-based dataspace interface (with bulk XML/Hessian/CSV upload/download), and
  
• database ID allocation utilities

See build instructions, below.

The samples directory contains:

• A minimal EQUIP2-based web application, with no application-specific source or datatypes (samples/minimal/ in the source) and
• A complete EQUIP2-based web application for tutorial purposes, e.g. to illustrate good practice, common strategies, etc. (samples/tutorial/ in the source)
  

More documentation

• Common source Javadocs (if built - see below)
• EQUIP2_Support.html - options for further support
  

• EQUIP2_WebApp_Configuring_and_Building.html
• EQUIP2_WebApp_Deploying.html
• EQUIP2_Starting_a_new_WebApp.html

Tutorial documents

• EQUIP2_WebApp_Structure_Overview.html - what are the main parts of an EQUIP2 web application, and how (in outline) is a HTTP request handled?
• EQUIP2_WebApp_Dynamic_Reloadiing.html - speeding up the redeploy cycle for web application development (also working notes)

• EQUIP2_WebApp_Simple_Request_Handing.html - simple HTTP request handling with J2EE/Spring (no EQUIP2), e.g. serving simple pages.
• EQUIP2_WebApp_Form_Handling.html - handling forms and the like in J2EE/Spring (no EQUIP2)
• EQUIP2_WebApp_Dynamic_Pages_with_JSP.html - non-EQUIP2 JSP and JSTL
• EQUIP2_WebApp_Login_and_Interceptors.html - creating secure areas; also a note on the EQUIP2 session closing interceptor.
  
• EQUIP2_WebApp_Scheduled_Tasks.html - doing tasks at timed intervals (or set times) in the web application
  

• EQUIP2_WebApp_Defining_the_Dataspace.html - specifying Data classes and initial configuration
  
• EQUIP2_WebApp_Standard_Dataspace_Web_Interface.html
• EQUIP2_WebApp_Dynamic_Pages_using_EQUIP2_Taglib.html
• EQUIP2_WebApp_Scripting_Support.html - most of the example is relevant whether or not you are using EQUIP2, but some use is also made of EQUIP2 dataspace for illustration purposes.
• EQUIP2_WebApp_Unit_Testing.html - much of this is relevant with or without EQUIP2, but does include specific examples for Unit testing with EQUIP2.
  

• EQUIP2_WebApp_Tutorial_Application_Specification.html - what the application is/does
• EQUIP2_WebApp_Tutorial_Application_Website_Structure.html - Note that this tutorial (and the application itself) is incomplete, but it already has quite a lot of useful examples. E.g. player registration, login, and custom form-based adding and editing of dataspace objects.

Source

This CVS module houses templates, documentation and samples for using EQUIP2 in Web applications based on J2EE & Spring Framework.

The top-level directory (../) contains Java source and JSPs which are generally useful in EQUIP2 web applications, currently:

• the forms-based dataspace interface (with bulk XML/Hessian/CSV upload/download), and
  
• database ID allocation utilities

NB: Normally the dependencies should include a pre-built version of these common controllers & jsps (equip2webdb.jar & equip2webdb_jsp.jar) and you can go straight to building a web application.

Getting EQUIP2 WebApp

CVSROOT: :pserver:anonymous@equip.cvs.sourceforge.net:/cvsroot/equip
Module: equip2webapp

It is licensed under the (so-called) new or modified BSD Open Source license.

EQUIP2 itself is in the same repository in the module 'equip2'. The dependencies are in the same repository in the module 'dependencies'.

Preparation

Download and install/unpack the dependencies from the dependencies module (see previous section). The default installation expects these to be in the directory ../dependencies/lib (as configured in build.properties).

• EQUIP2 core libraries for J2EE (if you are build EQUIP2 yourself, use its ant target j2ee - see EQUIP2_Installation_Guide.html):
• equip2.jar, equip2hibernate.jar, equip2tools.jar, equip2taglib.jar
• Spring Framework - we are currently working with version 1.2.8, including
• spring.jar, lib/j2ee/servlet-api.jar, lib/j2ee/jsp-api.jar, lib/log4j/log4j-1.2.13.jar, lib/jakarta-commons/commons-fileupload.jar, lib/quartz/quartz*.jar
  
• Hibernate Core 3.1.3 (3.1.1 is known NOT to work), including
  
• hibernate3.jar, antlr-*.jar, cglib-*.jar, asm.jar, commons-logging.jar, jta.jar, dom4j.jar, c3p0*.jar
  
• JSTL 1.1 taglib, e.g. taglib Standard-1.1 (standard.jar & jstl.jar) from Apache Taglibs (depending on your version of Spring you may have an older version; 1.2.7 certainly does).

Java SDK 1.5+ and Apache Ant are required. 

In addition you may require Apache Xalan, although in theory the XSL support in Java 1.5+ should be sufficient (but we have had occasional problems).

The documentation and build files currently assume that you are using:

• MySQL 5.0 (and MySQL Java connector, currently version 3.1.12)
• Tomcat 5.5.16

Building

To compile the common support library:

1. edit ../build.properties to reflect
   
1. the location of the dependencies (dependencies.dir)
2. if required (i.e. JDK XSL doesn't work) the location of Xalan (xalanhome).
2. if you are using a different version of the external dependencies (Spring, Hibernate, etc.) then you may need to change the classpath(s) in build.xml, especially classpath_equip2spring
   
3. build dist/equip2webdb.jar & dist/equip2webdb_jsp.jar (the JSPs for the web database interface):
   > ant
4. Copy these into the common dependencies directory (assuming you want to replace whichever version(s) were there). Otherwise you need not have bothered :-)
   

Changes

• Document created
• Minimal web app created
• Started tutorial web app
• added web form link
  

• clarified config (jars); updated docs organisation from tutorial
• added login page
• added application example structure link
  

• added testing link

• added CVS info

• updated dependency/build information

• note on prebuilt; remove mysql/tomcat refs