public abstract class AbstractHandlerExceptionResolver extends java.lang.Object implements HandlerExceptionResolver, Ordered
HandlerExceptionResolver
implementations.
Supports mapped handlers and
handler classes that the resolver
should be applied to and implements the Ordered
interface.
Modifier and Type | Field and Description |
---|---|
private static java.lang.String |
HEADER_CACHE_CONTROL |
protected Log |
logger
Logger available to subclasses
|
private java.lang.Class<?>[] |
mappedHandlerClasses |
private java.util.Set<?> |
mappedHandlers |
private int |
order |
private boolean |
preventResponseCaching |
private Log |
warnLogger |
HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE
Constructor and Description |
---|
AbstractHandlerExceptionResolver() |
Modifier and Type | Method and Description |
---|---|
protected java.lang.String |
buildLogMessage(java.lang.Exception ex,
HttpServletRequest request)
Build a log message for the given exception, occurred during processing the given request.
|
protected abstract ModelAndView |
doResolveException(HttpServletRequest request,
HttpServletResponse response,
java.lang.Object handler,
java.lang.Exception ex)
Actually resolve the given exception that got thrown during handler execution,
returning a
ModelAndView that represents a specific error page if appropriate. |
int |
getOrder()
Get the order value of this object.
|
protected void |
logException(java.lang.Exception ex,
HttpServletRequest request)
Log the given exception at warn level, provided that warn logging has been
activated through the
"warnLogCategory" property. |
protected void |
prepareResponse(java.lang.Exception ex,
HttpServletResponse response)
Prepare the response for the exceptional case.
|
protected void |
preventCaching(HttpServletResponse response)
Prevents the response from being cached, through setting corresponding
HTTP
Cache-Control: no-store header. |
ModelAndView |
resolveException(HttpServletRequest request,
HttpServletResponse response,
java.lang.Object handler,
java.lang.Exception ex)
Check whether this resolver is supposed to apply (i.e.
|
void |
setMappedHandlerClasses(java.lang.Class<?>... mappedHandlerClasses)
Specify the set of classes that this exception resolver should apply to.
|
void |
setMappedHandlers(java.util.Set<?> mappedHandlers)
Specify the set of handlers that this exception resolver should apply to.
|
void |
setOrder(int order) |
void |
setPreventResponseCaching(boolean preventResponseCaching)
Specify whether to prevent HTTP response caching for any view resolved
by this exception resolver.
|
void |
setWarnLogCategory(java.lang.String loggerName)
Set the log category for warn logging.
|
protected boolean |
shouldApplyTo(HttpServletRequest request,
java.lang.Object handler)
Check whether this resolver is supposed to apply to the given handler.
|
private static final java.lang.String HEADER_CACHE_CONTROL
protected final Log logger
private int order
private java.util.Set<?> mappedHandlers
private java.lang.Class<?>[] mappedHandlerClasses
private Log warnLogger
private boolean preventResponseCaching
public void setOrder(int order)
public int getOrder()
Ordered
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.
getOrder
in interface Ordered
Ordered.HIGHEST_PRECEDENCE
,
Ordered.LOWEST_PRECEDENCE
public void setMappedHandlers(java.util.Set<?> mappedHandlers)
The exception mappings and the default error view will only apply to the specified handlers.
If no handlers or handler classes are set, the exception mappings and the default error view will apply to all handlers. This means that a specified default error view will be used as a fallback for all exceptions; any further HandlerExceptionResolvers in the chain will be ignored in this case.
public void setMappedHandlerClasses(java.lang.Class<?>... mappedHandlerClasses)
The exception mappings and the default error view will only apply to handlers of the specified types; the specified types may be interfaces or superclasses of handlers as well.
If no handlers or handler classes are set, the exception mappings and the default error view will apply to all handlers. This means that a specified default error view will be used as a fallback for all exceptions; any further HandlerExceptionResolvers in the chain will be ignored in this case.
public void setWarnLogCategory(java.lang.String loggerName)
Default is no warn logging. Specify this setting to activate warn logging into a specific
category. Alternatively, override the logException(java.lang.Exception, HttpServletRequest)
method for custom logging.
org.apache.commons.logging.LogFactory#getLog(String)
,
org.apache.log4j.Logger#getLogger(String)
,
Logger.getLogger(String)
public void setPreventResponseCaching(boolean preventResponseCaching)
Default is false
. Switch this to true
in order to
automatically generate HTTP response headers that suppress response caching.
public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, java.lang.Object handler, java.lang.Exception ex)
doResolveException(HttpServletRequest, HttpServletResponse, java.lang.Object, java.lang.Exception)
template method.resolveException
in interface HandlerExceptionResolver
request
- current HTTP requestresponse
- current HTTP responsehandler
- 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 executionModelAndView
to forward to, or null
for default processingprotected boolean shouldApplyTo(HttpServletRequest request, java.lang.Object handler)
The default implementation checks against the configured handlers and handler classes, if any.
request
- current HTTP requesthandler
- the executed handler, or null
if none chosen
at the time of the exception (for example, if multipart resolution failed)setMappedHandlers(java.util.Set<?>)
,
setMappedHandlerClasses(java.lang.Class<?>...)
protected void logException(java.lang.Exception ex, HttpServletRequest request)
"warnLogCategory"
property.
Calls buildLogMessage(java.lang.Exception, HttpServletRequest)
in order to determine the concrete message to log.
ex
- the exception that got thrown during handler executionrequest
- current HTTP request (useful for obtaining metadata)setWarnLogCategory(java.lang.String)
,
buildLogMessage(java.lang.Exception, HttpServletRequest)
,
org.apache.commons.logging.Log#warn(Object, Throwable)
protected java.lang.String buildLogMessage(java.lang.Exception ex, HttpServletRequest request)
ex
- the exception that got thrown during handler executionrequest
- current HTTP request (useful for obtaining metadata)protected void prepareResponse(java.lang.Exception ex, HttpServletResponse response)
The default implementation prevents the response from being cached,
if the "preventResponseCaching"
property
has been set to "true".
ex
- the exception that got thrown during handler executionresponse
- current HTTP responsepreventCaching(HttpServletResponse)
protected void preventCaching(HttpServletResponse response)
Cache-Control: no-store
header.response
- current HTTP responseprotected abstract ModelAndView doResolveException(HttpServletRequest request, HttpServletResponse response, java.lang.Object handler, java.lang.Exception ex)
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.
request
- current HTTP requestresponse
- current HTTP responsehandler
- 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 executionModelAndView
to forward to, or null
for default processing