Package io.undertow.servlet.spec

Class RequestDispatcherImpl

java.lang.Object

io.undertow.servlet.spec.RequestDispatcherImpl

All Implemented Interfaces:

RequestDispatcher

public class RequestDispatcherImpl
extends Object
implements RequestDispatcher

Author:

Stuart Douglas

Field Summary

Fields inherited from interface jakarta.servlet.RequestDispatcher

ERROR_EXCEPTION, ERROR_EXCEPTION_TYPE, ERROR_MESSAGE, ERROR_REQUEST_URI, ERROR_SERVLET_NAME, ERROR_STATUS_CODE, FORWARD_CONTEXT_PATH, FORWARD_MAPPING, FORWARD_PATH_INFO, FORWARD_QUERY_STRING, FORWARD_REQUEST_URI, FORWARD_SERVLET_PATH, INCLUDE_CONTEXT_PATH, INCLUDE_MAPPING, INCLUDE_PATH_INFO, INCLUDE_QUERY_STRING, INCLUDE_REQUEST_URI, INCLUDE_SERVLET_PATH

Constructor Summary

Constructors

Constructor	Description
RequestDispatcherImpl(ServletChain chain, ServletContextImpl servletContext)
RequestDispatcherImpl(String path, ServletContextImpl servletContext)

Method Summary

Modifier and Type	Method	Description
void	error(ServletRequestContext servletRequestContext, ServletRequest request, ServletResponse response, String servletName)
void	error(ServletRequestContext servletRequestContext, ServletRequest request, ServletResponse response, String servletName, String message)
void	error(ServletRequestContext servletRequestContext, ServletRequest request, ServletResponse response, String servletName, Throwable exception)
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.
void	mock(ServletRequest request, ServletResponse response)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

RequestDispatcherImpl

public RequestDispatcherImpl(String path,
 ServletContextImpl servletContext)

RequestDispatcherImpl

public RequestDispatcherImpl(ServletChain chain,
 ServletContextImpl servletContext)

Method Details

forward

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

Description copied from 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.

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

Specified by:

forward in interface RequestDispatcher

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

IOException - if the target resource throws this exception

See Also:

• ServletRequest.getDispatcherType()

include

public void include(ServletRequest request,
 ServletResponse response)
             throws ServletException,
IOException

Description copied from interface: RequestDispatcher

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.

Specified by:

include in interface RequestDispatcher

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

IOException - if the included resource throws this exception

See Also:

• ServletRequest.getDispatcherType()

error

public void error(ServletRequestContext servletRequestContext,
 ServletRequest request,
 ServletResponse response,
 String servletName,
 String message)
           throws ServletException,
IOException

Throws:

ServletException

IOException

error

public void error(ServletRequestContext servletRequestContext,
 ServletRequest request,
 ServletResponse response,
 String servletName)
           throws ServletException,
IOException

Throws:

ServletException

IOException

error

public void error(ServletRequestContext servletRequestContext,
 ServletRequest request,
 ServletResponse response,
 String servletName,
 Throwable exception)
           throws ServletException,
IOException

Throws:

ServletException

IOException

mock

public void mock(ServletRequest request,
 ServletResponse response)
          throws ServletException,
IOException

Throws:

ServletException

IOException