org.springframework.test.web.servlet

Class TestDispatcherServlet

java.lang.Object

HttpServlet

org.springframework.web.servlet.HttpServletBean

org.springframework.web.servlet.FrameworkServlet

org.springframework.web.servlet.DispatcherServlet

org.springframework.test.web.servlet.TestDispatcherServlet

All Implemented Interfaces:

Aware, ApplicationContextAware, EnvironmentAware, EnvironmentCapable

final class TestDispatcherServlet
extends DispatcherServlet

A sub-class of DispatcherServlet that saves the result in an MvcResult. The MvcResult instance is expected to be available as the request attribute MockMvc.MVC_RESULT_ATTRIBUTE.

Since:

3.2

Author:

Rossen Stoyanchev, Rob Winch

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	KEY

Fields inherited from class org.springframework.web.servlet.DispatcherServlet

EXCEPTION_ATTRIBUTE, FLASH_MAP_MANAGER_ATTRIBUTE, FLASH_MAP_MANAGER_BEAN_NAME, HANDLER_ADAPTER_BEAN_NAME, HANDLER_EXCEPTION_RESOLVER_BEAN_NAME, HANDLER_MAPPING_BEAN_NAME, INPUT_FLASH_MAP_ATTRIBUTE, LOCALE_RESOLVER_ATTRIBUTE, LOCALE_RESOLVER_BEAN_NAME, MULTIPART_RESOLVER_BEAN_NAME, OUTPUT_FLASH_MAP_ATTRIBUTE, PAGE_NOT_FOUND_LOG_CATEGORY, pageNotFoundLogger, REQUEST_TO_VIEW_NAME_TRANSLATOR_BEAN_NAME, THEME_RESOLVER_ATTRIBUTE, THEME_RESOLVER_BEAN_NAME, THEME_SOURCE_ATTRIBUTE, VIEW_RESOLVER_BEAN_NAME, WEB_APPLICATION_CONTEXT_ATTRIBUTE

Fields inherited from class org.springframework.web.servlet.FrameworkServlet

DEFAULT_CONTEXT_CLASS, DEFAULT_NAMESPACE_SUFFIX, SERVLET_CONTEXT_PREFIX

Fields inherited from class org.springframework.web.servlet.HttpServletBean

logger

Constructor Summary

Constructors

Constructor and Description
TestDispatcherServlet(WebApplicationContext webApplicationContext) Create a new instance with the given web application context.

Method Summary

Modifier and Type	Method and Description
protected HandlerExecutionChain	getHandler(HttpServletRequest request) Return the HandlerExecutionChain for this request.
protected DefaultMvcResult	getMvcResult(ServletRequest request)
protected ModelAndView	processHandlerException(HttpServletRequest request, HttpServletResponse response, java.lang.Object handler, java.lang.Exception ex) Determine an error ModelAndView via the registered HandlerExceptionResolvers.
private void	registerAsyncResultInterceptors(HttpServletRequest request)
protected void	render(ModelAndView mv, HttpServletRequest request, HttpServletResponse response) Render the given ModelAndView.
protected void	service(HttpServletRequest request, HttpServletResponse response) Override the parent class implementation in order to intercept PATCH requests.

Methods inherited from class org.springframework.web.servlet.DispatcherServlet

buildLocaleContext, checkMultipart, cleanupMultipart, createDefaultStrategy, doDispatch, doService, getDefaultStrategies, getDefaultStrategy, getDefaultViewName, getHandlerAdapter, getMultipartResolver, getThemeSource, initStrategies, noHandlerFound, onRefresh, resolveViewName, setCleanupAfterInclude, setDetectAllHandlerAdapters, setDetectAllHandlerExceptionResolvers, setDetectAllHandlerMappings, setDetectAllViewResolvers, setThrowExceptionIfNoHandlerFound

Methods inherited from class org.springframework.web.servlet.FrameworkServlet

applyInitializers, buildRequestAttributes, configureAndRefreshWebApplicationContext, createWebApplicationContext, createWebApplicationContext, destroy, doDelete, doGet, doOptions, doPost, doPut, doTrace, findWebApplicationContext, getContextAttribute, getContextClass, getContextConfigLocation, getContextId, getNamespace, getServletContextAttributeName, getUsernameForRequest, getWebApplicationContext, initFrameworkServlet, initServletBean, initWebApplicationContext, onApplicationEvent, postProcessWebApplicationContext, processRequest, refresh, setApplicationContext, setContextAttribute, setContextClass, setContextConfigLocation, setContextId, setContextInitializerClasses, setContextInitializers, setDispatchOptionsRequest, setDispatchTraceRequest, setNamespace, setPublishContext, setPublishEvents, setThreadContextInheritable

Methods inherited from class org.springframework.web.servlet.HttpServletBean

addRequiredProperty, createEnvironment, getEnvironment, getServletContext, getServletName, init, initBeanWrapper, setEnvironment

Methods inherited from class java.lang.Object

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

Field Detail

KEY

private static final java.lang.String KEY

Constructor Detail

TestDispatcherServlet

public TestDispatcherServlet(WebApplicationContext webApplicationContext)

Create a new instance with the given web application context.

Method Detail

service

protected void service(HttpServletRequest request,
                       HttpServletResponse response)
                throws ServletException,
                       java.io.IOException

Description copied from class: FrameworkServlet

Override the parent class implementation in order to intercept PATCH requests.

Overrides:

service in class FrameworkServlet

Throws:

ServletException

java.io.IOException

registerAsyncResultInterceptors

private void registerAsyncResultInterceptors(HttpServletRequest request)

getMvcResult

protected DefaultMvcResult getMvcResult(ServletRequest request)

getHandler

protected HandlerExecutionChain getHandler(HttpServletRequest request)
                                    throws java.lang.Exception

Description copied from class: DispatcherServlet

Return the HandlerExecutionChain for this request.

Tries all handler mappings in order.

Overrides:

getHandler in class DispatcherServlet

Parameters:

request - current HTTP request

Returns:

the HandlerExecutionChain, or null if no handler could be found

Throws:

java.lang.Exception

render

protected void render(ModelAndView mv,
                      HttpServletRequest request,
                      HttpServletResponse response)
               throws java.lang.Exception

Description copied from class: DispatcherServlet

Render the given ModelAndView.

This is the last stage in handling a request. It may involve resolving the view by name.

Overrides:

render in class DispatcherServlet

Parameters:

mv - the ModelAndView to render

request - current HTTP servlet request

response - current HTTP servlet response

Throws:

java.lang.Exception - if there's a problem rendering the view

processHandlerException

protected ModelAndView processHandlerException(HttpServletRequest request,
                                               HttpServletResponse response,
                                               java.lang.Object handler,
                                               java.lang.Exception ex)
                                        throws java.lang.Exception

Description copied from class: DispatcherServlet

Determine an error ModelAndView via the registered HandlerExceptionResolvers.

Overrides:

processHandlerException in class DispatcherServlet

Parameters:

request - current HTTP request

response - current HTTP response

handler - the executed handler, or null if none chosen at the time of the exception (for example, if multipart resolution failed)

ex - the exception that got thrown during handler execution

Returns:

a corresponding ModelAndView to forward to

Throws:

java.lang.Exception - if no error ModelAndView found