Spring Framework 6.1.4 · org.springframework.web.servlet.handler.SimpleMappingExceptionResolver

Modifier and Type	Field and Description
public static final String	DEFAULT_EXCEPTION_ATTRIBUTE The default name of the exception attribute: "exception".
private String	defaultErrorView
private Integer	defaultStatusCode
private String	exceptionAttribute
private Properties	exceptionMappings
private Class<?>[]	excludedExceptions
private final Map<String, Integer>	statusCodes

Access	Constructor and Description
public	SimpleMappingExceptionResolver()

Method Summary

Modifier and Type	Method and Description
public void	addStatusCode(String viewName, int statusCode) An alternative to `setStatusCodes(Properties)` for use with Java-based configuration.
protected void	applyStatusCodeIfPossible(HttpServletRequest current HTTP request request, HttpServletResponse current HTTP response response, int the status code to apply statusCode) Apply the specified HTTP status code to the given response, if possible (that is, if not executing within an include request).
protected Integer	Returns: the HTTP status code to use, or `null` for the servlet container's default (200 in case of a standard error view) determineStatusCode(HttpServletRequest current HTTP request request, String the name of the error view viewName) Determine the HTTP status code to apply for the given error view.
protected String	Returns: the resolved view name, or `null` if excluded or none found determineViewName(Exception the exception that got thrown during handler execution ex, HttpServletRequest current HTTP request (useful for obtaining metadata) 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 ModelAndView	Returns: a corresponding `ModelAndView` to forward to, or `null` for default processing in the resolution chain doResolveException(HttpServletRequest current HTTP request request, HttpServletResponse current HTTP response response, Object the executed handler, or `null` if none chosen at the time of the exception (for example, if multipart resolution failed) handler, Exception the exception that got thrown during handler execution ex) Implements abstract org.springframework.web.servlet.handler.AbstractHandlerExceptionResolver.doResolveException. Actually resolve the given exception that got thrown during on handler execution, returning a ModelAndView that represents a specific error page if appropriate.
protected String	Returns: the view name, or `null` if none found findMatchingViewName(Properties mappings between exception class names and error view names exceptionMappings, Exception the exception that got thrown during handler execution 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.
private int	getDepth(String exceptionMapping, Class<?> exceptionClass, int depth)
protected ModelAndView	Returns: the ModelAndView instance getModelAndView(String the name of the error view viewName, Exception the exception that got thrown during handler execution ex, HttpServletRequest current HTTP request (useful for obtaining metadata) request) Return a ModelAndView for the given request, view name and exception.
protected ModelAndView	Returns: the ModelAndView instance getModelAndView(String the name of the error view viewName, Exception the exception that got thrown during handler execution ex) Return a ModelAndView for the given view name and exception.
public Map<String, Integer>	getStatusCodesAsMap() Returns the HTTP status codes provided via `setStatusCodes(Properties)`.
public void	setDefaultErrorView(String defaultErrorView) Set the name of the default error view.
public void	setDefaultStatusCode(int the HTTP status code value, for example 500 (`HttpServletResponse#SC_INTERNAL_SERVER_ERROR`) or 404 (`HttpServletResponse#SC_NOT_FOUND`) 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.
public void	setExceptionAttribute(String exceptionAttribute) Set the name of the model attribute as which the exception should be exposed.
public void	setExceptionMappings(Properties exception patterns (can also be fully qualified class names) as keys, and error view names as values mappings) Set the mappings between exception class names and error view names.
public void	setExcludedExceptions(Class<?>... one or more excluded exception types excludedExceptions) Set one or more exceptions to be excluded from the exception mappings.
public void	setStatusCodes(Properties statusCodes) Set the HTTP status code that this exception resolver will apply for a given resolved error view.

Inherited from org.springframework.web.servlet.handler.AbstractHandlerExceptionResolver:: addMappedHandlerClass buildLogMessage getMappedHandlerClasses getOrder hasHandlerMappings logException prepareResponse preventCaching resolveException setMappedHandlerClasses setMappedHandlerPredicate setMappedHandlers setOrder setPreventResponseCaching setWarnLogCategory shouldApplyTo

DEFAULT_EXCEPTION_ATTRIBUTE	back to summary
public static final String DEFAULT_EXCEPTION_ATTRIBUTE The default name of the exception attribute: "exception".

defaultErrorView	back to summary
private String defaultErrorView Annotations @Nullable

defaultStatusCode	back to summary
private Integer defaultStatusCode Annotations @Nullable

exceptionAttribute	back to summary
private String exceptionAttribute Annotations @Nullable

exceptionMappings	back to summary
private Properties exceptionMappings Annotations @Nullable

excludedExceptions	back to summary
private Class<?>[] excludedExceptions Annotations @Nullable

statusCodes	back to summary
private final Map<String, Integer> statusCodes

SimpleMappingExceptionResolver	back to summary
public SimpleMappingExceptionResolver()

Method Detail

addStatusCode	back to summary
public void addStatusCode(String viewName, int statusCode) An alternative to `setStatusCodes(Properties)` for use with Java-based configuration.

applyStatusCodeIfPossible back to summary

applyStatusCodeIfPossible	back to summary
protected void applyStatusCodeIfPossible(HttpServletRequest request, 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). Parameters request:HttpServletRequest current HTTP request response:HttpServletResponse current HTTP response statusCode:int the status code to apply See Also `determineStatusCode`, `setDefaultStatusCode`, `HttpServletResponse#setStatus`

protected void applyStatusCodeIfPossible(HttpServletRequest request, 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).

Parameters

request:HttpServletRequest: current HTTP request
response:HttpServletResponse: current HTTP response
statusCode:int: the status code to apply

determineStatusCode back to summary

determineStatusCode	back to summary
protected Integer determineStatusCode(HttpServletRequest request, String viewName) Determine the HTTP status code to apply for the given error view. The default implementation returns the status code for the given view name (specified through the `statusCodes` property), or falls back to the `defaultStatusCode` if there is no match. Override this in a custom subclass to customize this behavior. Parameters request:HttpServletRequest current HTTP request viewName:String the name of the error view Returns:Integer the HTTP status code to use, or `null` for the servlet container's default (200 in case of a standard error view) Annotations @Nullable See Also `setDefaultStatusCode`, `applyStatusCodeIfPossible`

protected Integer determineStatusCode(HttpServletRequest request, String viewName)

Determine the HTTP status code to apply for the given error view.

The default implementation returns the status code for the given view name (specified through the statusCodes property), or falls back to the defaultStatusCode if there is no match.

Override this in a custom subclass to customize this behavior.

Parameters

request:HttpServletRequest: current HTTP request
viewName:String: the name of the error view

Returns:Integer

the HTTP status code to use, or null for the servlet container's default (200 in case of a standard error view)

Annotations

@Nullable

determineViewName back to summary

determineViewName	back to summary
protected String determineViewName(Exception ex, 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. Parameters ex:Exception the exception that got thrown during handler execution request:HttpServletRequest current HTTP request (useful for obtaining metadata) Returns:String the resolved view name, or `null` if excluded or none found Annotations @Nullable

protected String determineViewName(Exception ex, 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.

Parameters

ex:Exception: the exception that got thrown during handler execution
request:HttpServletRequest: current HTTP request (useful for obtaining metadata)

Returns:String

the resolved view name, or null if excluded or none found

Annotations

@Nullable

doResolveException back to summary

doResolveException	back to summary
protected ModelAndView doResolveException(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) Implements abstract org.springframework.web.servlet.handler.AbstractHandlerExceptionResolver.doResolveException. Actually resolve the given exception that got thrown during on handler execution, returning a ModelAndView that represents a specific error page if appropriate. May be overridden in subclasses, in order to apply specific exception checks. Note that this template method will be invoked after checking whether this resolved applies ("mappedHandlers" etc), so an implementation may simply proceed with its actual exception handling. Parameters request:HttpServletRequest current HTTP request response:HttpServletResponse current HTTP response handler:Object the executed handler, or `null` if none chosen at the time of the exception (for example, if multipart resolution failed) ex:Exception the exception that got thrown during handler execution Returns:ModelAndView a corresponding `ModelAndView` to forward to, or `null` for default processing in the resolution chain Annotations @Override @Nullable

protected ModelAndView doResolveException(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)

Implements abstract org.springframework.web.servlet.handler.AbstractHandlerExceptionResolver.doResolveException.

Actually resolve the given exception that got thrown during on handler execution, returning a ModelAndView that represents a specific error page if appropriate.

May be overridden in subclasses, in order to apply specific exception checks. Note that this template method will be invoked after checking whether this resolved applies ("mappedHandlers" etc), so an implementation may simply proceed with its actual exception handling.

Parameters

request:HttpServletRequest: current HTTP request
response:HttpServletResponse: current HTTP response
handler:Object: the executed handler, or null if none chosen at the time of the exception (for example, if multipart resolution failed)
ex:Exception: the exception that got thrown during handler execution

Returns:ModelAndView

a corresponding ModelAndView to forward to, or null for default processing in the resolution chain

Annotations

@Override
@Nullable

findMatchingViewName back to summary

findMatchingViewName	back to summary
protected String findMatchingViewName(Properties exceptionMappings, Exception ex) Find a matching view name in the given exception mappings. Parameters exceptionMappings:Properties mappings between exception class names and error view names ex:Exception the exception that got thrown during handler execution Returns:String the view name, or `null` if none found Annotations @Nullable See Also `setExceptionMappings`

protected String findMatchingViewName(Properties exceptionMappings, Exception ex)

Find a matching view name in the given exception mappings.

Parameters

exceptionMappings:Properties: mappings between exception class names and error view names
ex:Exception: the exception that got thrown during handler execution

Returns:String

the view name, or null if none found

Annotations

@Nullable

See Also

setExceptionMappings

getDepth	back to summary
protected int getDepth(String exceptionMapping, Exception ex) Return the depth to the superclass matching. 0 means ex matches exactly. Returns -1 if there's no match. Otherwise, returns depth. Lowest depth wins.

getDepth

back to summary

protected int getDepth(String exceptionMapping, Exception ex)

Return the depth to the superclass matching.

0 means ex matches exactly. Returns -1 if there's no match. Otherwise, returns depth. Lowest depth wins.

getDepth	back to summary
private int getDepth(String exceptionMapping, Class<?> exceptionClass, int depth)

getModelAndView back to summary

getModelAndView	back to summary
protected ModelAndView getModelAndView(String viewName, Exception ex, HttpServletRequest request) Return a ModelAndView for the given request, view name and exception. The default implementation delegates to `getModelAndView(String, Exception)`. Parameters viewName:String the name of the error view ex:Exception the exception that got thrown during handler execution request:HttpServletRequest current HTTP request (useful for obtaining metadata) Returns:ModelAndView the ModelAndView instance

protected ModelAndView getModelAndView(String viewName, Exception ex, HttpServletRequest request)

Return a ModelAndView for the given request, view name and exception.

The default implementation delegates to getModelAndView(String, Exception).

Parameters

viewName:String: the name of the error view
ex:Exception: the exception that got thrown during handler execution
request:HttpServletRequest: current HTTP request (useful for obtaining metadata)

Returns:ModelAndView

the ModelAndView instance

getModelAndView back to summary

getModelAndView	back to summary
protected ModelAndView getModelAndView(String viewName, Exception ex) Return a ModelAndView for the given view name and exception. The default implementation adds the specified exception attribute. Can be overridden in subclasses. Parameters viewName:String the name of the error view ex:Exception the exception that got thrown during handler execution Returns:ModelAndView the ModelAndView instance See Also `setExceptionAttribute`

protected ModelAndView getModelAndView(String viewName, Exception ex)

Return a ModelAndView for the given view name and exception.

The default implementation adds the specified exception attribute. Can be overridden in subclasses.

Parameters

viewName:String: the name of the error view
ex:Exception: the exception that got thrown during handler execution

Returns:ModelAndView

the ModelAndView instance

See Also

setExceptionAttribute

getStatusCodesAsMap	back to summary
public Map<String, Integer> getStatusCodesAsMap() Returns the HTTP status codes provided via `setStatusCodes(Properties)`. Keys are view names; values are status codes.

setDefaultErrorView	back to summary
public void setDefaultErrorView(String defaultErrorView) Set the name of the default error view. This view will be returned if no specific mapping was found. Default is none.

setDefaultErrorView

back to summary

public void setDefaultErrorView(String defaultErrorView)

Set the name of the default error view. This view will be returned if no specific mapping was found.

Default is none.

setDefaultStatusCode back to summary

setDefaultStatusCode	back to summary
public 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. Note that this error code will only get applied in case of a top-level request. It will not be set for an include request, since the HTTP status cannot be modified from within an include. If not specified, no status code will be applied, either leaving this to the controller or view, or keeping the servlet engine's default of 200 (OK). Parameters defaultStatusCode:int the HTTP status code value, for example 500 (`HttpServletResponse#SC_INTERNAL_SERVER_ERROR`) or 404 (`HttpServletResponse#SC_NOT_FOUND`) See Also `setStatusCodes(Properties)`

public 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.

Note that this error code will only get applied in case of a top-level request. It will not be set for an include request, since the HTTP status cannot be modified from within an include.

If not specified, no status code will be applied, either leaving this to the controller or view, or keeping the servlet engine's default of 200 (OK).

Parameters

defaultStatusCode:int: the HTTP status code value, for example 500 (HttpServletResponse#SC_INTERNAL_SERVER_ERROR) or 404 (HttpServletResponse#SC_NOT_FOUND)

See Also

setStatusCodes(Properties)

setExceptionAttribute back to summary

setExceptionAttribute	back to summary
public void setExceptionAttribute(String exceptionAttribute) Set the name of the model attribute as which the exception should be exposed. Default is "exception". This can be either set to a different attribute name or to `null` for not exposing an exception attribute at all. See Also `DEFAULT_EXCEPTION_ATTRIBUTE`

public void setExceptionAttribute(String exceptionAttribute)

Set the name of the model attribute as which the exception should be exposed. Default is "exception".

This can be either set to a different attribute name or to null for not exposing an exception attribute at all.

See Also: DEFAULT_EXCEPTION_ATTRIBUTE

setExceptionMappings back to summary

setExceptionMappings	back to summary
public void setExceptionMappings(Properties mappings) Set the mappings between exception class names and error view names. The exception class name can be a substring, with no wildcard support at present. A value of "ServletException" would match `jakarta.servlet.ServletException` and subclasses, for example. Note Consider carefully how specific the pattern is, and whether to include package information (which isn't mandatory). For example, "Exception" will match nearly anything, and will probably hide other rules. "java.lang.Exception" would be correct if "Exception" was meant to define a rule for all checked exceptions. With more unusual exception names such as "BaseBusinessException" there's no need to use a FQN. Parameters mappings:Properties exception patterns (can also be fully qualified class names) as keys, and error view names as values

public void setExceptionMappings(Properties mappings)

Set the mappings between exception class names and error view names. The exception class name can be a substring, with no wildcard support at present. A value of "ServletException" would match jakarta.servlet.ServletException and subclasses, for example.

Note

Consider carefully how specific the pattern is, and whether to include package information (which isn't mandatory). For example, "Exception" will match nearly anything, and will probably hide other rules. "java.lang.Exception" would be correct if "Exception" was meant to define a rule for all checked exceptions. With more unusual exception names such as "BaseBusinessException" there's no need to use a FQN.

Parameters

mappings:Properties: exception patterns (can also be fully qualified class names) as keys, and error view names as values

setExcludedExceptions	back to summary
public void setExcludedExceptions(Class<?>... excludedExceptions) Set one or more exceptions to be excluded from the exception mappings. Excluded exceptions are checked first and if one of them equals the actual exception, the exception will remain unresolved. Parameters excludedExceptions:Class<?>[] one or more excluded exception types

setExcludedExceptions

back to summary

public void setExcludedExceptions(Class<?>... excludedExceptions)

Set one or more exceptions to be excluded from the exception mappings. Excluded exceptions are checked first and if one of them equals the actual exception, the exception will remain unresolved.

Parameters

excludedExceptions:Class<?>[]: one or more excluded exception types

setStatusCodes back to summary

setStatusCodes	back to summary
public void setStatusCodes(Properties statusCodes) Set the HTTP status code that this exception resolver will apply for a given resolved error view. Keys are view names; values are status codes. Note that this error code will only get applied in case of a top-level request. It will not be set for an include request, since the HTTP status cannot be modified from within an include. If not specified, the default status code will be applied. See Also `setDefaultStatusCode(int)`

public void setStatusCodes(Properties statusCodes)

Set the HTTP status code that this exception resolver will apply for a given resolved error view. Keys are view names; values are status codes.

Note that this error code will only get applied in case of a top-level request. It will not be set for an include request, since the HTTP status cannot be modified from within an include.

If not specified, the default status code will be applied.

See Also: setDefaultStatusCode(int)

public Class SimpleMappingExceptionResolver

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail