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

Modifier and Type	Field and Description
private static final String	HEADER_CACHE_CONTROL
protected final Log	logger Logger available to subclasses.
private Class<?>[]	mappedHandlerClasses
private Predicate<Object>	mappedHandlerPredicate
private Set<?>	mappedHandlers
private int	order
private boolean	preventResponseCaching
private Log	warnLogger

Access	Constructor and Description
public	AbstractHandlerExceptionResolver()

Method Summary

Modifier and Type	Method and Description
public void	addMappedHandlerClass(Class<?> mappedHandlerClass) Alternative to `setMappedHandlerClasses(Class[])`.
protected String	Returns: the log message to use buildLogMessage(Exception the exception that got thrown during handler execution ex, HttpServletRequest current HTTP request (useful for obtaining metadata) request) Build a log message for the given exception, occurred during processing the given request.
protected abstract 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) Actually resolve the given exception that got thrown during handler execution, returning a `ModelAndView` that represents a specific error page if appropriate.
protected Class<?>[]	getMappedHandlerClasses() Return the `configured` mapped handler classes.
public int	getOrder() Implements org.springframework.core.Ordered.getOrder. Get the order value of this object.
protected boolean	hasHandlerMappings() Whether there are any handler mappings registered via `setMappedHandlers(Set)`, `setMappedHandlerClasses(Class[])`, or `setMappedHandlerPredicate(Predicate)`.
protected void	logException(Exception the exception that got thrown during handler execution ex, HttpServletRequest current HTTP request (useful for obtaining metadata) request) Log the given exception at warn level, provided that warn logging has been activated through the `"warnLogCategory"` property.
protected void	prepareResponse(Exception the exception that got thrown during handler execution ex, HttpServletResponse current HTTP response response) Prepare the response for the exceptional case.
protected void	preventCaching(HttpServletResponse current HTTP response response) Prevents the response from being cached, through setting corresponding HTTP `Cache-Control: no-store` header.
public ModelAndView	resolveException(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 org.springframework.web.servlet.HandlerExceptionResolver.resolveException. Check whether this resolver is supposed to apply (i.e. if the supplied handler matches any of the configured handlers or handler classes), and then delegate to the `doResolveException` template method.
public void	setMappedHandlerClasses(Class<?>... mappedHandlerClasses) Specify the set of classes that this exception resolver should apply to.
public void	setMappedHandlerPredicate(Predicate<Object> predicate) Use a `Predicate` to determine which handlers this exception resolver applies to, including when the request was not mapped in which case the handler is `null`.
public void	setMappedHandlers(Set<?> mappedHandlers) Specify the set of handlers that this exception resolver should apply to.
public void	setOrder(int order)
public void	setPreventResponseCaching(boolean preventResponseCaching) Specify whether to prevent HTTP response caching for any view resolved by this exception resolver.
public void	setWarnLogCategory(String loggerName) Set the log category for warn logging.
protected boolean	Returns: whether this resolved should proceed with resolving the exception for the given request and handler shouldApplyTo(HttpServletRequest current HTTP request request, Object the executed handler, or `null` if none chosen at the time of the exception (for example, if multipart resolution failed) handler) Check whether this resolver is supposed to apply to the given handler.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

HEADER_CACHE_CONTROL	back to summary
private static final String HEADER_CACHE_CONTROL

logger	back to summary
protected final Log logger Logger available to subclasses.

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

mappedHandlerPredicate	back to summary
private Predicate<Object> mappedHandlerPredicate Annotations @Nullable

mappedHandlers	back to summary
private Set<?> mappedHandlers Annotations @Nullable

order	back to summary
private int order

preventResponseCaching	back to summary
private boolean preventResponseCaching

warnLogger	back to summary
private Log warnLogger Annotations @Nullable

AbstractHandlerExceptionResolver	back to summary
public AbstractHandlerExceptionResolver()

Method Detail

addMappedHandlerClass back to summary

addMappedHandlerClass	back to summary
public void addMappedHandlerClass(Class<?> mappedHandlerClass) Alternative to `setMappedHandlerClasses(Class[])`. Since 6.1

public void addMappedHandlerClass(Class<?> mappedHandlerClass)

Alternative to setMappedHandlerClasses(Class[]).

Since: 6.1

buildLogMessage	back to summary
protected String buildLogMessage(Exception ex, HttpServletRequest request) Build a log message for the given exception, occurred during processing the given request. Parameters ex:Exception the exception that got thrown during handler execution request:HttpServletRequest current HTTP request (useful for obtaining metadata) Returns:String the log message to use

buildLogMessage

back to summary

protected String buildLogMessage(Exception ex, HttpServletRequest request)

Build a log message for the given exception, occurred during processing the given request.

Parameters

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

Returns:String

the log message to use

doResolveException back to summary

doResolveException	back to summary
protected abstract ModelAndView doResolveException(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) Actually resolve the given exception that got thrown during 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 resolver 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 @Nullable

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

Actually resolve the given exception that got thrown during 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 resolver 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

@Nullable

getMappedHandlerClasses back to summary

getMappedHandlerClasses	back to summary
protected Class<?>[] getMappedHandlerClasses() Return the `configured` mapped handler classes. Annotations @Nullable

protected Class<?>[] getMappedHandlerClasses()

Return the configured mapped handler classes.

Annotations

@Nullable

getOrder back to summary

getOrder	back to summary
public int getOrder() Implements org.springframework.core.Ordered.getOrder. Doc from org.springframework.core.Ordered.getOrder. Get the order value of this object. Higher values are interpreted as lower priority. As a consequence, the object with the lowest value has the highest priority (somewhat analogous to Servlet `load-on-startup` values). Same order values will result in arbitrary sort positions for the affected objects. Returns:int the order value Annotations @Override

public int getOrder()

Implements org.springframework.core.Ordered.getOrder.

Doc from org.springframework.core.Ordered.getOrder.

Get the order value of this object.

Higher values are interpreted as lower priority. As a consequence, the object with the lowest value has the highest priority (somewhat analogous to Servlet load-on-startup values).

Same order values will result in arbitrary sort positions for the affected objects.

Returns:int

the order value

Annotations

@Override

hasHandlerMappings back to summary

hasHandlerMappings	back to summary
protected boolean hasHandlerMappings() Whether there are any handler mappings registered via `setMappedHandlers(Set)`, `setMappedHandlerClasses(Class[])`, or `setMappedHandlerPredicate(Predicate)`. Since 5.3

protected boolean hasHandlerMappings()

Whether there are any handler mappings registered via setMappedHandlers(Set), setMappedHandlerClasses(Class[]), or setMappedHandlerPredicate(Predicate).

Since: 5.3

logException back to summary

logException	back to summary
protected void logException(Exception ex, HttpServletRequest request) Log the given exception at warn level, provided that warn logging has been activated through the `"warnLogCategory"` property. Calls `buildLogMessage` in order to determine the concrete message to log. Parameters ex:Exception the exception that got thrown during handler execution request:HttpServletRequest current HTTP request (useful for obtaining metadata) See Also `setWarnLogCategory`, `buildLogMessage`, `org.apache.commons.logging.Log#warn(Object, Throwable)`

protected void logException(Exception ex, HttpServletRequest request)

Log the given exception at warn level, provided that warn logging has been activated through the "warnLogCategory" property.

Calls buildLogMessage in order to determine the concrete message to log.

Parameters

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

prepareResponse back to summary

prepareResponse	back to summary
protected void prepareResponse(Exception ex, HttpServletResponse response) Prepare the response for the exceptional case. The default implementation prevents the response from being cached, if the `"preventResponseCaching"` property has been set to "true". Parameters ex:Exception the exception that got thrown during handler execution response:HttpServletResponse current HTTP response See Also `preventCaching`

protected void prepareResponse(Exception ex, HttpServletResponse response)

Prepare the response for the exceptional case.

The default implementation prevents the response from being cached, if the "preventResponseCaching" property has been set to "true".

Parameters

ex:Exception: the exception that got thrown during handler execution
response:HttpServletResponse: current HTTP response

See Also

preventCaching

preventCaching back to summary

preventCaching	back to summary
protected void preventCaching(HttpServletResponse response) Prevents the response from being cached, through setting corresponding HTTP `Cache-Control: no-store` header. Parameters response:HttpServletResponse current HTTP response

protected void preventCaching(HttpServletResponse response)

Prevents the response from being cached, through setting corresponding HTTP Cache-Control: no-store header.

Parameters

response:HttpServletResponse: current HTTP response

resolveException back to summary

resolveException	back to summary
public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) Implements org.springframework.web.servlet.HandlerExceptionResolver.resolveException. Check whether this resolver is supposed to apply (i.e. if the supplied handler matches any of the configured handlers or handler classes), and then delegate to the `doResolveException` template method. Parameters request:HttpServletRequest Doc from org.springframework.web.servlet.HandlerExceptionResolver.resolveException. current HTTP request response:HttpServletResponse Doc from org.springframework.web.servlet.HandlerExceptionResolver.resolveException. current HTTP response handler:Object Doc from org.springframework.web.servlet.HandlerExceptionResolver.resolveException. the executed handler, or `null` if none chosen at the time of the exception (for example, if multipart resolution failed) ex:Exception Doc from org.springframework.web.servlet.HandlerExceptionResolver.resolveException. the exception that got thrown during handler execution Returns:ModelAndView Doc from org.springframework.web.servlet.HandlerExceptionResolver.resolveException. a corresponding `ModelAndView` to forward to, or `null` for default processing in the resolution chain Annotations @Override @Nullable

public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)

Implements org.springframework.web.servlet.HandlerExceptionResolver.resolveException.

Check whether this resolver is supposed to apply (i.e. if the supplied handler matches any of the configured handlers or handler classes), and then delegate to the doResolveException template method.

Parameters

request:HttpServletRequest

Doc from org.springframework.web.servlet.HandlerExceptionResolver.resolveException.

current HTTP request

response:HttpServletResponse

Doc from org.springframework.web.servlet.HandlerExceptionResolver.resolveException.

current HTTP response

handler:Object

Doc from org.springframework.web.servlet.HandlerExceptionResolver.resolveException.

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

ex:Exception

Doc from org.springframework.web.servlet.HandlerExceptionResolver.resolveException.

the exception that got thrown during handler execution

Returns:ModelAndView

Doc from org.springframework.web.servlet.HandlerExceptionResolver.resolveException.

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

Annotations

@Override
@Nullable

setMappedHandlerClasses back to summary

setMappedHandlerClasses	back to summary
public void setMappedHandlerClasses(Class<?>... mappedHandlerClasses) Specify the set of classes that this exception resolver should apply to. The resolver will only apply to handlers of the specified types; the specified types may be interfaces or superclasses of handlers as well. If no handler predicate, nor handlers, nor handler classes are set, the exception resolver applies to all handlers. See Also `setMappedHandlerPredicate(Predicate)`

public void setMappedHandlerClasses(Class<?>... mappedHandlerClasses)

Specify the set of classes that this exception resolver should apply to. The resolver will only apply to handlers of the specified types; the specified types may be interfaces or superclasses of handlers as well.

If no handler predicate, nor handlers, nor handler classes are set, the exception resolver applies to all handlers.

See Also: setMappedHandlerPredicate(Predicate)

setMappedHandlerPredicate back to summary

setMappedHandlerPredicate	back to summary
public void setMappedHandlerPredicate(Predicate<Object> predicate) Use a `Predicate` to determine which handlers this exception resolver applies to, including when the request was not mapped in which case the handler is `null`. If no handler predicate, nor handlers, nor handler classes are set, the exception resolver applies to all handlers. Since 6.1.2

public void setMappedHandlerPredicate(Predicate<Object> predicate)

Use a Predicate to determine which handlers this exception resolver applies to, including when the request was not mapped in which case the handler is null.

If no handler predicate, nor handlers, nor handler classes are set, the exception resolver applies to all handlers.

Since: 6.1.2

setMappedHandlers back to summary

setMappedHandlers	back to summary
public void setMappedHandlers(Set<?> mappedHandlers) Specify the set of handlers that this exception resolver should apply to. If no handler predicate, nor handlers, nor handler classes are set, the exception resolver applies to all handlers. See Also `setMappedHandlerPredicate(Predicate)`

public void setMappedHandlers(Set<?> mappedHandlers)

Specify the set of handlers that this exception resolver should apply to.

If no handler predicate, nor handlers, nor handler classes are set, the exception resolver applies to all handlers.

See Also: setMappedHandlerPredicate(Predicate)

setOrder	back to summary
public void setOrder(int order)

setPreventResponseCaching back to summary

setPreventResponseCaching	back to summary
public void setPreventResponseCaching(boolean preventResponseCaching) Specify whether to prevent HTTP response caching for any view resolved by this exception resolver. Default is `false`. Switch this to `true` in order to automatically generate HTTP response headers that suppress response caching.

public void setPreventResponseCaching(boolean preventResponseCaching)

Specify whether to prevent HTTP response caching for any view resolved by this exception resolver.

Default is false. Switch this to true in order to automatically generate HTTP response headers that suppress response caching.

setWarnLogCategory back to summary

setWarnLogCategory	back to summary
public void setWarnLogCategory(String loggerName) Set the log category for warn logging. The name will be passed to the underlying logger implementation through Commons Logging, getting interpreted as a log category according to the logger's configuration. If `null` or empty String is passed, warn logging is turned off. By default there is no warn logging although subclasses like `org.springframework.web.servlet.mvc.support.DefaultHandlerExceptionResolver` can change that default. Specify this setting to activate warn logging into a specific category. Alternatively, override the `logException` method for custom logging. See Also `org.apache.commons.logging.LogFactory#getLog(String)`, `java.util.logging.Logger#getLogger(String)`

public void setWarnLogCategory(String loggerName)

Set the log category for warn logging. The name will be passed to the underlying logger implementation through Commons Logging, getting interpreted as a log category according to the logger's configuration. If null or empty String is passed, warn logging is turned off.

By default there is no warn logging although subclasses like org.springframework.web.servlet.mvc.support.DefaultHandlerExceptionResolver can change that default. Specify this setting to activate warn logging into a specific category. Alternatively, override the logException method for custom logging.

See Also: org.apache.commons.logging.LogFactory#getLog(String), java.util.logging.Logger#getLogger(String)

shouldApplyTo back to summary

shouldApplyTo	back to summary
protected boolean shouldApplyTo(HttpServletRequest request, Object handler) Check whether this resolver is supposed to apply to the given handler. The default implementation checks against the configured handlerPredicate handlers and handler classes, if any. Parameters request:HttpServletRequest current HTTP request handler:Object the executed handler, or `null` if none chosen at the time of the exception (for example, if multipart resolution failed) Returns:boolean whether this resolved should proceed with resolving the exception for the given request and handler See Also `setMappedHandlers`, `setMappedHandlerClasses`

protected boolean shouldApplyTo(HttpServletRequest request, Object handler)

Check whether this resolver is supposed to apply to the given handler.

The default implementation checks against the configured handlerPredicate handlers and handler classes, if any.

Parameters

request:HttpServletRequest: current HTTP request
handler:Object: the executed handler, or null if none chosen at the time of the exception (for example, if multipart resolution failed)

Returns:boolean

whether this resolved should proceed with resolving the exception for the given request and handler

public abstract Class AbstractHandlerExceptionResolver

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail