Java Server Pages

Name

RequestDispatcher

Synopsis

Interface Name:	javax.servlet.RequestDispatcher
Extends:	None
Implemented by:	Internal container-dependent class

Description

The RequestDispatcher class defines an object that receives requests from the client and sends them to any resource (such as a servlet, HTML file, or JSP file) in the same web container. The container creates the RequestDispatcher object, which is used as a wrapper around a resource located at a particular URI path or identified by a particular name.

Interface Declarations

public interface RequestDispatcher {
  public void forward(ServletRequest req, ServletResponse res);
  public void include(ServletRequest req, ServletResponse res);
}

Methods

public void forward(ServletRequest req, ServletResponse res)

Forwards a request from a servlet to another resource (servlet, JSP file, or static file) on the server. For a RequestDispatcher obtained via the getRequestDispatcher( ) method, the ServletRequest object has its path elements and parameters adjusted to match the path of the target resource.

This method must be called before the response has been committed to the client (before response body output has been flushed). If the response has already 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 that were passed to the calling servlet’s service method.

public void include(ServletRequest ...