public abstract class AbstractHandlerExceptionResolver extends java.lang.Object implements HandlerExceptionResolver, Ordered
HandlerExceptionResolver
implementations.
Provides a set of mapped handlers that the resolver should map to,
and the Ordered
implementation.
Modifier and Type | Field and Description |
---|---|
protected Log |
logger
Logger available to subclasses
|
private java.lang.Class<?>[] |
mappedHandlerClasses |
private java.util.Set<?> |
mappedHandlers |
private int |
order |
private boolean |
renderWhenMinimized |
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,
PortletRequest request)
Build a log message for the given exception, occured during processing
the given request.
|
protected abstract 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.
|
int |
getOrder()
Return the order value of this object, with a
higher value meaning greater in terms of sorting.
|
protected void |
logException(java.lang.Exception ex,
PortletRequest request)
Log the given exception at warn level, provided that warn logging has been
activated through the
"warnLogCategory" property. |
ModelAndView |
resolveException(RenderRequest request,
RenderResponse response,
java.lang.Object handler,
java.lang.Exception ex)
Checks whether this resolver is supposed to apply (i.e.
|
ModelAndView |
resolveException(ResourceRequest request,
ResourceResponse response,
java.lang.Object handler,
java.lang.Exception ex)
Try to resolve the given exception that got thrown during on handler execution,
returning a ModelAndView that represents a specific error page if appropriate.
|
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 map.
|
void |
setOrder(int order) |
void |
setRenderWhenMinimized(boolean renderWhenMinimized)
Set if the resolver should render a view when the portlet is in
a minimized window.
|
void |
setWarnLogCategory(java.lang.String loggerName)
Set the log category for warn logging.
|
protected boolean |
shouldApplyTo(PortletRequest request,
java.lang.Object handler)
Check whether this resolver is supposed to apply to the given handler.
|
protected final Log logger
private int order
private java.util.Set<?> mappedHandlers
private java.lang.Class<?>[] mappedHandlerClasses
private Log warnLogger
private boolean renderWhenMinimized
public void setOrder(int order)
public int getOrder()
Ordered
Normally starting with 0, with Integer.MAX_VALUE
indicating the greatest value. Same order values will result
in arbitrary positions for the affected objects.
Higher values can be interpreted as lower priority. As a consequence, the object with the lowest value has highest priority (somewhat analogous to Servlet "load-on-startup" values).
public void setMappedHandlers(java.util.Set<?> mappedHandlers)
If no handlers set, both 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(java.lang.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(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, PortletRequest)
method for custom logging.
org.apache.commons.logging.LogFactory#getLog(String)
,
org.apache.log4j.Logger#getLogger(String)
,
Logger.getLogger(String)
public void setRenderWhenMinimized(boolean renderWhenMinimized)
javax.portlet.RenderRequest#getWindowState()
,
javax.portlet.WindowState#MINIMIZED
public ModelAndView resolveException(RenderRequest request, RenderResponse response, java.lang.Object handler, java.lang.Exception ex)
doResolveException(PortletRequest, MimeResponse, java.lang.Object, java.lang.Exception)
template method.resolveException
in interface HandlerExceptionResolver
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 executionnull
for default processingpublic ModelAndView resolveException(ResourceRequest request, ResourceResponse response, java.lang.Object handler, java.lang.Exception ex)
HandlerExceptionResolver
resolveException
in interface HandlerExceptionResolver
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 executionnull
for default processingprotected boolean shouldApplyTo(PortletRequest request, java.lang.Object handler)
The default implementation checks against the specified mapped handlers and handler classes, if any, and also checks the window state (according to the "renderWhenMinimize" property).
request
- current portlet 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, PortletRequest request)
"warnLogCategory"
property.
Calls buildLogMessage(java.lang.Exception, PortletRequest)
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 portlet request (useful for obtaining metadata)setWarnLogCategory(java.lang.String)
,
buildLogMessage(java.lang.Exception, PortletRequest)
,
org.apache.commons.logging.Log#warn(Object, Throwable)
protected java.lang.String buildLogMessage(java.lang.Exception ex, PortletRequest request)
ex
- the exception that got thrown during handler executionrequest
- current portlet request (useful for obtaining metadata)protected abstract ModelAndView doResolveException(PortletRequest request, MimeResponse response, java.lang.Object handler, java.lang.Exception ex)
Must 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 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 execution