husted 2003/10/01 05:41:07
Modified: chain/src/java/org/apache/commons/chain/web
ChainServlet.java
Log:
Conform license and Javadoc; no code changes.
Revision Changes Path
1.2 +49 -28
jakarta-commons-sandbox/chain/src/java/org/apache/commons/chain/web/ChainServlet.java
Index: ChainServlet.java
===================================================================
RCS file:
/home/cvs/jakarta-commons-sandbox/chain/src/java/org/apache/commons/chain/web/ChainServlet.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ChainServlet.java 1 Oct 2003 04:23:00 -0000 1.1
+++ ChainServlet.java 1 Oct 2003 12:41:07 -0000 1.2
@@ -3,11 +3,10 @@
* $Revision$
* $Date$
*
- * ====================================================================
- *
+/* ====================================================================
* The Apache Software License, Version 1.1
*
- * Copyright (c) 1999-2003 The Apache Software Foundation. All rights
+ * Copyright (c) 2003 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
@@ -22,21 +21,21 @@
* the documentation and/or other materials provided with the
* distribution.
*
- * 3. The end-user documentation included with the redistribution, if
- * any, must include the following acknowlegement:
+ * 3. The end-user documentation included with the redistribution,
+ * if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
- * Alternately, this acknowlegement may appear in the software itself,
- * if and wherever such third-party acknowlegements normally appear.
+ * Alternately, this acknowledgment may appear in the software itself,
+ * if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "The Jakarta Project", "Commons", and "Apache Software
* Foundation" must not be used to endorse or promote products derived
* from this software without prior written permission. For written
* permission, please contact [EMAIL PROTECTED]
*
- * 5. Products derived from this software may not be called "Apache"
- * nor may "Apache" appear in their names without prior written
- * permission of the Apache Group.
+ * 5. Products derived from this software may not be called "Apache",
+ * nor may "Apache" appear in their name, without prior written
+ * permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
@@ -58,8 +57,11 @@
* <http://www.apache.org/>.
*
*/
+
+
package org.apache.commons.chain.web;
+
import java.io.IOException;
import java.io.InputStream;
import java.net.URL;
@@ -75,6 +77,7 @@
import org.apache.commons.logging.LogFactory;
import org.xml.sax.InputSource;
+
/**
* <p>Servlet that configures a Catalog based on an XML configuration file. The
* catalog is stored in a servlet context attribute so that it is accessible to
@@ -112,40 +115,50 @@
*/
public class ChainServlet extends GenericServlet {
+
+ /**
+ * <p>The <code>Log</code> instance to use with this class.</p>
+ */
protected static final Log log = LogFactory.getLog(ChainServlet.class);
-
+
+
/**
- * The servlet initialization parameter which specifies the location of the
- * XML file that describes the servlet chain we wish to load.
+ * <p>The servlet initialization parameter which specifies the location of the
+ * XML file that describes the servlet chain we wish to load.</p>
*/
public static final String INIT_PARAM_CONFIG = "config";
-
+
+
/**
- * The optional servlet initialization parameter that specifies the fully
+ * <p>The optional servlet initialization parameter that specifies the fully
* qualified class name of the rule set that will be used to configure the
- * Digester.
+ * Digester.</p>
*/
public static final String INIT_PARAM_RULE_SET = "ruleset";
-
+
+
/**
- * The optional servlet initialization parameter that specifies the
+ * <p>The optional servlet initialization parameter that specifies the
* servlet context attribute in which the catalog will be stored. If this
* parameter is not specified, the catalog will be stored under the
- * attribute "org.apache.commons.chain.CATALOG".
+ * attribute <code>org.apache.commons.chain.CATALOG</code>.</p>
*/
public static final String INIT_PARAM_ATTRIBUTE = "attribute";
-
+
+
/**
- * The servlet context attribute in which the catalog will be stored.
+ * <p>The servlet context attribute in which the catalog will be stored. </p>
*/
protected String catalogAttr = Catalog.CATALOG_KEY; ;
+
/**
* <p>The <code>RuleSet</code> to be used for configuring our Digester
* parsing rules.</p>
*/
protected RuleSet ruleSet = new ConfigRuleSet();
-
+
+
/**
* <p>The <code>Digester</code> to be used for parsing.</p>
*/
@@ -168,12 +181,15 @@
}
+
/**
- * Use the Digester to create a [EMAIL PROTECTED]
org.apache.commons.chain.Catalog}
+ * <p>Use the Digester to create a [EMAIL PROTECTED]
org.apache.commons.chain.Catalog}
* based on the information in an XML file and store the catalog in the
- * servlet context.
+ * servlet context. </p>
+ *
* @param servletConfig the configuration information supplied with this
* servlet
+ *
* @throws javax.servlet.ServletException if the servlet could not be
initialized
*/
public void init(ServletConfig servletConfig) throws ServletException {
@@ -245,12 +261,17 @@
}
+
/**
- * Does nothing; this servlet's only purpose is to initialize a Chain
- * and store it in the servlet context.
+ * <p>Does nothing; this servlet's only purpose is to initialize a Chain
+ * and store it in the servlet context.</p>
+ *
* @param request the request issued by the client
+ *
* @param response the response to be returned to the cliengt
+ *
* @throws javax.servlet.ServletException (this exception is never thrown)
+ *
* @throws java.io.IOException (this exception is never thrown)
*/
public void service(ServletRequest request, ServletResponse response)
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
