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 DispatcherPortlet.
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.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
DEFAULT_EXCEPTION_ATTRIBUTE
The default name of the exception attribute: "exception".
|
private java.lang.String |
defaultErrorView |
private java.lang.String |
exceptionAttribute |
private java.util.Properties |
exceptionMappings |
logger
HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE
Constructor and Description |
---|
SimpleMappingExceptionResolver() |
Modifier and Type | Method and Description |
---|---|
protected java.lang.String |
determineViewName(java.lang.Exception ex,
PortletRequest request)
Determine the view name for the given exception, searching the
"exceptionMappings" , using the
"defaultErrorView" as fallback. |
protected ModelAndView |
doResolveException(PortletRequest request,
MimeResponse response,
java.lang.Object handler,
java.lang.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 java.lang.String |
findMatchingViewName(java.util.Properties exceptionMappings,
java.lang.Exception ex)
Find a matching view name in the given exception mappings
|
private int |
getDepth(java.lang.String exceptionMapping,
java.lang.Class<?> exceptionClass,
int depth) |
protected int |
getDepth(java.lang.String exceptionMapping,
java.lang.Exception ex)
Return the depth to the superclass matching.
|
protected ModelAndView |
getModelAndView(java.lang.String viewName,
java.lang.Exception ex)
Return a ModelAndView for the given view name and exception.
|
protected ModelAndView |
getModelAndView(java.lang.String viewName,
java.lang.Exception ex,
PortletRequest request)
Return a ModelAndView for the given request, view name and exception.
|
void |
setDefaultErrorView(java.lang.String defaultErrorView)
Set the name of the default error view.
|
void |
setExceptionAttribute(java.lang.String exceptionAttribute)
Set the name of the model attribute as which the exception should
be exposed.
|
void |
setExceptionMappings(java.util.Properties mappings)
Set the mappings between exception class names and error view names.
|
buildLogMessage, getOrder, logException, resolveException, resolveException, setMappedHandlerClasses, setMappedHandlers, setOrder, setRenderWhenMinimized, setWarnLogCategory, shouldApplyTo
public static final java.lang.String DEFAULT_EXCEPTION_ATTRIBUTE
private java.util.Properties exceptionMappings
private java.lang.String defaultErrorView
private java.lang.String exceptionAttribute
public void setExceptionMappings(java.util.Properties mappings)
javax.portet.PortletException
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(java.lang.String defaultErrorView)
Default is none.
public void setExceptionAttribute(java.lang.String exceptionAttribute)
DEFAULT_EXCEPTION_ATTRIBUTE
protected ModelAndView doResolveException(PortletRequest request, MimeResponse response, java.lang.Object handler, java.lang.Exception ex)
doResolveException
in class AbstractHandlerExceptionResolver
request
- current portlet requestresponse
- current portlet 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 executionprotected java.lang.String determineViewName(java.lang.Exception ex, PortletRequest request)
"exceptionMappings"
, using the
"defaultErrorView"
as fallback.ex
- the exception that got thrown during handler executionrequest
- current portlet request (useful for obtaining metadata)null
if none foundprotected java.lang.String findMatchingViewName(java.util.Properties exceptionMappings, java.lang.Exception ex)
exceptionMappings
- mappings between exception class names and error view namesex
- the exception that got thrown during handler executionnull
if none foundsetExceptionMappings(java.util.Properties)
protected int getDepth(java.lang.String exceptionMapping, java.lang.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
.
private int getDepth(java.lang.String exceptionMapping, java.lang.Class<?> exceptionClass, int depth)
protected ModelAndView getModelAndView(java.lang.String viewName, java.lang.Exception ex, PortletRequest request)
getModelAndView(viewName, ex)
.viewName
- the name of the error viewex
- the exception that got thrown during handler executionrequest
- current portlet request (useful for obtaining metadata)getModelAndView(String, Exception)
protected ModelAndView getModelAndView(java.lang.String viewName, java.lang.Exception ex)
viewName
- the name of the error viewex
- the exception that got thrown during handler executionsetExceptionAttribute(java.lang.String)