home *** CD-ROM | disk | FTP | other *** search
/ PC World 2002 May / PCWorld_2002-05_cd.bin / Komunik / sambar / sambar51p.exe / lib / javaeng.jar / javax / servlet / RequestDispatcher.java < prev    next >
Encoding:
Java Source  |  2001-10-22  |  6.5 KB  |  179 lines
  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.  
  61.  
  62. package javax.servlet;
  63.  
  64. import java.io.IOException;
  65.  
  66.  
  67. /**
  68.  * Defines an object that receives requests from the client
  69.  * and sends them to any resource (such as a servlet, 
  70.  * HTML file, or JSP file) on the server. The servlet
  71.  * container creates the <code>RequestDispatcher</code> object,
  72.  * which is used as a wrapper around a server resource located
  73.  * at a particular path or given by a particular name.
  74.  *
  75.  * <p>This interface is intended to wrap servlets,
  76.  * but a servlet container can create <code>RequestDispatcher</code>
  77.  * objects to wrap any type of resource.
  78.  *
  79.  * @author     Various
  80.  * @version     $Version$
  81.  *
  82.  * @see     ServletContext#getRequestDispatcher(java.lang.String)
  83.  * @see     ServletContext#getNamedDispatcher(java.lang.String)
  84.  * @see     ServletRequest#getRequestDispatcher(java.lang.String)
  85.  *
  86.  */
  87.  
  88. public interface RequestDispatcher {
  89.  
  90.  
  91.  
  92.  
  93.  
  94. /**
  95.  * Forwards a request from
  96.  * a servlet to another resource (servlet, JSP file, or
  97.  * HTML file) on the server. This method allows
  98.  * one servlet to do preliminary processing of
  99.  * a request and another resource to generate
  100.  * the response.
  101.  *
  102.  * <p>For a <code>RequestDispatcher</code> obtained via 
  103.  * <code>getRequestDispatcher()</code>, the <code>ServletRequest</code> 
  104.  * object has its path elements and parameters adjusted to match
  105.  * the path of the target resource.
  106.  *
  107.  * <p><code>forward</code> should be called before the response has been 
  108.  * committed to the client (before response body output has been flushed).  
  109.  * If the response already has been committed, this method throws
  110.  * an <code>IllegalStateException</code>.
  111.  * Uncommitted output in the response buffer is automatically cleared 
  112.  * before the forward.
  113.  *
  114.  * <p>The request and response parameters must be the same
  115.  * objects as were passed to the calling servlet's service method.
  116.  *
  117.  *
  118.  * @param request        a {@link ServletRequest} object
  119.  *                that represents the request the client
  120.  *                 makes of the servlet
  121.  *
  122.  * @param response        a {@link ServletResponse} object
  123.  *                that represents the response the servlet
  124.  *                returns to the client
  125.  *
  126.  * @exception ServletException    if the target resource throws this exception
  127.  *
  128.  * @exception IOException    if the target resource throws this exception
  129.  *
  130.  * @exception IllegalStateException    if the response was already committed
  131.  *
  132.  */
  133.  
  134.     public void forward(ServletRequest request, ServletResponse response)
  135.     throws ServletException, IOException;
  136.  
  137.  
  138.  
  139.  
  140.     /**
  141.      *
  142.      * Includes the content of a resource (servlet, JSP page,
  143.      * HTML file) in the response. In essence, this method enables 
  144.      * programmatic server-side includes.
  145.      *
  146.      * <p>The {@link ServletResponse} object has its path elements
  147.      * and parameters remain unchanged from the caller's. The included
  148.      * servlet cannot change the response status code or set headers;
  149.      * any attempt to make a change is ignored.
  150.      *
  151.      * <p>The request and response parameters must be the same
  152.      * objects as were passed to the calling servlet's service method.
  153.      *
  154.      *
  155.      * @param request             a {@link ServletRequest} object 
  156.      *                    that contains the client's request
  157.      *
  158.      * @param response             a {@link ServletResponse} object 
  159.      *                     that contains the servlet's response
  160.      *
  161.      * @exception ServletException     if the included resource throws this exception
  162.      *
  163.      * @exception IOException         if the included resource throws this exception
  164.      *
  165.      *
  166.      */
  167.      
  168.     public void include(ServletRequest request, ServletResponse response)
  169.     throws ServletException, IOException;
  170. }
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.