org.hawaiiframework.web.exception

Class HawaiiResponseEntityExceptionHandler

java.lang.Object

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

org.hawaiiframework.web.exception.HawaiiResponseEntityExceptionHandler

@ControllerAdvice
public class HawaiiResponseEntityExceptionHandler
extends ResponseEntityExceptionHandler

This class creates proper HTTP response bodies for exceptions.

Since:

2.0.0

Author:

Marcel Overdijk, Ivan Melotte

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)

Method Summary

Modifier and Type	Method and Description
protected ErrorResponseResource	buildErrorResponseBody(Throwable t, HttpStatus status, WebRequest request) Builds a meaningful response body for the given throwable, HTTP status and request.
protected ResponseEntity<Object>	handleExceptionInternal(Exception ex, Object body, HttpHeaders headers, HttpStatus status, WebRequest request)
ResponseEntity	handleHttpException(HttpException e, WebRequest request) Handles HttpException instances.
ResponseEntity	handleThrowable(Throwable t, WebRequest request) Handles Throwable instances.
ResponseEntity	handleValidationException(ValidationException e, WebRequest request) Handles ValidationException instances.

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)

Method Detail

handleHttpException

@ExceptionHandler(value=HttpException.class)
 @ResponseBody
public ResponseEntity handleHttpException(HttpException e,
                                                                                                      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 ResponseEntity handleValidationException(ValidationException e,
                                                                                                                  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 ResponseEntity handleThrowable(Throwable t,
                                                                                                        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 ResponseEntity<Object> handleExceptionInternal(Exception ex,
                                                         Object body,
                                                         HttpHeaders headers,
                                                         HttpStatus status,
                                                         WebRequest request)

Overrides:

handleExceptionInternal in class ResponseEntityExceptionHandler

buildErrorResponseBody

protected ErrorResponseResource buildErrorResponseBody(Throwable t,
                                                       HttpStatus status,
                                                       WebRequest request)

Builds a meaningful response body for the given throwable, HTTP status and request.

Parameters:

t - the exception

status - the HTTP status

request - the current request

Returns:

an error response