Class AbstractHandlerExceptionResolver
- java.lang.Object
- org.springframework.web.portlet.handler.AbstractHandlerExceptionResolver
- All Implemented Interfaces:
Ordered
,HandlerExceptionResolver
- Direct Known Subclasses:
AnnotationMethodHandlerExceptionResolver
,SimpleMappingExceptionResolver
public abstract class AbstractHandlerExceptionResolver extends Object implements HandlerExceptionResolver, Ordered
Abstract base class forHandlerExceptionResolver
implementations.Provides a set of mapped handlers that the resolver should map to, and the
Ordered
implementation.- Since:
- 3.0
- Author:
- Arjen Poutsma, Juergen Hoeller
Field Summary
Fields inherited from interface org.springframework.core.Ordered
HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE
Constructor Summary
Constructors Constructor Description AbstractHandlerExceptionResolver()
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected String
buildLogMessage(Exception ex, PortletRequest request)
Build a log message for the given exception, occurred during processing the given request.protected abstract ModelAndView
doResolveException(PortletRequest request, MimeResponse 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.int
getOrder()
Get the order value of this object.protected void
logException(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, Object handler, Exception ex)
Checks whether this resolver is supposed to apply (i.e.ModelAndView
resolveException(ResourceRequest request, ResourceResponse response, Object handler, 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(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
setRenderWhenMinimized(boolean renderWhenMinimized)
Set if the resolver should render a view when the portlet is in a minimized window.void
setWarnLogCategory(String loggerName)
Set the log category for warn logging.protected boolean
shouldApplyTo(PortletRequest request, Object handler)
Check whether this resolver is supposed to apply to the given handler.
Constructor Detail
AbstractHandlerExceptionResolver
public AbstractHandlerExceptionResolver()
Method Detail
setOrder
public void setOrder(int order)
getOrder
public int getOrder()
Description copied from interface:Ordered
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.
- Specified by:
getOrder
in interfaceOrdered
- Returns:
- the order value
- See Also:
Ordered.HIGHEST_PRECEDENCE
,Ordered.LOWEST_PRECEDENCE
setMappedHandlers
public void setMappedHandlers(Set<?> mappedHandlers)
Specify the set of handlers that this exception resolver should apply to.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.
setMappedHandlerClasses
public void setMappedHandlerClasses(Class<?>... mappedHandlerClasses)
Specify the set of classes that this exception resolver should apply to.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.
setWarnLogCategory
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.Default is no warn logging. Specify this setting to activate warn logging into a specific category. Alternatively, override the
logException(java.lang.Exception, javax.portlet.PortletRequest)
method for custom logging.
setRenderWhenMinimized
public void setRenderWhenMinimized(boolean renderWhenMinimized)
Set if the resolver should render a view when the portlet is in a minimized window. The default is "false".
resolveException
public ModelAndView resolveException(RenderRequest request, RenderResponse 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 thedoResolveException(javax.portlet.PortletRequest, javax.portlet.MimeResponse, java.lang.Object, java.lang.Exception)
template method.- Specified by:
resolveException
in interfaceHandlerExceptionResolver
- Parameters:
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- Returns:
- a corresponding ModelAndView to forward to, or
null
for default processing
resolveException
public ModelAndView resolveException(ResourceRequest request, ResourceResponse response, Object handler, Exception ex)
Description copied from interface:HandlerExceptionResolver
Try to resolve the given exception that got thrown during on handler execution, returning a ModelAndView that represents a specific error page if appropriate.- Specified by:
resolveException
in interfaceHandlerExceptionResolver
- Parameters:
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- Returns:
- a corresponding ModelAndView to forward to, or
null
for default processing
shouldApplyTo
protected boolean shouldApplyTo(PortletRequest request, Object handler)
Check whether this resolver is supposed to apply to the given 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).
- Parameters:
request
- current portlet requesthandler
- the executed handler, ornull
if none chosen at the time of the exception (for example, if multipart resolution failed)- Returns:
- whether this resolved should proceed with resolving the exception for the given request and handler
- See Also:
setMappedHandlers(java.util.Set<?>)
,setMappedHandlerClasses(java.lang.Class<?>...)
logException
protected void logException(Exception ex, PortletRequest request)
Log the given exception at warn level, provided that warn logging has been activated through the"warnLogCategory"
property.Calls
buildLogMessage(java.lang.Exception, javax.portlet.PortletRequest)
in order to determine the concrete message to log.- Parameters:
ex
- the exception that got thrown during handler executionrequest
- current portlet request (useful for obtaining metadata)- See Also:
setWarnLogCategory(java.lang.String)
,buildLogMessage(java.lang.Exception, javax.portlet.PortletRequest)
,Log.warn(Object, Throwable)
buildLogMessage
protected String buildLogMessage(Exception ex, PortletRequest request)
Build a log message for the given exception, occurred during processing the given request.- Parameters:
ex
- the exception that got thrown during handler executionrequest
- current portlet request (useful for obtaining metadata)- Returns:
- the log message to use
doResolveException
protected abstract ModelAndView doResolveException(PortletRequest request, MimeResponse 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.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.
- Parameters:
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- Returns:
- a corresponding ModelAndView to forward to, or null for default processing