com.cappuccinonet.strutscx.xslt
Class StrutsCXServlet

java.lang.Object
  |
  +--HttpServlet
        |
        +--com.cappuccinonet.strutscx.xslt.StrutsCXServlet

public class StrutsCXServlet

extends HttpServlet

This Servlet is at top of the StrutsCX VIEW functionality and together with its two major helper classes StrutsCXDocumentBuilder and StrutsCXTransformer replaces the JSP part of Struts.

It does basically nothing more than

• create a Document, by calling the StrutsCXDocumentBuilder
• make transformation and send everything to the response by calling the StrutsCXTransformer

  The work properly the following parameters should get send individually to this StrutsCXServlet:

  • A org.jdocm.Document object with the XML data as request attribute.
  • A String pointing to the XSL file as request attribute.
  • An (optional) Struts ActionForm as request attribute.
  • Error flags as request attributes; check out the UpdateAction for details on that.
  • A string with the charset as request attribute. The XML-XSLT transformation process adds this value into the output. This is one necessary step to serve internationalized applications.
  • An (optional) debug parameter (debugxml=true) we can allways add to the HttpRequest .

  There are also a couple of general parameters we put to the ServletContext and the HttpSession once the Server got started or the a new HttpSession got created. This are:

  1. the domain name, the port, a string with the complete http domain address, the rootpath and the project's name we set in the properties.xml,
  2. all variables_xx.xml files which contain the language dependend text strings - like menu and button texts, etc. - for the view.
  Check out the StrutsCXParameters which sets all this values.

  Caching & Performance Tuning:
  For performance reasons, XML and XSL files are read only from the source if it changes on disk since the last read. Otherwise they are kept in and read from the ServletContext. The variables for the view are saved in the ServletContext, too. To affect changes to them the Servlet Engine need to be restarted. Check out these classes for more detail on this:

  1. the createXSLTemplate() method of the StrutsCXTransformer
  2. the getDocumentFromXML() method of the StrutsCXXMLReader
  3. the setBasicDomainParameters() method of the StrutsCXParameters
  4. the StrutsCXPropertiesReader

  This Servlet has to be registered in the WEB-INF/web.xml of your Servlet Container and has to be referenced in the struts-config.xml.

  Version:

  v1.3, 2002.07.08

  Author:

  Bernhard Woehrlin, IT.CappuccinoNet.com

  See Also:

  StrutsCXConstants, StrutsCXTransformer, StrutsCXDocumentBuilder, StrutsCXParameters, Serialized Form

  Field Summary

  private ServletConfig	config The ServletConig for this Servlet.
  private static java.util.logging.Logger	logger The Logger we use to log JDK 1.4 conform.
  private java.lang.String	standardXSL The name of the XSL file we do use and transform.
  private static java.lang.String	THIS_CLASS A String with this Classname used for system messages.

  Constructor Summary

  StrutsCXServlet()
  

  Method Summary

  void	destroy() The empty Servlet standard destroy method.
  void	doGet(HttpServletRequest request, HttpServletResponse response) The Servlet doGet() method.
  void	doPost(HttpServletRequest request, HttpServletResponse response) The Servlet doPost() method firste creates a Document by making a call to the StrutsCXDocumentBuilder.
  void	init(ServletConfig config) The Servlet init() method.

  Methods inherited from class java.lang.Object

  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  Field Detail

  THIS_CLASS

  private static final java.lang.String THIS_CLASS

  A String with this Classname used for system messages.

  See Also:

  Constant Field Values

  standardXSL

  private java.lang.String standardXSL

  The name of the XSL file we do use and transform. Initialized in the Servlets init() method.

  config

  private ServletConfig config

  The ServletConig for this Servlet.

  logger

  private static java.util.logging.Logger logger

  The Logger we use to log JDK 1.4 conform.

  Constructor Detail

  StrutsCXServlet

  public StrutsCXServlet()

  Method Detail

  init

  public void init(ServletConfig config)
            throws ServletException

  The Servlet init() method. Reads in the standard XSL file which is used to transform non ISO-8859-1 encoded XML data.

  Parameters:

  config - the ServletConfig

  Throws:

  ServletException

  See Also:

  StrutsCXTransformer transforms the XML using a given XSL, StrutsCXDocumentBuilder creates a XML Document

  doPost

  public void doPost(HttpServletRequest request,
                     HttpServletResponse response)
              throws ServletException

  The Servlet doPost() method firste creates a Document by making a call to the StrutsCXDocumentBuilder. Afte obtaining the Document it calls the transform() method of the StrutsCXTransformer, a class responsible to do the whole transformation and output it the the HttpServletResponse.

  Parameters:

  request - the HttpServletRequest

  response - the HttpServletResponse

  Throws:

  ServletException

  doGet

  public void doGet(HttpServletRequest request,
                    HttpServletResponse response)
             throws ServletException

  The Servlet doGet() method. It simply dispatches everything to the doPost().

  Parameters:

  request - the HttpServletRequest

  response - the HttpServletResponse

  Throws:

  ServletException

  destroy

  public void destroy()

  The empty Servlet standard destroy method. For later use...