Find Usages Diff Raw Download HTML Widget
Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions 
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
 
Defines an object that receives requests from the client and sends them to any resource (such as a servlet, HTML file, or JSP file) on the server. The servlet container creates the RequestDispatcher object, which is used as a wrapper around a server resource located at a particular path or given by a particular name.

This interface is intended to wrap servlets, but a servlet container can create RequestDispatcher objects to wrap any type of resource.

Author(s):
Various
Version:
$Version$
See also:
ServletContext.getRequestDispatcher(java.lang.String)
ServletContext.getNamedDispatcher(java.lang.String)
ServletRequest.getRequestDispatcher(java.lang.String)
86
 
87
  
88
 public interface RequestDispatcher {





Forwards a request from a servlet to another resource (servlet, JSP file, or HTML file) on the server. This method allows one servlet to do preliminary processing of a request and another resource to generate the response.

For a RequestDispatcher obtained via getRequestDispatcher(), the ServletRequest object has its path elements and parameters adjusted to match the path of the target resource.

forward should be called before the response has been committed to the client (before response body output has been flushed). If the response already has been committed, this method throws an IllegalStateException. Uncommitted output in the response buffer is automatically cleared before the forward.

The request and response parameters must be the same objects as were passed to the calling servlet's service method.

Parameters:
request a ServletRequest object that represents the request the client makes of the servlet
response a ServletResponse object that represents the response the servlet returns to the client
Throws:
ServletException if the target resource throws this exception
java.io.IOException if the target resource throws this exception
java.lang.IllegalStateException if the response was already committed
134
    public void forward(ServletRequest request, ServletResponse response)
135
	throws ServletException, IOException;




    
Includes the content of a resource (servlet, JSP page, HTML file) in the response. In essence, this method enables programmatic server-side includes.

The ServletResponse object has its path elements and parameters remain unchanged from the caller's. The included servlet cannot change the response status code or set headers; any attempt to make a change is ignored.

The request and response parameters must be the same objects as were passed to the calling servlet's service method.

Parameters:
request a ServletRequest object that contains the client's request
response a ServletResponse object that contains the servlet's response
Throws:
ServletException if the included resource throws this exception
java.io.IOException if the included resource throws this exception
167
     
168
    public void include(ServletRequest request, ServletResponse response)
New to GrepCode? Check out our FAQ X