Quadcap Embeddable Server

com/quadcap/http/server22/DDParser.java

Go to the documentation of this file.

package com.quadcap.http.server22;

/* Copyright 1999 - 2003 Quadcap Software.  All rights reserved.
 *
 * This software is distributed under the Quadcap Free Software License.
 * This software may be used or modified for any purpose, personal or
 * commercial.  Open Source redistributions are permitted.  Commercial
 * redistribution of larger works derived from, or works which bundle
 * this software requires a "Commercial Redistribution License"; see
 * http://www.quadcap.com/purchase.
 *
 * Redistributions qualify as "Open Source" under  one of the following terms:
 *   
 *    Redistributions are made at no charge beyond the reasonable cost of
 *    materials and delivery.
 *
 *    Redistributions are accompanied by a copy of the Source Code or by an
 *    irrevocable offer to provide a copy of the Source Code for up to three
 *    years at the cost of materials and delivery.  Such redistributions
 *    must allow further use, modification, and redistribution of the Source
 *    Code under substantially the same terms as this license.
 *
 * Redistributions of source code must retain the copyright notices as they
 * appear in each source code file, these license terms, and the
 * disclaimer/limitation of liability set forth as paragraph 6 below.
 *
 * Redistributions in binary form must reproduce this Copyright Notice,
 * these license terms, and the disclaimer/limitation of liability set
 * forth as paragraph 6 below, in the documentation and/or other materials
 * provided with the distribution.
 *
 * The Software is provided on an "AS IS" basis.  No warranty is
 * provided that the Software is free of defects, or fit for a
 * particular purpose.  
 *
 * Limitation of Liability. Quadcap Software shall not be liable
 * for any damages suffered by the Licensee or any third party resulting
 * from use of the Software.
 */

import java.io.Reader;
import java.io.IOException;

import java.util.Hashtable;

import javax.servlet.ServletException;

import org.xml.sax.AttributeList;
import org.xml.sax.DocumentHandler;
import org.xml.sax.ErrorHandler;
import org.xml.sax.InputSource;
import org.xml.sax.Parser;
import org.xml.sax.Locator;
import org.xml.sax.SAXException;
import org.xml.sax.SAXParseException;

import org.xml.sax.helpers.ParserFactory;

import com.quadcap.text.sax.Handler;
import com.quadcap.util.Debug;

/**
 * Parser for Servlet 2.2 Web Deployment Descriptor.
 *
 * @author Stan Bailes
 */
public class DDParser extends Handler {
    WebApplication              app;
    WebServlet                  servlet;
    int                         state           = INIT;
    
    final static int            INIT            = 0;
    final static int            APP             = 1;
    final static int            SERVLET         = 2;
    
    /**
     * Construct a new deployment descriptor parser
     */
        super();
    }

    /**
     * Parse the specified deployment descriptor in the context of the
     * specified web application.
     *
     * @param dd the inputstream containing the deployment descriptor
     * @param app the web application being constructed
     */
    public void parse(Reader dd, WebApplication app)
    {
        this.app = app;
        this.state = INIT;
        super.parse(dd, app);
    }

    /**
     * SAX parser callback function called for the end of an element. 
     *
     * @param name the name of this element
     * @exception SAXException may be thrown 
     */
    /*{com.quadcap.http.server22.DDParser.xml}
     *
     * <el><name>web-app</name>
     *     <p>The <b>web-app</b> element is the root element of the
     *      document used to describe and configure a web application.</p>
     *     <el><name>context-param</name>
     *         <p>Application initialization parameters, available via
     *         <code>ServletContext.getInitParameter(String)</code>
     *         are specified here.</p>
     *         <el><name>param-name</name>
     *             <p>Specifies the name of an initialization parameter.</p>
     *         </el>
     *         <el><name>param-value</name>
     *             <p>Specifies the value of an initialization parameter.</p>
     *         </el>
     *         <el><name>session-timeout</name>
     *             <p>Specifies the time period after which inactive sessions
     *             will be closed.</p>
     *         </el>
     *         <el><name>servlet-mapping</name>
     *             <p>Used to tell the container how to map incoming requests
     *             to servlets, based on exact path match, prefix path match,
     *             or extension match.</p>
     *             <el><name>url-pattern</name>
     *                 <p>Specifies the pattern to match.</p>
     *             </el>
     *             <el><name>servlet-name</name>
     *                 <p>Specifies the name of the servlet to invoke on URIs
     *                 which match the specified pattern.</p>
     *             </el> 
     *         </el>
     *         <el><name>mime-mapping</name>
     *             <p> Used to tell the container which MIME types are
     *             associated
     *             with particular file extensions.</p>
     *             <el><name>extension</name>
     *                 <p>The file name extension (without the '.')</p>
     *             </el>
     *             <el><name>mime-type</name>
     *                 <p>The MIME type to associate with the specified file
     *                 extension.</p>
     *             </el>
     *         </el>
     *         <el><name>display-name</name>
     *             <p>The name associated with the Web Application when
     *             displayed in the administrative UI.</p>
     *         </el>
     *         <el><name>error-page</name>
     *             <p>The page to be invoked if exceptions are thrown by
     *             servlets in the application</p>
     *         </el>
     *         <el><name>servlet</name>
     *             <p>Define a servlet to be part of this Web Application</p>
     *             <el><name>servlet-name</name>
     *                 <p>Specify the name of the servlet.  This name isn't
     *                 really significant except in that it uniquely identifies
     *                 the servlet for the purpose of references to the
     *                 servlet in this document (e.g.
     *                 <b>web-app/servlet-mapping/servlet-name</b>)</p>
     *             </el>
     *             <el><name>servlet-class</name>
     *                 <p>Specify the name of the Java class which implements
     *                 the servlet.</p>
     *             </el>
     *             <el><name>init-param</name>
     *                 <p>Specify servlet initialization parameters, accessible
     *                 to the servlet via
     *                 <code>ServletConfig.getInitParameter()</code></p>
     *                 <el><name>param-name</name>
     *                     <p>Specifies the name of an initialization
     *                      parameter.</p>
     *                 </el>
     *                 <el><name>param-value</name>
     *                     <p>Specifies the value of an initialization
     *                     parameter.</p>
     *                 </el>
     *             </el>
     *             <el><name>load-on-startup</name>
     *                 <p>If specified, this causes the servlet to be
     *                 initialized
     *                 when the web application is loaded, in the order
     *                 specified by the integer value of this element, lower
     *                 numbers being loaded first.</p>
     *             </el>
     *         </el>
     *     </el>
     * </el>
     */
        switch (state) {
        case SERVLET:
            if (name.equals("servlet")) {
                app.addServlet(servlet);
                servlet = null;
                state = APP;
            } else if (name.equals("servlet-name")) {
                servlet.setServletName(consumeData());
            } else if (name.equals("servlet-class")) {
                servlet.setServletClass(consumeData());
            } else if (name.equals("init-param")) {
                servlet.addInitParam(consume("param-name"),
                                     consume("param-value"));
            } else if (name.equals("load-on-startup")) {
                servlet.setLoadOnStartup(Integer.parseInt(consumeData()));
            } else {
                env.put(name, consumeData());
            }
            break;
        case APP:
            if (name.equals("context-param")) {
                app.addInitParam(consume("param-name"),
                                 consume("param-value"));
            } else if (name.equals("session-timeout")) {
                app.setSessionTimeout(60 * Integer.parseInt(consumeData()));
            } else if (name.equals("context-param")) {
                app.addInitParam(consume("param-name"),
                                 consume("param-value"));
            } else if (name.equals("servlet-mapping")) {
                app.addServletMapping(consume("servlet-name"),
                                      consume("url-pattern"));
            } else if (name.equals("error-page")) {
                app.setErrorPage(consumeData());
            } else if (name.equals("mime-mapping")) {
                app.addMimeMapping(consume("extension"),
                                   consume("mime-type"));
            } else if (name.equals("display-name")) {
                app.setDisplayName(consumeData());
            } else if (name.equals("welcome-file")) {
                app.addWelcomeFile(consumeData());
            } else {
                env.put(name, consumeData());
            }
            break;
        }
    }

    /**
     * SAX parser callback for the start of an element.
     *
     * @param name the element name
     * @param attrs the element's attributes
     *
     * @exception SAXException may be thrown
     */
    {
        data.setLength(0);
        if (name.equals("servlet")) {
            servlet = new WebServlet();
            servlet.setWebApplication(app);
            state = SERVLET;
        } else if (name.equals("web-app")) {
            state = APP;
        }
    }

}