Class ExceptionHandlerExceptionResolver
- java.lang.Object
- org.springframework.web.servlet.handler.AbstractHandlerExceptionResolver
- org.springframework.web.servlet.handler.AbstractHandlerMethodExceptionResolver
- org.springframework.web.servlet.mvc.method.annotation.ExceptionHandlerExceptionResolver
- All Implemented Interfaces:
Aware
,InitializingBean
,ApplicationContextAware
,Ordered
,HandlerExceptionResolver
public class ExceptionHandlerExceptionResolver extends AbstractHandlerMethodExceptionResolver implements ApplicationContextAware, InitializingBean
AnAbstractHandlerMethodExceptionResolver
that resolves exceptions through@ExceptionHandler
methods.Support for custom argument and return value types can be added via
setCustomArgumentResolvers(java.util.List<org.springframework.web.method.support.HandlerMethodArgumentResolver>)
andsetCustomReturnValueHandlers(java.util.List<org.springframework.web.method.support.HandlerMethodReturnValueHandler>)
. Or alternatively to re-configure all argument and return value types usesetArgumentResolvers(java.util.List<org.springframework.web.method.support.HandlerMethodArgumentResolver>)
andsetReturnValueHandlers(List)
.- Since:
- 3.1
- Author:
- Rossen Stoyanchev, Juergen Hoeller
Field Summary
Fields inherited from class org.springframework.web.servlet.handler.AbstractHandlerExceptionResolver
logger
Fields inherited from interface org.springframework.core.Ordered
HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE
Constructor Summary
Constructors Constructor Description ExceptionHandlerExceptionResolver()
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
afterPropertiesSet()
Invoked by the containingBeanFactory
after it has set all bean properties and satisfiedBeanFactoryAware
,ApplicationContextAware
etc.protected ModelAndView
doResolveHandlerMethodException(HttpServletRequest request, HttpServletResponse response, HandlerMethod handlerMethod, Exception exception)
Find an@ExceptionHandler
method and invoke it to handle the raised exception.ApplicationContext
getApplicationContext()
HandlerMethodArgumentResolverComposite
getArgumentResolvers()
Return the configured argument resolvers, or possiblynull
if not initialized yet viaafterPropertiesSet()
.ContentNegotiationManager
getContentNegotiationManager()
Return the configuredContentNegotiationManager
.List<HandlerMethodArgumentResolver>
getCustomArgumentResolvers()
Return the custom argument resolvers, ornull
.List<HandlerMethodReturnValueHandler>
getCustomReturnValueHandlers()
Return the custom return value handlers, ornull
.protected List<HandlerMethodArgumentResolver>
getDefaultArgumentResolvers()
Return the list of argument resolvers to use including built-in resolvers and custom resolvers provided viasetCustomArgumentResolvers(java.util.List<org.springframework.web.method.support.HandlerMethodArgumentResolver>)
.protected List<HandlerMethodReturnValueHandler>
getDefaultReturnValueHandlers()
Return the list of return value handlers to use including built-in and custom handlers provided viasetReturnValueHandlers(java.util.List<org.springframework.web.method.support.HandlerMethodReturnValueHandler>)
.Map<ControllerAdviceBean,ExceptionHandlerMethodResolver>
getExceptionHandlerAdviceCache()
Return an unmodifiable Map with the@ControllerAdvice
beans discovered in the ApplicationContext.protected ServletInvocableHandlerMethod
getExceptionHandlerMethod(HandlerMethod handlerMethod, Exception exception)
Find an@ExceptionHandler
method for the given exception.List<HttpMessageConverter<?>>
getMessageConverters()
Return the configured message body converters.HandlerMethodReturnValueHandlerComposite
getReturnValueHandlers()
Return the configured handlers, or possiblynull
if not initialized yet viaafterPropertiesSet()
.void
setApplicationContext(ApplicationContext applicationContext)
Set the ApplicationContext that this object runs in.void
setArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers)
Configure the complete list of supported argument types thus overriding the resolvers that would otherwise be configured by default.void
setContentNegotiationManager(ContentNegotiationManager contentNegotiationManager)
Set theContentNegotiationManager
to use to determine requested media types.void
setCustomArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers)
Provide resolvers for custom argument types.void
setCustomReturnValueHandlers(List<HandlerMethodReturnValueHandler> returnValueHandlers)
Provide handlers for custom return value types.void
setMessageConverters(List<HttpMessageConverter<?>> messageConverters)
Set the message body converters to use.void
setResponseBodyAdvice(List<ResponseBodyAdvice<?>> responseBodyAdvice)
Add one or more components to be invoked after the execution of a controller method annotated with@ResponseBody
or returningResponseEntity
but before the body is written to the response with the selectedHttpMessageConverter
.void
setReturnValueHandlers(List<HandlerMethodReturnValueHandler> returnValueHandlers)
Configure the complete list of supported return value types thus overriding handlers that would otherwise be configured by default.Methods inherited from class org.springframework.web.servlet.handler.AbstractHandlerMethodExceptionResolver
doResolveException, shouldApplyTo
Methods inherited from class org.springframework.web.servlet.handler.AbstractHandlerExceptionResolver
buildLogMessage, getOrder, logException, prepareResponse, preventCaching, resolveException, setMappedHandlerClasses, setMappedHandlers, setOrder, setPreventResponseCaching, setWarnLogCategory
Constructor Detail
ExceptionHandlerExceptionResolver
public ExceptionHandlerExceptionResolver()
Method Detail
setCustomArgumentResolvers
public void setCustomArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers)
Provide resolvers for custom argument types. Custom resolvers are ordered after built-in ones. To override the built-in support for argument resolution usesetArgumentResolvers(java.util.List<org.springframework.web.method.support.HandlerMethodArgumentResolver>)
instead.
getCustomArgumentResolvers
public List<HandlerMethodArgumentResolver> getCustomArgumentResolvers()
Return the custom argument resolvers, ornull
.
setArgumentResolvers
public void setArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers)
Configure the complete list of supported argument types thus overriding the resolvers that would otherwise be configured by default.
getArgumentResolvers
public HandlerMethodArgumentResolverComposite getArgumentResolvers()
Return the configured argument resolvers, or possiblynull
if not initialized yet viaafterPropertiesSet()
.
setCustomReturnValueHandlers
public void setCustomReturnValueHandlers(List<HandlerMethodReturnValueHandler> returnValueHandlers)
Provide handlers for custom return value types. Custom handlers are ordered after built-in ones. To override the built-in support for return value handling usesetReturnValueHandlers(java.util.List<org.springframework.web.method.support.HandlerMethodReturnValueHandler>)
.
getCustomReturnValueHandlers
public List<HandlerMethodReturnValueHandler> getCustomReturnValueHandlers()
Return the custom return value handlers, ornull
.
setReturnValueHandlers
public void setReturnValueHandlers(List<HandlerMethodReturnValueHandler> returnValueHandlers)
Configure the complete list of supported return value types thus overriding handlers that would otherwise be configured by default.
getReturnValueHandlers
public HandlerMethodReturnValueHandlerComposite getReturnValueHandlers()
Return the configured handlers, or possiblynull
if not initialized yet viaafterPropertiesSet()
.
setMessageConverters
public void setMessageConverters(List<HttpMessageConverter<?>> messageConverters)
Set the message body converters to use.These converters are used to convert from and to HTTP requests and responses.
getMessageConverters
public List<HttpMessageConverter<?>> getMessageConverters()
Return the configured message body converters.
setContentNegotiationManager
public void setContentNegotiationManager(ContentNegotiationManager contentNegotiationManager)
Set theContentNegotiationManager
to use to determine requested media types. If not set, the default constructor is used.
getContentNegotiationManager
public ContentNegotiationManager getContentNegotiationManager()
Return the configuredContentNegotiationManager
.
setResponseBodyAdvice
public void setResponseBodyAdvice(List<ResponseBodyAdvice<?>> responseBodyAdvice)
Add one or more components to be invoked after the execution of a controller method annotated with@ResponseBody
or returningResponseEntity
but before the body is written to the response with the selectedHttpMessageConverter
.
setApplicationContext
public void setApplicationContext(ApplicationContext applicationContext)
Description copied from interface:ApplicationContextAware
Set the ApplicationContext that this object runs in. Normally this call will be used to initialize the object.Invoked after population of normal bean properties but before an init callback such as
InitializingBean.afterPropertiesSet()
or a custom init-method. Invoked afterResourceLoaderAware.setResourceLoader(org.springframework.core.io.ResourceLoader)
,ApplicationEventPublisherAware.setApplicationEventPublisher(org.springframework.context.ApplicationEventPublisher)
andMessageSourceAware
, if applicable.- Specified by:
setApplicationContext
in interfaceApplicationContextAware
- Parameters:
applicationContext
- the ApplicationContext object to be used by this object- See Also:
BeanInitializationException
getApplicationContext
public ApplicationContext getApplicationContext()
afterPropertiesSet
public void afterPropertiesSet()
Description copied from interface:InitializingBean
Invoked by the containingBeanFactory
after it has set all bean properties and satisfiedBeanFactoryAware
,ApplicationContextAware
etc.This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set.
- Specified by:
afterPropertiesSet
in interfaceInitializingBean
getExceptionHandlerAdviceCache
public Map<ControllerAdviceBean,ExceptionHandlerMethodResolver> getExceptionHandlerAdviceCache()
Return an unmodifiable Map with the@ControllerAdvice
beans discovered in the ApplicationContext. The returned map will be empty if the method is invoked before the bean has been initialized viaafterPropertiesSet()
.
getDefaultArgumentResolvers
protected List<HandlerMethodArgumentResolver> getDefaultArgumentResolvers()
Return the list of argument resolvers to use including built-in resolvers and custom resolvers provided viasetCustomArgumentResolvers(java.util.List<org.springframework.web.method.support.HandlerMethodArgumentResolver>)
.
getDefaultReturnValueHandlers
protected List<HandlerMethodReturnValueHandler> getDefaultReturnValueHandlers()
Return the list of return value handlers to use including built-in and custom handlers provided viasetReturnValueHandlers(java.util.List<org.springframework.web.method.support.HandlerMethodReturnValueHandler>)
.
doResolveHandlerMethodException
protected ModelAndView doResolveHandlerMethodException(HttpServletRequest request, HttpServletResponse response, HandlerMethod handlerMethod, Exception exception)
Find an@ExceptionHandler
method and invoke it to handle the raised exception.- Specified by:
doResolveHandlerMethodException
in classAbstractHandlerMethodExceptionResolver
- Parameters:
request
- current HTTP requestresponse
- current HTTP responsehandlerMethod
- the executed handler method, ornull
if none chosen at the time of the exception (for example, if multipart resolution failed)exception
- the exception that got thrown during handler execution- Returns:
- a corresponding ModelAndView to forward to, or
null
for default processing
getExceptionHandlerMethod
protected ServletInvocableHandlerMethod getExceptionHandlerMethod(HandlerMethod handlerMethod, Exception exception)
Find an@ExceptionHandler
method for the given exception. The default implementation searches methods in the class hierarchy of the controller first and if not found, it continues searching for additional@ExceptionHandler
methods assuming some @ControllerAdvice Spring-managed beans were detected.- Parameters:
handlerMethod
- the method where the exception was raised (may benull
)exception
- the raised exception- Returns:
- a method to handle the exception, or
null
if none