Undertow 2.3.12.Final · io.undertow.servlet.spec.RequestDispatcherImpl

Modifier and Type	Field and Description
private final ServletChain	chain
private final boolean	named
private final String	path
private final ServletContextImpl	servletContext

Access	Constructor and Description
public	RequestDispatcherImpl(final String path, final ServletContextImpl servletContext)
public	RequestDispatcherImpl(final ServletChain chain, final ServletContextImpl servletContext)

Method Summary

Modifier and Type	Method and Description
public void	error(ServletRequestContext servletRequestContext, final ServletRequest request, final ServletResponse response, final String servletName, final String message)
public void	error(ServletRequestContext servletRequestContext, final ServletRequest request, final ServletResponse response, final String servletName)
public void	error(ServletRequestContext servletRequestContext, final ServletRequest request, final ServletResponse response, final String servletName, final Throwable exception)
private void	error(ServletRequestContext servletRequestContext, final ServletRequest request, final ServletResponse response, final String servletName, final Throwable exception, final String message)
public void	forward(final ServletRequest a `ServletRequest` object that represents the request the client makes of the servlet request, final ServletResponse a `ServletResponse` object that represents the response the servlet returns to the client response) Implements jakarta.servlet.RequestDispatcher.forward. Forwards a request from a servlet to another resource (servlet, JSP file, or HTML file) on the server.
private void	forwardImpl(ServletRequest request, ServletResponse response, ServletRequestContext servletRequestContext)
private void	forwardImplSetup(final ServletRequest request, final ServletResponse response)
public void	include(final ServletRequest a `ServletRequest` object that contains the client's request request, final ServletResponse a `ServletResponse` object that contains the servlet's response response) Implements jakarta.servlet.RequestDispatcher.include. Includes the content of a resource (servlet, JSP page, HTML file) in the response.
private void	includeImpl(ServletRequest request, ServletResponse response, ServletRequestContext servletRequestContext, HttpServletRequestImpl requestImpl, HttpServletResponseImpl responseImpl)
public void	mock(ServletRequest request, ServletResponse response)
private void	setupIncludeImpl(final ServletRequest request, final ServletResponse response)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

chain	back to summary
private final ServletChain chain

named	back to summary
private final boolean named

path	back to summary
private final String path

servletContext	back to summary
private final ServletContextImpl servletContext

RequestDispatcherImpl	back to summary
public RequestDispatcherImpl(final String path, final ServletContextImpl servletContext)

RequestDispatcherImpl	back to summary
public RequestDispatcherImpl(final ServletChain chain, final ServletContextImpl servletContext)

Method Detail

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

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

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

error	back to summary
private void error(ServletRequestContext servletRequestContext, final ServletRequest request, final ServletResponse response, final String servletName, final Throwable exception, final String message) throws ServletException, IOException

forward back to summary

forward	back to summary
public void forward(final ServletRequest request, final ServletResponse response) throws ServletException, IOException Implements jakarta.servlet.RequestDispatcher.forward. Doc from jakarta.servlet.RequestDispatcher.forward. 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 Annotations @Override Exceptions ServletException: if the target resource throws this exception IOException: if the target resource throws this exception

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

Implements jakarta.servlet.RequestDispatcher.forward.

Doc from jakarta.servlet.RequestDispatcher.forward.

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

Annotations

@Override

Exceptions

ServletException:: if the target resource throws this exception
IOException:: if the target resource throws this exception

forwardImpl	back to summary
private void forwardImpl(ServletRequest request, ServletResponse response, ServletRequestContext servletRequestContext) throws ServletException, IOException

forwardImplSetup	back to summary
private void forwardImplSetup(final ServletRequest request, final ServletResponse response) throws ServletException, IOException

include back to summary

include	back to summary
public void include(final ServletRequest request, final ServletResponse response) throws ServletException, IOException Implements jakarta.servlet.RequestDispatcher.include. Doc from jakarta.servlet.RequestDispatcher.include. 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 Annotations @Override Exceptions ServletException: if the included resource throws this exception IOException: if the included resource throws this exception

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

Implements jakarta.servlet.RequestDispatcher.include.

Doc from jakarta.servlet.RequestDispatcher.include.

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.

Parameters

request:ServletRequest: a ServletRequest object that contains the client's request
response:ServletResponse: a ServletResponse object that contains the servlet's response

Annotations

@Override

Exceptions

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

includeImpl	back to summary
private void includeImpl(ServletRequest request, ServletResponse response, ServletRequestContext servletRequestContext, HttpServletRequestImpl requestImpl, HttpServletResponseImpl responseImpl) throws ServletException, IOException

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

setupIncludeImpl	back to summary
private void setupIncludeImpl(final ServletRequest request, final ServletResponse response) throws ServletException, IOException

public Class RequestDispatcherImpl

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail