Package org.eclipse.jetty.server

Class Dispatcher

java.lang.Object

org.eclipse.jetty.server.Dispatcher

All Implemented Interfaces:

RequestDispatcher

@Deprecated(since="2021-05-27")
public class Dispatcher
extends Object
implements RequestDispatcher

Deprecated.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	__FORWARD_PREFIX	Deprecated. Dispatch include attribute names
static final String	__INCLUDE_PREFIX	Deprecated. Dispatch include attribute names

Fields inherited from interface javax.servlet.RequestDispatcher

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

Constructor Summary

Constructors

Constructor	Description
Dispatcher(ContextHandler contextHandler, String name)	Deprecated.
Dispatcher(ContextHandler contextHandler, HttpURI uri, String pathInContext)	Deprecated.

Method Summary

Modifier and Type	Method	Description
void	error(ServletRequest request, ServletResponse response)	Deprecated.
void	forward(ServletRequest request, ServletResponse response)	Deprecated. Forwards a request from a servlet to another resource (servlet, JSP file, or HTML file) on the server.
void	include(ServletRequest request, ServletResponse response)	Deprecated. Includes the content of a resource (servlet, JSP page, HTML file) in the response.
String	toString()	Deprecated.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

__INCLUDE_PREFIX

public static final String __INCLUDE_PREFIX

Deprecated.

Dispatch include attribute names

See Also:

• Constant Field Values

__FORWARD_PREFIX

public static final String __FORWARD_PREFIX

Deprecated.

Dispatch include attribute names

See Also:

• Constant Field Values

Constructor Details

Dispatcher

public Dispatcher(ContextHandler contextHandler,
 HttpURI uri,
 String pathInContext)

Deprecated.

Dispatcher

public Dispatcher(ContextHandler contextHandler,
 String name)
           throws IllegalStateException

Deprecated.

Throws:

IllegalStateException

Method Details

forward

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

Deprecated.

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.

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

error

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

Deprecated.

Throws:

ServletException

IOException

include

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

Deprecated.

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.

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

toString

public String toString()

Deprecated.

Overrides:

toString in class Object