Top Description Methods
javax.servlet

public Interface RequestDispatcher

Imports
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.

Version
$Rev: 46019 $ $Date: 2004-09-14 04:56:06 -0500 (Tue, 14 Sep 2004) $
See Also
ServletContext#getRequestDispatcher(java.lang.String), ServletContext#getNamedDispatcher(java.lang.String), ServletRequest#getRequestDispatcher(java.lang.String)

Method Summary

Modifier and TypeMethod and Description
public void
forward(ServletRequest
a ServletRequest object that represents the request the client makes of the servlet
request, ServletResponse
a ServletResponse object that represents the response the servlet returns to the client
response)

Forwards a request from a servlet to another resource (servlet, JSP file, or HTML file) on the server.

public void
include(ServletRequest
a ServletRequest object that contains the client's request
request, ServletResponse
a ServletResponse object that contains the servlet's response
response)

Includes the content of a resource (servlet, JSP page, HTML file) in the response.

Method Detail

forwardback to summary
public void forward(ServletRequest request, ServletResponse response) throws ServletException, IOException

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:ServletRequest

a ServletRequest object that represents the request the client makes of the servlet

response:ServletResponse

a ServletResponse object that represents the response the servlet returns to the client

Exceptions
ServletException:
if the target resource throws this exception
IOException:
if the target resource throws this exception
IllegalStateException:
if the response was already committed
includeback to summary
public void include(ServletRequest request, ServletResponse response) 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:ServletRequest

a ServletRequest object that contains the client's request

response:ServletResponse

a ServletResponse object that contains the servlet's response

Exceptions
ServletException:
if the included resource throws this exception
IOException:
if the included resource throws this exception