Package de.hybris.platform.webservicescommons.resolver

Class RestExceptionResolver

java.lang.Object

org.springframework.web.servlet.handler.AbstractHandlerExceptionResolver

de.hybris.platform.webservicescommons.resolver.AbstractRestHandlerExceptionResolver

de.hybris.platform.webservicescommons.resolver.RestExceptionResolver

All Implemented Interfaces:

org.springframework.core.Ordered, org.springframework.web.servlet.HandlerExceptionResolver

public class RestExceptionResolver
extends AbstractRestHandlerExceptionResolver

Exception resolver implementation for RESTful Web services. Resolver sets error status and message in the response, that can be customized based on configuration.

Class internally uses FallbackConfigurationHelper to get configuration values. Configuration is defined on 3 levels: specified extension, webservicescommons or default.

In first place configuration is taken from specified extension. In second place configuration is taken from webservicescommons (if extension configuration is not defined).

If configuration is not defined then exception stacktrace is logged and default value of status and error message is set.

Field Summary

Fields inherited from class de.hybris.platform.webservicescommons.resolver.AbstractRestHandlerExceptionResolver

UNDEFINED_ERROR_STATUS

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
RestExceptionResolver()

Method Summary

Modifier and Type	Method	Description
protected ExceptionMessageFormatterType	calculateExceptionMessageFormatter(java.lang.Exception ex)	Calculates exception message formatter type.
protected int	calculateStatusFromException(java.lang.Exception ex)	Calculates HTTP status code.
protected ErrorListWsDTO	convertException(java.lang.Exception ex)	Converts Exception object into list of ErrorWsDTO.
protected org.springframework.web.servlet.ModelAndView	doResolveException(javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse, java.lang.Object handler, java.lang.Exception ex)
protected java.util.Map<ExceptionMessageFormatterType,AbstractExceptionMessageFormatter>	getExceptionMapping()
protected java.lang.String	getExtensionName()
protected FallbackConfigurationHelper	getFallbackConfigurationHelper()
protected void	setErrorMessages(java.lang.Exception ex, ErrorListWsDTO errorListDto)	Sets formatted error message to each error from list.
void	setExceptionMapping(java.util.Map<ExceptionMessageFormatterType,AbstractExceptionMessageFormatter> exceptionMapping)
void	setExtensionName(java.lang.String extensionName)
void	setFallbackConfigurationHelper(FallbackConfigurationHelper fallbackConfigurationHelper)
protected boolean	shouldDisplayStack(java.lang.Exception ex)	Calculates boolean value used to determine if exception stacktrace should be logged.

Methods inherited from class de.hybris.platform.webservicescommons.resolver.AbstractRestHandlerExceptionResolver

doResolveExceptionInternal, getAcceptedMediaTypes, getMessageConverters, getWebserviceErrorFactory, init, setMessageConverters, setOrder, setWebserviceErrorFactory, writeWithMessageConverters

Methods inherited from class org.springframework.web.servlet.handler.AbstractHandlerExceptionResolver

buildLogMessage, getOrder, hasHandlerMappings, logException, prepareResponse, preventCaching, resolveException, setMappedHandlerClasses, setMappedHandlers, setPreventResponseCaching, setWarnLogCategory, shouldApplyTo

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RestExceptionResolver

public RestExceptionResolver()

Method Detail

calculateStatusFromException

protected int calculateStatusFromException(java.lang.Exception ex)

Description copied from class: AbstractRestHandlerExceptionResolver

Calculates HTTP status code.

Overrides:

calculateStatusFromException in class AbstractRestHandlerExceptionResolver

Parameters:

ex - exception object

Returns:

HTTP status code

shouldDisplayStack

protected boolean shouldDisplayStack(java.lang.Exception ex)

Description copied from class: AbstractRestHandlerExceptionResolver

Calculates boolean value used to determine if exception stacktrace should be logged.

Overrides:

shouldDisplayStack in class AbstractRestHandlerExceptionResolver

Parameters:

ex - exception object

Returns:

information if exception stacktrace should be logged or not

convertException

protected ErrorListWsDTO convertException(java.lang.Exception ex)

Description copied from class: AbstractRestHandlerExceptionResolver

Converts Exception object into list of ErrorWsDTO.

Overrides:

convertException in class AbstractRestHandlerExceptionResolver

Parameters:

ex - exception object

Returns:

Object with list of ErrorWsDTO

doResolveException

protected org.springframework.web.servlet.ModelAndView doResolveException(javax.servlet.http.HttpServletRequest httpServletRequest,
                                                                          javax.servlet.http.HttpServletResponse httpServletResponse,
                                                                          java.lang.Object handler,
                                                                          java.lang.Exception ex)

Specified by:

doResolveException in class org.springframework.web.servlet.handler.AbstractHandlerExceptionResolver

setErrorMessages

protected void setErrorMessages(java.lang.Exception ex,
                                ErrorListWsDTO errorListDto)

Sets formatted error message to each error from list.

Method internally uses message formatter defined in configuration.

Parameters:

ex - exception object

errorListDto - list of Webservices errors for which message is formatted and set

calculateExceptionMessageFormatter

protected ExceptionMessageFormatterType calculateExceptionMessageFormatter(java.lang.Exception ex)

Calculates exception message formatter type.

Parameters:

ex - exception object

Returns:

exception message formatter type

getExceptionMapping

protected java.util.Map<ExceptionMessageFormatterType,AbstractExceptionMessageFormatter> getExceptionMapping()

setExceptionMapping

public void setExceptionMapping(java.util.Map<ExceptionMessageFormatterType,AbstractExceptionMessageFormatter> exceptionMapping)

getFallbackConfigurationHelper

protected FallbackConfigurationHelper getFallbackConfigurationHelper()

setFallbackConfigurationHelper

public void setFallbackConfigurationHelper(FallbackConfigurationHelper fallbackConfigurationHelper)

getExtensionName

protected java.lang.String getExtensionName()

setExtensionName

public void setExtensionName(java.lang.String extensionName)