tomcat-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From r...@apache.org
Subject cvs commit: jakarta-tomcat-4.0/catalina/src/share/org/apache/catalina/valves ErrorDispatcherValve.java ErrorReportValve.java
Date Tue, 25 Sep 2001 22:11:49 GMT
remm        01/09/25 15:11:49

  Added:       catalina/src/share/org/apache/catalina/valves
                        ErrorDispatcherValve.java ErrorReportValve.java
  Log:
  - Start experimenting with the error report / dispatcher refactoring. Not done yet,
    these are only skeleton classes.
  
  Revision  Changes    Path
  1.1                  jakarta-tomcat-4.0/catalina/src/share/org/apache/catalina/valves/ErrorDispatcherValve.java
  
  Index: ErrorDispatcherValve.java
  ===================================================================
  /*
   * $Header: /home/cvs/jakarta-tomcat-4.0/catalina/src/share/org/apache/catalina/valves/ErrorDispatcherValve.java,v
1.1 2001/09/25 22:11:49 remm Exp $
   * $Revision: 1.1 $
   * $Date: 2001/09/25 22:11:49 $
   *
   * ====================================================================
   *
   * The Apache Software License, Version 1.1
   *
   * Copyright (c) 1999-2001 The Apache Software Foundation.  All rights
   * reserved.
   *
   * Redistribution and use in source and binary forms, with or without
   * modification, are permitted provided that the following conditions
   * are met:
   *
   * 1. Redistributions of source code must retain the above copyright
   *    notice, this list of conditions and the following disclaimer.
   *
   * 2. Redistributions in binary form must reproduce the above copyright
   *    notice, this list of conditions and the following disclaimer in
   *    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:
   *       "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.
   *
   * 4. The names "The Jakarta Project", "Tomcat", 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 apache@apache.org.
   *
   * 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.
   *
   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
   * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   * SUCH DAMAGE.
   * ====================================================================
   *
   * This software consists of voluntary contributions made by many
   * individuals on behalf of the Apache Software Foundation.  For more
   * information on the Apache Software Foundation, please see
   * <http://www.apache.org/>.
   *
   * [Additional notices, if required by prior licensing conditions]
   *
   */
  
  
  package org.apache.catalina.valves;
  
  
  import java.io.IOException;
  import java.util.ArrayList;
  import java.util.Enumeration;
  import java.util.Iterator;
  import javax.servlet.ServletException;
  import javax.servlet.ServletRequest;
  import javax.servlet.ServletResponse;
  import javax.servlet.http.Cookie;
  import javax.servlet.http.HttpServletRequest;
  import javax.servlet.http.HttpServletResponse;
  import org.apache.catalina.Container;
  import org.apache.catalina.Context;
  import org.apache.catalina.HttpRequest;
  import org.apache.catalina.HttpResponse;
  import org.apache.catalina.Logger;
  import org.apache.catalina.Request;
  import org.apache.catalina.Response;
  import org.apache.catalina.Valve;
  import org.apache.catalina.ValveContext;
  import org.apache.catalina.connector.HttpResponseWrapper;
  import org.apache.catalina.util.StringManager;
  
  
  /**
   * <p>Implementation of a Valve that handles the error dispatch (that is, will
   * forward to the appropriate error page if necessary).</p>
   *
   * <p>This Valve should be attached at the Host level, although it will work
   * if attached to a Context.</p>
   *
   * <p><b>WARNING</b>: This valve is necessary for Servlet API compliance.</p>
   *
   * @author Remy Maucherat
   * @author Craig R. McClanahan
   * @version $Revision: 1.1 $ $Date: 2001/09/25 22:11:49 $
   */
  
  public class ErrorDispatcherValve
      extends ValveBase {
  
  
      // ----------------------------------------------------- Instance Variables
  
  
      /**
       * The descriptive information related to this implementation.
       */
      private static final String info =
          "org.apache.catalina.valves.ErrorDispatcherValve/1.0";
  
  
      /**
       * The StringManager for this package.
       */
      protected static StringManager sm =
          StringManager.getManager(Constants.Package);
  
  
      // ------------------------------------------------------------- Properties
  
  
      /**
       * Return descriptive information about this Valve implementation.
       */
      public String getInfo() {
  
          return (info);
  
      }
  
  
      // --------------------------------------------------------- Public Methods
  
  
      /**
       * Invoke the next Valve in the sequence. When the invoke returns, check 
       * the response state, and output an error report is necessary.
       *
       * @param request The servlet request to be processed
       * @param response The servlet response to be created
       * @param context The valve context used to invoke the next valve
       *  in the current processing pipeline
       *
       * @exception IOException if an input/output error occurs
       * @exception ServletException if a servlet error occurs
       */
      public void invoke(Request request, Response response,
                         ValveContext context)
          throws IOException, ServletException {
  
          // Skip logging for non-HTTP requests and responses
          if (!(request instanceof HttpRequest) ||
              !(response instanceof HttpResponse)) {
              context.invokeNext(request, response);
              return;
          }
          HttpRequest hrequest = (HttpRequest) request;
          HttpResponse hresponse = (HttpResponse) response;
          HttpServletRequest hreq =
              (HttpServletRequest) hrequest.getRequest();
          HttpServletResponse hres =
              (HttpServletResponse) hresponse.getResponse();
  
          // Perform the request
          context.invokeNext(request, response);
  
          Context mappedContext = request.getContext();
  
      }
  
  
      /**
       * Return a String rendering of this object.
       */
      public String toString() {
  
          StringBuffer sb = new StringBuffer("ErrorDispatcherValve[");
          sb.append(container.getName());
          sb.append("]");
          return (sb.toString());
  
      }
  
  
      // ------------------------------------------------------ Protected Methods
  
  
      /**
       * Log a message on the Logger associated with our Container (if any).
       *
       * @param message Message to be logged
       */
      protected void log(String message) {
  
          Logger logger = container.getLogger();
          if (logger != null)
              logger.log(this.toString() + ": " + message);
          else
              System.out.println(this.toString() + ": " + message);
  
      }
  
  
      /**
       * Log a message on the Logger associated with our Container (if any).
       *
       * @param message Message to be logged
       * @param throwable Associated exception
       */
      protected void log(String message, Throwable throwable) {
  
          Logger logger = container.getLogger();
          if (logger != null)
              logger.log(this.toString() + ": " + message, throwable);
          else {
              System.out.println(this.toString() + ": " + message);
              throwable.printStackTrace(System.out);
          }
  
      }
  
  
  }
  
  
  
  1.1                  jakarta-tomcat-4.0/catalina/src/share/org/apache/catalina/valves/ErrorReportValve.java
  
  Index: ErrorReportValve.java
  ===================================================================
  /*
   * $Header: /home/cvs/jakarta-tomcat-4.0/catalina/src/share/org/apache/catalina/valves/ErrorReportValve.java,v
1.1 2001/09/25 22:11:49 remm Exp $
   * $Revision: 1.1 $
   * $Date: 2001/09/25 22:11:49 $
   *
   * ====================================================================
   *
   * The Apache Software License, Version 1.1
   *
   * Copyright (c) 1999-2001 The Apache Software Foundation.  All rights
   * reserved.
   *
   * Redistribution and use in source and binary forms, with or without
   * modification, are permitted provided that the following conditions
   * are met:
   *
   * 1. Redistributions of source code must retain the above copyright
   *    notice, this list of conditions and the following disclaimer.
   *
   * 2. Redistributions in binary form must reproduce the above copyright
   *    notice, this list of conditions and the following disclaimer in
   *    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:
   *       "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.
   *
   * 4. The names "The Jakarta Project", "Tomcat", 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 apache@apache.org.
   *
   * 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.
   *
   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
   * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   * SUCH DAMAGE.
   * ====================================================================
   *
   * This software consists of voluntary contributions made by many
   * individuals on behalf of the Apache Software Foundation.  For more
   * information on the Apache Software Foundation, please see
   * <http://www.apache.org/>.
   *
   * [Additional notices, if required by prior licensing conditions]
   *
   */
  
  
  package org.apache.catalina.valves;
  
  
  import java.io.IOException;
  import java.util.ArrayList;
  import java.util.Enumeration;
  import java.util.Iterator;
  import javax.servlet.ServletException;
  import javax.servlet.ServletRequest;
  import javax.servlet.ServletResponse;
  import javax.servlet.http.Cookie;
  import javax.servlet.http.HttpServletRequest;
  import javax.servlet.http.HttpServletResponse;
  import org.apache.catalina.Container;
  import org.apache.catalina.HttpRequest;
  import org.apache.catalina.HttpResponse;
  import org.apache.catalina.Logger;
  import org.apache.catalina.Request;
  import org.apache.catalina.Response;
  import org.apache.catalina.Valve;
  import org.apache.catalina.ValveContext;
  import org.apache.catalina.connector.HttpResponseWrapper;
  import org.apache.catalina.util.StringManager;
  
  
  /**
   * <p>Implementation of a Valve that outputs HTML error pages.</p>
   *
   * <p>This Valve should be attached at the Host level, although it will work
   * if attached to a Context.</p>
   *
   * @author Remy Maucherat
   * @author Craig R. McClanahan
   * @version $Revision: 1.1 $ $Date: 2001/09/25 22:11:49 $
   */
  
  public class ErrorReportValve
      extends ValveBase {
  
  
      // ----------------------------------------------------- Instance Variables
  
  
      /**
       * The descriptive information related to this implementation.
       */
      private static final String info =
          "org.apache.catalina.valves.ErrorReportValve/1.0";
  
  
      /**
       * The StringManager for this package.
       */
      protected static StringManager sm =
          StringManager.getManager(Constants.Package);
  
  
      // ------------------------------------------------------------- Properties
  
  
      /**
       * Return descriptive information about this Valve implementation.
       */
      public String getInfo() {
  
          return (info);
  
      }
  
  
      // --------------------------------------------------------- Public Methods
  
  
      /**
       * Invoke the next Valve in the sequence. When the invoke returns, check 
       * the response state, and output an error report is necessary.
       *
       * @param request The servlet request to be processed
       * @param response The servlet response to be created
       * @param context The valve context used to invoke the next valve
       *  in the current processing pipeline
       *
       * @exception IOException if an input/output error occurs
       * @exception ServletException if a servlet error occurs
       */
      public void invoke(Request request, Response response,
                         ValveContext context)
          throws IOException, ServletException {
  
          // Skip logging for non-HTTP requests and responses
          if (!(request instanceof HttpRequest) ||
              !(response instanceof HttpResponse)) {
              context.invokeNext(request, response);
              return;
          }
          HttpRequest hrequest = (HttpRequest) request;
          HttpResponse hresponse = (HttpResponse) response;
          HttpServletRequest hreq =
              (HttpServletRequest) hrequest.getRequest();
          HttpServletResponse hres =
              (HttpServletResponse) hresponse.getResponse();
  
          // Perform the request
          context.invokeNext(request, response);
  
  
  
      }
  
  
      /**
       * Return a String rendering of this object.
       */
      public String toString() {
  
          StringBuffer sb = new StringBuffer("ErrorReportValve[");
          sb.append(container.getName());
          sb.append("]");
          return (sb.toString());
  
      }
  
  
      // ------------------------------------------------------ Protected Methods
  
  
      /**
       * Log a message on the Logger associated with our Container (if any).
       *
       * @param message Message to be logged
       */
      protected void log(String message) {
  
          Logger logger = container.getLogger();
          if (logger != null)
              logger.log(this.toString() + ": " + message);
          else
              System.out.println(this.toString() + ": " + message);
  
      }
  
  
      /**
       * Log a message on the Logger associated with our Container (if any).
       *
       * @param message Message to be logged
       * @param throwable Associated exception
       */
      protected void log(String message, Throwable throwable) {
  
          Logger logger = container.getLogger();
          if (logger != null)
              logger.log(this.toString() + ": " + message, throwable);
          else {
              System.out.println(this.toString() + ": " + message);
              throwable.printStackTrace(System.out);
          }
  
      }
  
  
  }
  
  
  

Mime
View raw message