public interface RequestDispatcher
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.
| Modifier and Type | Field and Description | 
|---|---|
| static java.lang.String | ERROR_EXCEPTIONThe name of the request attribute that should be set by the container
 when custom error-handling servlet or JSP page is invoked. | 
| static java.lang.String | ERROR_EXCEPTION_TYPEThe name of the request attribute that should be set by the container
 when custom error-handling servlet or JSP page is invoked. | 
| static java.lang.String | ERROR_MESSAGEThe name of the request attribute that should be set by the container
 when custom error-handling servlet or JSP page is invoked. | 
| static java.lang.String | ERROR_REQUEST_URIThe name of the request attribute that should be set by the container
 when custom error-handling servlet or JSP page is invoked. | 
| static java.lang.String | ERROR_SERVLET_NAMEThe name of the request attribute that should be set by the container
 when custom error-handling servlet or JSP page is invoked. | 
| static java.lang.String | ERROR_STATUS_CODEThe name of the request attribute that should be set by the container
 when custom error-handling servlet or JSP page is invoked. | 
| static java.lang.String | FORWARD_CONTEXT_PATHThe name of the request attribute that should be set by the container
 when the  forward(ServletRequest, ServletResponse)method is
 called. | 
| static java.lang.String | FORWARD_PATH_INFOThe name of the request attribute that should be set by the container
 when the  forward(ServletRequest, ServletResponse)method is
 called. | 
| static java.lang.String | FORWARD_QUERY_STRINGThe name of the request attribute that should be set by the container
 when the  forward(ServletRequest, ServletResponse)method is
 called. | 
| static java.lang.String | FORWARD_REQUEST_URIThe name of the request attribute that should be set by the container
 when the  forward(ServletRequest, ServletResponse)method is
 called. | 
| static java.lang.String | FORWARD_SERVLET_PATHThe name of the request attribute that should be set by the container
 when the  forward(ServletRequest, ServletResponse)method is
 called. | 
| static java.lang.String | INCLUDE_CONTEXT_PATHThe name of the request attribute that should be set by the container
 when the  include(ServletRequest, ServletResponse)method is
 called on theRequestDispatcherobtained by a path and not by a
 name. | 
| static java.lang.String | INCLUDE_PATH_INFOThe name of the request attribute that should be set by the container
 when the  include(ServletRequest, ServletResponse)method is
 called on theRequestDispatcherobtained by a path and not by a
 name. | 
| static java.lang.String | INCLUDE_QUERY_STRINGThe name of the request attribute that should be set by the container
 when the  include(ServletRequest, ServletResponse)method is
 called on theRequestDispatcherobtained by a path and not by a
 name. | 
| static java.lang.String | INCLUDE_REQUEST_URIThe name of the request attribute that should be set by the container
 when the  include(ServletRequest, ServletResponse)method is
 called on theRequestDispatcherobtained by a path and not by a
 name. | 
| static java.lang.String | INCLUDE_SERVLET_PATHThe name of the request attribute that should be set by the container
 when the  include(ServletRequest, ServletResponse)method is
 called on theRequestDispatcherobtained by a path and not by a
 name. | 
| Modifier and Type | Method and Description | 
|---|---|
| void | forward(ServletRequest request,
       ServletResponse response)Forwards a request from a servlet to another resource (servlet, JSP file,
 or HTML file) on the server. | 
| void | include(ServletRequest request,
       ServletResponse response)Includes the content of a resource (servlet, JSP page, HTML file) in the
 response. | 
static final java.lang.String ERROR_EXCEPTION
java.lang.Throwable. See the chapter
 "Error Handling" in the Servlet Specification for details.static final java.lang.String ERROR_EXCEPTION_TYPE
java.lang.Class. See the chapter
 "Error Handling" in the Servlet Specification for details.static final java.lang.String ERROR_MESSAGE
java.lang.String. See the chapter
 "Error Handling" in the Servlet Specification for details.static final java.lang.String ERROR_REQUEST_URI
java.lang.String. See the chapter
 "Error Handling" in the Servlet Specification for details.static final java.lang.String ERROR_SERVLET_NAME
java.lang.String. See the chapter
 "Error Handling" in the Servlet Specification for details.static final java.lang.String ERROR_STATUS_CODE
java.lang.Integer. See the chapter
 "Error Handling" in the Servlet Specification for details.static final java.lang.String FORWARD_CONTEXT_PATH
forward(ServletRequest, ServletResponse) method is
 called. It provides the original value of a path-related property of the
 request. See the chapter "Forwarded Request Parameters" in the Servlet
 Specification for details.static final java.lang.String FORWARD_PATH_INFO
forward(ServletRequest, ServletResponse) method is
 called. It provides the original value of a path-related property of the
 request. See the chapter "Forwarded Request Parameters" in the Servlet
 Specification for details.static final java.lang.String FORWARD_QUERY_STRING
forward(ServletRequest, ServletResponse) method is
 called. It provides the original value of a path-related property of the
 request. See the chapter "Forwarded Request Parameters" in the Servlet
 Specification for details.static final java.lang.String FORWARD_REQUEST_URI
forward(ServletRequest, ServletResponse) method is
 called. It provides the original value of a path-related property of the
 request. See the chapter "Forwarded Request Parameters" in the Servlet
 Specification for details.static final java.lang.String FORWARD_SERVLET_PATH
forward(ServletRequest, ServletResponse) method is
 called. It provides the original value of a path-related property of the
 request. See the chapter "Forwarded Request Parameters" in the Servlet
 Specification for details.static final java.lang.String INCLUDE_CONTEXT_PATH
include(ServletRequest, ServletResponse) method is
 called on the RequestDispatcher obtained by a path and not by a
 name. It provides information on the path that was used to obtain the
 RequestDispatcher instance for this include call. See the chapter
 "Included Request Parameters" in the Servlet Specification for details.static final java.lang.String INCLUDE_PATH_INFO
include(ServletRequest, ServletResponse) method is
 called on the RequestDispatcher obtained by a path and not by a
 name. It provides information on the path that was used to obtain the
 RequestDispatcher instance for this include call. See the chapter
 "Included Request Parameters" in the Servlet Specification for details.static final java.lang.String INCLUDE_QUERY_STRING
include(ServletRequest, ServletResponse) method is
 called on the RequestDispatcher obtained by a path and not by a
 name. It provides information on the path that was used to obtain the
 RequestDispatcher instance for this include call. See the chapter
 "Included Request Parameters" in the Servlet Specification for details.static final java.lang.String INCLUDE_REQUEST_URI
include(ServletRequest, ServletResponse) method is
 called on the RequestDispatcher obtained by a path and not by a
 name. It provides information on the path that was used to obtain the
 RequestDispatcher instance for this include call. See the chapter
 "Included Request Parameters" in the Servlet Specification for details.static final java.lang.String INCLUDE_SERVLET_PATH
include(ServletRequest, ServletResponse) method is
 called on the RequestDispatcher obtained by a path and not by a
 name. It provides information on the path that was used to obtain the
 RequestDispatcher instance for this include call. See the chapter
 "Included Request Parameters" in the Servlet Specification for details.void forward(ServletRequest request, ServletResponse response) throws ServletException, java.io.IOException
 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.
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 clientServletException - if the target resource throws this exceptionjava.io.IOException - if the target resource throws this exceptionjava.lang.IllegalStateException - if the response was already committedvoid include(ServletRequest request, ServletResponse response) throws ServletException, java.io.IOException
 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.
request - a ServletRequest object that contains the client's
            requestresponse - a ServletResponse object that contains the servlet's
            responseServletException - if the included resource throws this exceptionjava.io.IOException - if the included resource throws this exceptionCopyright © 2000-2020 Apache Software Foundation. All Rights Reserved.