GrepCode: javax.servlet.RequestDispatcher (.java) - Interface

Maven-Central
/
javax.servlet / servlet-api
/
2.5

3.0-alpha-1
2.5
2.4
2.3
2.2
/
javax.servlet.RequestDispatcher
Find Usages
Diff
Raw
Download
HTML Widget
Stack Overflow Questions
1
  
2
  
3
  /*
4
   * The contents of this file are subject to the terms
5
   * of the Common Development and Distribution License
6
   * (the "License").  You may not use this file except
7
   * in compliance with the License.
8
   *
9
   * You can obtain a copy of the license at
10
  * glassfish/bootstrap/legal/CDDLv1.0.txt or
11
  * https://glassfish.dev.java.net/public/CDDLv1.0.html.
12
  * See the License for the specific language governing
13
  * permissions and limitations under the License.
14
  *
15
  * When distributing Covered Code, include this CDDL
16
  * HEADER in each file and include the License file at
17
  * glassfish/bootstrap/legal/CDDLv1.0.txt.  If applicable,
18
  * add the following below this CDDL HEADER, with the
19
  * fields enclosed by brackets "[]" replaced with your
20
  * own identifying information: Portions Copyright [yyyy]
21
  * [name of copyright owner]
22
  *
23
  * Copyright 2005 Sun Microsystems, Inc. All rights reserved.
24
  *
25
  * Portions Copyright Apache Software Foundation.
26
  */ 
27
 
28
 
29
 package javax.servlet;
30
 
31
 import java.io.IOException;


 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 See also:ServletContext.getRequestDispatcher(java.lang.String)ServletContext.getNamedDispatcher(java.lang.String)ServletRequest.getRequestDispatcher(java.lang.String)
52
 
53
  
54
 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 either the same
 objects as were passed to the calling servlet's service method or be
 subclasses of the ServletRequestWrapper or ServletResponseWrapper classes
 that wrap them.


 
 Parameters:request  a ServletRequest object
    that represents the request the client
     makes of the servletresponse  a ServletResponse object
    that represents the response the servlet
    returns to the client Throws:ServletException if the target resource throws this exceptionjava.io.IOException if the target resource throws this exceptionjava.lang.IllegalStateException if the response was already committed
100
101
102
    public void forward(ServletRequest request, ServletResponse response)
103
	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 either the same
 objects as were passed to the calling servlet's service method or be
 subclasses of the ServletRequestWrapper or ServletResponseWrapper classes
 that wrap them.
 


 
 Parameters:request    a ServletRequest object 
     that contains the client's requestresponse    a ServletResponse object 
      that contains the servlet's response Throws:ServletException  if the included resource throws this exceptionjava.io.IOException   if the included resource throws this exception
137
138
     
139
    public void include(ServletRequest request, ServletResponse response)
140
	throws ServletException, IOException;
141
}