Java Servlet API 4.0.1 · javax.servlet.RequestDispatcher

Field Summary

Modifier and Type	Field and Description
public static final String	ERROR_EXCEPTION The name of the request attribute under which the exception object is propagated during an error dispatch
public static final String	ERROR_EXCEPTION_TYPE The name of the request attribute under which the type of the exception object is propagated during an error dispatch
public static final String	ERROR_MESSAGE The name of the request attribute under which the exception message is propagated during an error dispatch
public static final String	ERROR_REQUEST_URI The name of the request attribute under which the request URI whose processing caused the error is propagated during an error dispatch
public static final String	ERROR_SERVLET_NAME The name of the request attribute under which the name of the servlet in which the error occurred is propagated during an error dispatch
public static final String	ERROR_STATUS_CODE The name of the request attribute under which the response status is propagated during an error dispatch
public static final String	FORWARD_CONTEXT_PATH The name of the request attribute under which the original context path is made available to the target of a `forward`
public static final String	FORWARD_MAPPING The name of the request attribute under which the original `javax.servlet.http.HttpServletMapping` is made available to the target of a `forward`
public static final String	FORWARD_PATH_INFO The name of the request attribute under which the original path info is made available to the target of a `forward`
public static final String	FORWARD_QUERY_STRING The name of the request attribute under which the original query string is made available to the target of a `forward`
public static final String	FORWARD_REQUEST_URI The name of the request attribute under which the original request URI is made available to the target of a `forward`
public static final String	FORWARD_SERVLET_PATH The name of the request attribute under which the original servlet path is made available to the target of a `forward`
public static final String	INCLUDE_CONTEXT_PATH The name of the request attribute under which the context path of the target of an `include` is stored
public static final String	INCLUDE_MAPPING The name of the request attribute under which the `javax.servlet.http.HttpServletMapping` of the target of an `include` is stored
public static final String	INCLUDE_PATH_INFO The name of the request attribute under which the path info of the target of an `include` is stored
public static final String	INCLUDE_QUERY_STRING The name of the request attribute under which the query string of the target of an `include` is stored
public static final String	INCLUDE_REQUEST_URI The name of the request attribute under which the request URI of the target of an `include` is stored
public static final String	INCLUDE_SERVLET_PATH The name of the request attribute under which the servlet path of the target of an `include` is stored

Method Summary

Modifier and Type	Method 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.

Field Detail

ERROR_EXCEPTION	back to summary
public static final String ERROR_EXCEPTION The name of the request attribute under which the exception object is propagated during an error dispatch

ERROR_EXCEPTION_TYPE	back to summary
public static final String ERROR_EXCEPTION_TYPE The name of the request attribute under which the type of the exception object is propagated during an error dispatch

ERROR_MESSAGE	back to summary
public static final String ERROR_MESSAGE The name of the request attribute under which the exception message is propagated during an error dispatch

ERROR_REQUEST_URI	back to summary
public static final String ERROR_REQUEST_URI The name of the request attribute under which the request URI whose processing caused the error is propagated during an error dispatch

ERROR_SERVLET_NAME	back to summary
public static final String ERROR_SERVLET_NAME The name of the request attribute under which the name of the servlet in which the error occurred is propagated during an error dispatch

ERROR_STATUS_CODE	back to summary
public static final String ERROR_STATUS_CODE The name of the request attribute under which the response status is propagated during an error dispatch

FORWARD_CONTEXT_PATH	back to summary
public static final String FORWARD_CONTEXT_PATH The name of the request attribute under which the original context path is made available to the target of a `forward`

FORWARD_MAPPING back to summary

FORWARD_MAPPING	back to summary
public static final String FORWARD_MAPPING The name of the request attribute under which the original `javax.servlet.http.HttpServletMapping` is made available to the target of a `forward` Since 4.0

public static final String FORWARD_MAPPING

The name of the request attribute under which the original javax.servlet.http.HttpServletMapping is made available to the target of a forward

Since: 4.0

FORWARD_PATH_INFO	back to summary
public static final String FORWARD_PATH_INFO The name of the request attribute under which the original path info is made available to the target of a `forward`

FORWARD_QUERY_STRING	back to summary
public static final String FORWARD_QUERY_STRING The name of the request attribute under which the original query string is made available to the target of a `forward`

FORWARD_REQUEST_URI	back to summary
public static final String FORWARD_REQUEST_URI The name of the request attribute under which the original request URI is made available to the target of a `forward`

FORWARD_SERVLET_PATH	back to summary
public static final String FORWARD_SERVLET_PATH The name of the request attribute under which the original servlet path is made available to the target of a `forward`

INCLUDE_CONTEXT_PATH	back to summary
public static final String INCLUDE_CONTEXT_PATH The name of the request attribute under which the context path of the target of an `include` is stored

INCLUDE_MAPPING	back to summary
public static final String INCLUDE_MAPPING The name of the request attribute under which the `javax.servlet.http.HttpServletMapping` of the target of an `include` is stored

INCLUDE_PATH_INFO	back to summary
public static final String INCLUDE_PATH_INFO The name of the request attribute under which the path info of the target of an `include` is stored

INCLUDE_QUERY_STRING	back to summary
public static final String INCLUDE_QUERY_STRING The name of the request attribute under which the query string of the target of an `include` is stored

INCLUDE_REQUEST_URI	back to summary
public static final String INCLUDE_REQUEST_URI The name of the request attribute under which the request URI of the target of an `include` is stored

INCLUDE_SERVLET_PATH	back to summary
public static final String INCLUDE_SERVLET_PATH The name of the request attribute under which the servlet path of the target of an `include` is stored

Method Detail

forward back to summary

forward	back 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. This method sets the dispatcher type of the given request to `DispatcherType.FORWARD`. 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 See Also `ServletRequest#getDispatcherType`

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.

This method sets the dispatcher type of the given request to DispatcherType.FORWARD.

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

See Also

ServletRequest#getDispatcherType

include back to summary

include	back 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. This method sets the dispatcher type of the given request to `DispatcherType.INCLUDE`. 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 See Also `ServletRequest#getDispatcherType`

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.

This method sets the dispatcher type of the given request to DispatcherType.INCLUDE.