org.springframework.mock.web

Class MockRequestDispatcher

java.lang.Object

org.springframework.mock.web.MockRequestDispatcher

All Implemented Interfaces:

RequestDispatcher

public class MockRequestDispatcher
extends java.lang.Object
implements RequestDispatcher

Mock implementation of the RequestDispatcher interface.

Since:

1.0.2

Author:

Rod Johnson, Juergen Hoeller, Sam Brannen

Field Summary

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_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 and Description
MockRequestDispatcher(java.lang.String resource) Create a new MockRequestDispatcher for the given resource.

Method Summary

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.
protected MockHttpServletResponse	getMockHttpServletResponse(ServletResponse response) Obtain the underlying MockHttpServletResponse, unwrapping HttpServletResponseWrapper decorators if necessary.
void	include(ServletRequest request, ServletResponse response) Includes the content of a resource (servlet, JSP page, HTML file) in the response.

Methods inherited from class java.lang.Object

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

Constructor Detail

MockRequestDispatcher

public MockRequestDispatcher(java.lang.String resource)

Create a new MockRequestDispatcher for the given resource.

Parameters:

resource - the server resource to dispatch to, located at a particular path or given by a particular name

Method Detail

forward

public void forward(ServletRequest request,
                    ServletResponse response)

Description copied from interface: javax.servlet.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

See Also:

ServletRequest.getDispatcherType()

include

public void include(ServletRequest request,
                    ServletResponse response)

Description copied from interface: javax.servlet.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

See Also:

ServletRequest.getDispatcherType()

getMockHttpServletResponse

protected MockHttpServletResponse getMockHttpServletResponse(ServletResponse response)

Obtain the underlying MockHttpServletResponse, unwrapping HttpServletResponseWrapper decorators if necessary.