org.hawaiiframework.web.exception

Class HawaiiResponseEntityExceptionHandler

java.lang.Object

org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler

org.hawaiiframework.web.exception.HawaiiResponseEntityExceptionHandler

All Implemented Interfaces:

org.springframework.beans.factory.InitializingBean

@ControllerAdvice
public class HawaiiResponseEntityExceptionHandler
extends org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler
implements org.springframework.beans.factory.InitializingBean

This class creates proper HTTP response bodies for exceptions. In this implementation, the response enrichers are stored in a map, with the class name as key. This means that any enricher can be stored only once. Also, enrichers are not ordered. Subclasses may implement another mechanism if required. This would mean that the following methods would need to be overwritten:

• addResponseEnricher(ErrorResponseEnricher)
• removeResponseEnricher(ErrorResponseEnricher) (optionally)
• configureResponseEnrichers()
• getResponseEnrichers()

Since:

2.0.0

Author:

Marcel Overdijk, Ivan Melotte, Paul Klos

Field Summary

Fields inherited from class org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler

PAGE_NOT_FOUND_LOG_CATEGORY, pageNotFoundLogger

Constructor Summary

Constructors

Constructor and Description
HawaiiResponseEntityExceptionHandler(ValidationErrorResourceAssembler validationErrorResourceAssembler, ExceptionResponseFactory exceptionResponseFactory)

Method Summary

Modifier and Type	Method and Description
protected void	addResponseEnricher(ErrorResponseEnricher errorResponseEnricher) Registers a ErrorResponseEnricher.
void	afterPropertiesSet()
protected ErrorResponseResource	buildErrorResponseBody(java.lang.Throwable throwable, org.springframework.http.HttpStatus status, org.springframework.web.context.request.WebRequest request) Builds a meaningful response body for the given throwable, HTTP status and request.
protected void	configureResponseEnrichers() Configures the error response enrichers.
protected java.util.Collection<ErrorResponseEnricher>	getResponseEnrichers() Returns a collection of registered response enrichers.
org.springframework.http.ResponseEntity	handleApiException(ApiException e, org.springframework.web.context.request.WebRequest request) Handles ValidationException instances.
protected org.springframework.http.ResponseEntity<java.lang.Object>	handleExceptionInternal(java.lang.Exception ex, java.lang.Object body, org.springframework.http.HttpHeaders headers, org.springframework.http.HttpStatus status, org.springframework.web.context.request.WebRequest request)
org.springframework.http.ResponseEntity	handleHttpException(HttpException e, org.springframework.web.context.request.WebRequest request) Handles HttpException instances.
org.springframework.http.ResponseEntity	handleThrowable(java.lang.Throwable t, org.springframework.web.context.request.WebRequest request) Handles Throwable instances.
org.springframework.http.ResponseEntity	handleValidationException(ValidationException e, org.springframework.web.context.request.WebRequest request) Handles ValidationException instances.
protected void	removeResponseEnricher(java.lang.Class<? extends ErrorResponseEnricher> className) De-registers a ErrorResponseEnricher based on its class name.
protected void	removeResponseEnricher(ErrorResponseEnricher errorResponseEnricher) De-registers a ErrorResponseEnricher.

Methods inherited from class org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler

handleAsyncRequestTimeoutException, handleBindException, handleConversionNotSupported, handleException, handleHttpMediaTypeNotAcceptable, handleHttpMediaTypeNotSupported, handleHttpMessageNotReadable, handleHttpMessageNotWritable, handleHttpRequestMethodNotSupported, handleMethodArgumentNotValid, handleMissingPathVariable, handleMissingServletRequestParameter, handleMissingServletRequestPart, handleNoHandlerFoundException, handleNoSuchRequestHandlingMethod, handleServletRequestBindingException, handleTypeMismatch

Methods inherited from class java.lang.Object

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

Constructor Detail

HawaiiResponseEntityExceptionHandler

public HawaiiResponseEntityExceptionHandler(ValidationErrorResourceAssembler validationErrorResourceAssembler,
                                            ExceptionResponseFactory exceptionResponseFactory)

Method Detail

afterPropertiesSet

public void afterPropertiesSet()
                        throws java.lang.Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

java.lang.Exception

handleHttpException

@ExceptionHandler(value=HttpException.class)
 @ResponseBody
public org.springframework.http.ResponseEntity handleHttpException(HttpException e,
                                                                                                                               org.springframework.web.context.request.WebRequest request)

Handles HttpException instances.

Each HttpException has an associated HttpStatus that is used as the response status.

Parameters:

e - the exception

request - the current request

Returns:

a response entity reflecting the current exception

handleValidationException

@ExceptionHandler(value=ValidationException.class)
 @ResponseBody
public org.springframework.http.ResponseEntity handleValidationException(ValidationException e,
                                                                                                                                           org.springframework.web.context.request.WebRequest request)

Handles ValidationException instances.

The response status is: 400 Bad Request.

Parameters:

e - the exception

request - the current request

Returns:

a response entity reflecting the current exception

handleApiException

@ExceptionHandler(value=ApiException.class)
 @ResponseBody
public org.springframework.http.ResponseEntity handleApiException(ApiException e,
                                                                                                                             org.springframework.web.context.request.WebRequest request)

Handles ValidationException instances.

The response status is: 400 Bad Request.

Parameters:

e - the exception

request - the current request

Returns:

a response entity reflecting the current exception

handleThrowable

@ExceptionHandler(value=java.lang.Throwable.class)
 @ResponseBody
public org.springframework.http.ResponseEntity handleThrowable(java.lang.Throwable t,
                                                                                                                                 org.springframework.web.context.request.WebRequest request)

Handles Throwable instances. This method acts as a fallback handler.

Parameters:

t - the exception

request - the current request

Returns:

a response entity reflecting the current exception

handleExceptionInternal

protected org.springframework.http.ResponseEntity<java.lang.Object> handleExceptionInternal(java.lang.Exception ex,
                                                                                            java.lang.Object body,
                                                                                            org.springframework.http.HttpHeaders headers,
                                                                                            org.springframework.http.HttpStatus status,
                                                                                            org.springframework.web.context.request.WebRequest request)

Overrides:

handleExceptionInternal in class org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler

buildErrorResponseBody

protected ErrorResponseResource buildErrorResponseBody(java.lang.Throwable throwable,
                                                       org.springframework.http.HttpStatus status,
                                                       org.springframework.web.context.request.WebRequest request)

Builds a meaningful response body for the given throwable, HTTP status and request. This method constructs an ErrorResponseResource using exceptionResponseFactory and then applies the error response enrichers returned from getResponseEnrichers() to complete the response.

Parameters:

throwable - the exception

status - the HTTP status

request - the current request

Returns:

an error response

addResponseEnricher

protected void addResponseEnricher(ErrorResponseEnricher errorResponseEnricher)

Registers a ErrorResponseEnricher.

Parameters:

errorResponseEnricher - the error response enricher

removeResponseEnricher

protected void removeResponseEnricher(ErrorResponseEnricher errorResponseEnricher)

De-registers a ErrorResponseEnricher.

Parameters:

errorResponseEnricher - the error response enricher

removeResponseEnricher

protected void removeResponseEnricher(java.lang.Class<? extends ErrorResponseEnricher> className)

De-registers a ErrorResponseEnricher based on its class name.

Parameters:

className - the class name of the ErrorResponseEnricher to remove

configureResponseEnrichers

protected void configureResponseEnrichers()

Configures the error response enrichers.

Subclasses may override this method to remove existing or add additional listeners, using addResponseEnricher(ErrorResponseEnricher) and removeResponseEnricher(ErrorResponseEnricher).

The default implementation adds the following listeners:

• ErrorResponseStatusEnricher
• RequestInfoErrorResponseEnricher
• ValidationErrorResponseEnricher
• ApiErrorResponseEnricher

getResponseEnrichers

protected java.util.Collection<ErrorResponseEnricher> getResponseEnrichers()

Returns a collection of registered response enrichers.

Returns:

the response enrichers