|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.springframework.web.servlet.handler.SimpleMappingExceptionResolver
public class SimpleMappingExceptionResolver
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.
DispatcherServlet
Field Summary | |
---|---|
static String |
DEFAULT_EXCEPTION_ATTRIBUTE
The default name of the exception attribute: "exception". |
protected Log |
logger
Logger available to subclasses |
Fields inherited from interface org.springframework.core.Ordered |
---|
HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE |
Constructor Summary | |
---|---|
SimpleMappingExceptionResolver()
|
Method 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). |
protected String |
buildLogMessage(Exception ex,
HttpServletRequest request)
Build a log message for the given exception, occured during processing the given request. |
protected Integer |
determineStatusCode(HttpServletRequest request,
String viewName)
Determine the HTTP status code to apply for the given error view. |
protected String |
determineViewName(Exception ex,
HttpServletRequest request)
Determine the view name for the given exception, searching the "exceptionMappings" , using the
"defaultErrorView" as fallback. |
protected ModelAndView |
doResolveException(HttpServletRequest request,
HttpServletResponse response,
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 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,
HttpServletRequest request)
Return a ModelAndView for the given request, view name and exception. |
int |
getOrder()
Return the order value of this object, with a higher value meaning greater in terms of sorting. |
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. |
ModelAndView |
resolveException(HttpServletRequest request,
HttpServletResponse response,
Object handler,
Exception ex)
Checks whether this resolver is supposed to apply (i.e. the handler matches in case of "mappedHandlers" having been specified), then delegates to the doResolveException(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.lang.Object, java.lang.Exception) template method. |
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. |
void |
setExceptionAttribute(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 |
setMappedHandlerClasses(Class[] mappedHandlerClasses)
Specify the set of classes that this exception resolver should apply to. |
void |
setMappedHandlers(Set mappedHandlers)
Specify the set of handlers that this exception resolver should apply to. |
void |
setOrder(int order)
|
void |
setWarnLogCategory(String loggerName)
Set the log category for warn logging. |
protected boolean |
shouldApplyTo(HttpServletRequest request,
Object handler)
Check whether this resolver is supposed to apply to the given handler. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String DEFAULT_EXCEPTION_ATTRIBUTE
protected final Log logger
Constructor Detail |
---|
public SimpleMappingExceptionResolver()
Method Detail |
---|
public void setOrder(int order)
public int getOrder()
Ordered
Normally starting with 0 or 1, with Ordered.LOWEST_PRECEDENCE
indicating greatest. Same order values will result in arbitrary
positions for the affected objects.
Higher value can be interpreted as lower priority, consequently the first object has highest priority (somewhat analogous to Servlet "load-on-startup" values).
Note that order values below 0 are reserved for framework purposes. Application-specified values should always be 0 or greater, with only framework components (internal or third-party) supposed to use lower values.
Ordered.LOWEST_PRECEDENCE
public void setMappedHandlers(Set mappedHandlers)
If no handlers and 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 fallback for all exceptions; any further HandlerExceptionResolvers in the chain will be ignored in this case.
public void setMappedHandlerClasses(Class[] mappedHandlerClasses)
If no handlers and 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 fallback for all exceptions; any further HandlerExceptionResolvers in the chain will be ignored in this case.
public void setWarnLogCategory(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, javax.servlet.http.HttpServletRequest)
method for custom logging.
public void setExceptionMappings(Properties mappings)
javax.servlet.ServletException
and subclasses, for example.
NB: 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.
Follows the same matching algorithm as RuleBasedTransactionAttribute and RollbackRuleAttribute.
mappings
- exception patterns (can also be fully qualified class names)
as keys, and error view names as valuesRuleBasedTransactionAttribute
,
RollbackRuleAttribute
public void setDefaultErrorView(String defaultErrorView)
Default is none.
public void setDefaultStatusCode(int defaultStatusCode)
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).
defaultStatusCode
- HTTP status code value, for example
500 (SC_INTERNAL_SERVER_ERROR) or 404 (SC_NOT_FOUND)HttpServletResponse.SC_INTERNAL_SERVER_ERROR
,
HttpServletResponse.SC_NOT_FOUND
public void setExceptionAttribute(String exceptionAttribute)
This can be either set to a different attribute name or to
null
for not exposing an exception attribute at all.
DEFAULT_EXCEPTION_ATTRIBUTE
public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)
doResolveException(javax.servlet.http.HttpServletRequest, javax.servlet.http.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 execution
null
for default processingprotected boolean shouldApplyTo(HttpServletRequest request, Object handler)
The default implementation checks against the specified mapped 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 ModelAndView doResolveException(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)
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 execution
null
for default processingprotected void logException(Exception ex, HttpServletRequest request)
"warnLogCategory"
property.
Calls buildLogMessage(java.lang.Exception, javax.servlet.http.HttpServletRequest)
in order to determine the concrete message
to log. Always passes the full exception to the logger.
ex
- the exception that got thrown during handler executionrequest
- current HTTP request (useful for obtaining metadata)setWarnLogCategory(java.lang.String)
,
buildLogMessage(java.lang.Exception, javax.servlet.http.HttpServletRequest)
,
Log.warn(Object, Throwable)
protected String buildLogMessage(Exception ex, HttpServletRequest request)
ex
- the exception that got thrown during handler executionrequest
- current HTTP request (useful for obtaining metadata)
protected String determineViewName(Exception ex, HttpServletRequest request)
"exceptionMappings"
, using the
"defaultErrorView"
as fallback.
ex
- the exception that got thrown during handler executionrequest
- current HTTP request (useful for obtaining metadata)
null
if none foundprotected String findMatchingViewName(Properties exceptionMappings, Exception ex)
exceptionMappings
- mappings between exception class names and error view namesex
- the exception that got thrown during handler execution
null
if none foundsetExceptionMappings(java.util.Properties)
protected int getDepth(String exceptionMapping, Exception ex)
0 means ex matches exactly. Returns -1 if there's no match. Otherwise, returns depth. Lowest depth wins.
Follows the same algorithm as
RollbackRuleAttribute
.
protected Integer determineStatusCode(HttpServletRequest request, String viewName)
The default implementation always returns the specified
"defaultStatusCode"
, as a common
status code for all error views. Override this in a custom subclass
to determine a specific status code for the given view.
request
- current HTTP requestviewName
- the name of the error view
null
for the
servlet container's default (200 in case of a standard error view)setDefaultStatusCode(int)
,
applyStatusCodeIfPossible(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, int)
protected void applyStatusCodeIfPossible(HttpServletRequest request, HttpServletResponse response, int statusCode)
request
- current HTTP requestresponse
- current HTTP responsestatusCode
- the status code to applydetermineStatusCode(javax.servlet.http.HttpServletRequest, java.lang.String)
,
setDefaultStatusCode(int)
,
HttpServletResponse.setStatus(int)
protected ModelAndView getModelAndView(String viewName, Exception ex, HttpServletRequest request)
The default implementation delegates to getModelAndView(String, Exception)
.
viewName
- the name of the error viewex
- the exception that got thrown during handler executionrequest
- current HTTP request (useful for obtaining metadata)
protected ModelAndView getModelAndView(String viewName, Exception ex)
The default implementation adds the specified exception attribute. Can be overridden in subclasses.
viewName
- the name of the error viewex
- the exception that got thrown during handler execution
setExceptionAttribute(java.lang.String)
|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |