RequestDispatcher.java
上传用户:tanyanyong
上传日期:2013-06-23
资源大小:1355k
文件大小:6k
源码类别:

电子政务应用

开发平台:

MultiPlatform

  1. /*
  2.  * The Apache Software License, Version 1.1
  3.  *
  4.  * Copyright (c) 1999 The Apache Software Foundation.  All rights 
  5.  * reserved.
  6.  *
  7.  * Redistribution and use in source and binary forms, with or without
  8.  * modification, are permitted provided that the following conditions
  9.  * are met:
  10.  *
  11.  * 1. Redistributions of source code must retain the above copyright
  12.  *    notice, this list of conditions and the following disclaimer. 
  13.  *
  14.  * 2. Redistributions in binary form must reproduce the above copyright
  15.  *    notice, this list of conditions and the following disclaimer in
  16.  *    the documentation and/or other materials provided with the
  17.  *    distribution.
  18.  *
  19.  * 3. The end-user documentation included with the redistribution, if
  20.  *    any, must include the following acknowlegement:  
  21.  *       "This product includes software developed by the 
  22.  *        Apache Software Foundation (http://www.apache.org/)."
  23.  *    Alternately, this acknowlegement may appear in the software itself,
  24.  *    if and wherever such third-party acknowlegements normally appear.
  25.  *
  26.  * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
  27.  *    Foundation" must not be used to endorse or promote products derived
  28.  *    from this software without prior written permission. For written 
  29.  *    permission, please contact apache@apache.org.
  30.  *
  31.  * 5. Products derived from this software may not be called "Apache"
  32.  *    nor may "Apache" appear in their names without prior written
  33.  *    permission of the Apache Group.
  34.  *
  35.  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  36.  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  37.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  38.  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  39.  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  40.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  41.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  42.  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  43.  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  44.  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  45.  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  46.  * SUCH DAMAGE.
  47.  * ====================================================================
  48.  *
  49.  * This software consists of voluntary contributions made by many
  50.  * individuals on behalf of the Apache Software Foundation.  For more
  51.  * information on the Apache Software Foundation, please see
  52.  * <http://www.apache.org/>.
  53.  *
  54.  * ====================================================================
  55.  *
  56.  * This source code implements specifications defined by the Java
  57.  * Community Process. In order to remain compliant with the specification
  58.  * DO NOT add / change / or delete method signatures!
  59.  */ 
  60. package javax.servlet;
  61. import java.io.IOException;
  62. /**
  63.  * Defines an object that receives requests from the client
  64.  * and sends them to any resource (such as a servlet, 
  65.  * HTML file, or JSP file) on the server. The servlet
  66.  * container creates the <code>RequestDispatcher</code> object,
  67.  * which is used as a wrapper around a server resource located
  68.  * at a particular path or given by a particular name.
  69.  *
  70.  * <p>This interface is intended to wrap servlets,
  71.  * but a servlet container can create <code>RequestDispatcher</code>
  72.  * objects to wrap any type of resource.
  73.  *
  74.  * @author  Various
  75.  * @version  $Version$
  76.  *
  77.  * @see  ServletContext#getRequestDispatcher(java.lang.String)
  78.  * @see  ServletContext#getNamedDispatcher(java.lang.String)
  79.  * @see  ServletRequest#getRequestDispatcher(java.lang.String)
  80.  *
  81.  */
  82.  
  83. public interface RequestDispatcher {
  84. /**
  85.  * Forwards a request from
  86.  * a servlet to another resource (servlet, JSP file, or
  87.  * HTML file) on the server. This method allows
  88.  * one servlet to do preliminary processing of
  89.  * a request and another resource to generate
  90.  * the response.
  91.  *
  92.  * <p>For a <code>RequestDispatcher</code> obtained via 
  93.  * <code>getRequestDispatcher()</code>, the <code>ServletRequest</code> 
  94.  * object has its path elements and parameters adjusted to match
  95.  * the path of the target resource.
  96.  *
  97.  * <p><code>forward</code> should be called before the response has been 
  98.  * committed to the client (before response body output has been flushed).  
  99.  * If the response already has been committed, this method throws
  100.  * an <code>IllegalStateException</code>.
  101.  * Uncommitted output in the response buffer is automatically cleared 
  102.  * before the forward.
  103.  *
  104.  * <p>The request and response parameters must be the same
  105.  * objects as were passed to the calling servlet's service method.
  106.  *
  107.  *
  108.  * @param request a {@link ServletRequest} object
  109.  * that represents the request the client
  110.  *  makes of the servlet
  111.  *
  112.  * @param response a {@link ServletResponse} object
  113.  * that represents the response the servlet
  114.  * returns to the client
  115.  *
  116.  * @exception ServletException if the target resource throws this exception
  117.  *
  118.  * @exception IOException if the target resource throws this exception
  119.  *
  120.  * @exception IllegalStateException if the response was already committed
  121.  *
  122.  */
  123.     public void forward(ServletRequest request, ServletResponse response)
  124. throws ServletException, IOException;
  125.     /**
  126.      *
  127.      * Includes the content of a resource (servlet, JSP page,
  128.      * HTML file) in the response. In essence, this method enables 
  129.      * programmatic server-side includes.
  130.      *
  131.      * <p>The {@link ServletResponse} object has its path elements
  132.      * and parameters remain unchanged from the caller's. The included
  133.      * servlet cannot change the response status code or set headers;
  134.      * any attempt to make a change is ignored.
  135.      *
  136.      * <p>The request and response parameters must be the same
  137.      * objects as were passed to the calling servlet's service method.
  138.      *
  139.      *
  140.      * @param request  a {@link ServletRequest} object 
  141.      * that contains the client's request
  142.      *
  143.      * @param response  a {@link ServletResponse} object 
  144.      *  that contains the servlet's response
  145.      *
  146.      * @exception ServletException  if the included resource throws this exception
  147.      *
  148.      * @exception IOException  if the included resource throws this exception
  149.      *
  150.      *
  151.      */
  152.      
  153.     public void include(ServletRequest request, ServletResponse response)
  154. throws ServletException, IOException;
  155. }