Class SimpleMappingExceptionResolver

java.lang.Object

org.springframework.web.servlet.handler.AbstractHandlerExceptionResolver

org.springframework.web.servlet.handler.SimpleMappingExceptionResolver

All Implemented Interfaces:

Ordered, HandlerExceptionResolver

public class SimpleMappingExceptionResolver
extends AbstractHandlerExceptionResolver

HandlerExceptionResolver implementation that allows for mapping exception class names to view names, either for a set of given handlers or for all handlers in the DispatcherServlet.

Error views are analogous to error page JSPs, but can be used with any kind of exception including any checked one, with fine-granular mappings for specific handlers.

Since:

22.11.2003

Author:

Juergen Hoeller, Arjen Poutsma, Rossen Stoyanchev

See Also:

• DispatcherServlet

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_EXCEPTION_ATTRIBUTE	The default name of the exception attribute: "exception".

Fields inherited from class AbstractHandlerExceptionResolver

logger

Fields inherited from interface Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
SimpleMappingExceptionResolver()

Method Summary

Modifier and Type	Method	Description
void	addStatusCode(String viewName, int statusCode)	An alternative to setStatusCodes(Properties) for use with Java-based configuration.
protected void	applyStatusCodeIfPossible(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, int statusCode)	Apply the specified HTTP status code to the given response, if possible (that is, if not executing within an include request).
protected @Nullable Integer	determineStatusCode(jakarta.servlet.http.HttpServletRequest request, String viewName)	Determine the HTTP status code to apply for the given error view.
protected @Nullable String	determineViewName(Exception ex, jakarta.servlet.http.HttpServletRequest request)	Determine the view name for the given exception, first checking against the "excludedExecptions", then searching the "exceptionMappings", and finally using the "defaultErrorView" as a fallback.
protected @Nullable ModelAndView	doResolveException(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, @Nullable Object handler, Exception ex)	Actually resolve the given exception that got thrown during on handler execution, returning a ModelAndView that represents a specific error page if appropriate.
protected @Nullable String	findMatchingViewName(Properties exceptionMappings, Exception ex)	Find a matching view name in the given exception mappings.
protected int	getDepth(String exceptionMapping, Exception ex)	Return the depth to the superclass matching.
protected ModelAndView	getModelAndView(String viewName, Exception ex)	Return a ModelAndView for the given view name and exception.
protected ModelAndView	getModelAndView(String viewName, Exception ex, jakarta.servlet.http.HttpServletRequest request)	Return a ModelAndView for the given request, view name and exception.
Map<String,Integer>	getStatusCodesAsMap()	Returns the HTTP status codes provided via setStatusCodes(Properties).
void	setDefaultErrorView(String defaultErrorView)	Set the name of the default error view.
void	setDefaultStatusCode(int defaultStatusCode)	Set the default HTTP status code that this exception resolver will apply if it resolves an error view and if there is no status code mapping defined.
void	setExceptionAttribute(@Nullable String exceptionAttribute)	Set the name of the model attribute as which the exception should be exposed.
void	setExceptionMappings(Properties mappings)	Set the mappings between exception class names and error view names.
void	setExcludedExceptions(Class<?>... excludedExceptions)	Set one or more exceptions to be excluded from the exception mappings.
void	setStatusCodes(Properties statusCodes)	Set the HTTP status code that this exception resolver will apply for a given resolved error view.

Methods inherited from class AbstractHandlerExceptionResolver

addMappedHandlerClass, buildLogMessage, getMappedHandlerClasses, getOrder,