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

Snippet Preview

Snippet HTML Code

Stack Overflow Questions 
1
  /*
2
   * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3
   *
4
   * Copyright 1997-2008 Sun Microsystems, Inc. All rights reserved.
5
   *
6
   * The contents of this file are subject to the terms of either the GNU
7
   * General Public License Version 2 only ("GPL") or the Common Development
8
   * and Distribution License("CDDL") (collectively, the "License").  You
9
   * may not use this file except in compliance with the License. You can obtain
10
  * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
11
  * or glassfish/bootstrap/legal/LICENSE.txt.  See the License for the specific
12
  * language governing permissions and limitations under the License.
13
  *
14
  * When distributing the software, include this License Header Notice in each
15
  * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
16
  * Sun designates this particular file as subject to the "Classpath" exception
17
  * as provided by Sun in the GPL Version 2 section of the License file that
18
  * accompanied this code.  If applicable, add the following below the License
19
  * Header, with the fields enclosed by brackets [] replaced by your own
20
  * identifying information: "Portions Copyrighted [year]
21
  * [name of copyright owner]"
22
  *
23
  * Contributor(s):
24
  *
25
  * If you wish your version of this file to be governed by only the CDDL or
26
  * only the GPL Version 2, indicate your decision by adding "[Contributor]
27
  * elects to include this software in this distribution under the [CDDL or GPL
28
  * Version 2] license."  If you don't indicate a single choice of license, a
29
  * recipient has the option to distribute your version of this file under
30
  * either the CDDL, the GPL Version 2 or to extend the choice of license to
31
  * its licensees as provided above.  However, if you add GPL Version 2 code
32
  * and therefore, elected the GPL Version 2 license, then the option applies
33
  * only if the new code is made subject to such option by the copyright
34
  * holder.
35
  *
36
  *
37
  * This file incorporates work covered by the following copyright and
38
  * permission notice:
39
  *
40
  * Copyright 2004 The Apache Software Foundation
41
  *
42
  * Licensed under the Apache License, Version 2.0 (the "License");
43
  * you may not use this file except in compliance with the License.
44
  * You may obtain a copy of the License at
45
  *
46
  *     http://www.apache.org/licenses/LICENSE-2.0
47
  *
48
  * Unless required by applicable law or agreed to in writing, software
49
  * distributed under the License is distributed on an "AS IS" BASIS,
50
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
51
  * See the License for the specific language governing permissions and
52
  * limitations under the License.
53
  */
54
 
55
 
56
 
57
 
58
 package javax.servlet;
59
 
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)
81
 
82
  
83
 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 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
131
    public void forward(ServletRequest request, ServletResponse response)
132
	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 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