org.exoplatform.acceptance.rest

Class JsonErrorHandler

java.lang.Object

org.exoplatform.acceptance.rest.JsonErrorHandler

@ControllerAdvice
public class JsonErrorHandler
extends Object

Errors handler for REST services to convert an exception in a standardized JSON message and the related HTTP status code.

Since:

2.0.0

Author:

Arnaud Héritier ( aheritier@exoplatform.com )

Constructor Summary

Constructors

Constructor and Description
JsonErrorHandler()

Method Summary

Methods

Modifier and Type	Method and Description
JsonErrorResponse	handleDuplicateKeyException(org.springframework.dao.DuplicateKeyException ex) Catch DuplicateKeyException when an entity creation or update doesn't a constraint of uniqueness in the mongo repository.
JsonErrorResponse	handleEntityNotFoundException(EntityNotFoundException ex) Catch EntityNotFoundException to return a 404 error.
JsonErrorResponse	handleHttpMessageNotReadableException(org.springframework.http.converter.HttpMessageNotReadableException ex) Catch HttpMessageNotReadableException to log it (helps to diagnose errors and attacks on REST services).
JsonErrorResponse	processValidationError(org.springframework.web.bind.MethodArgumentNotValidException ex) Catch MethodArgumentNotValidException when a Bean Validation error occurs.

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonErrorHandler

public JsonErrorHandler()

Method Detail

handleHttpMessageNotReadableException

@ExceptionHandler(value=org.springframework.http.converter.HttpMessageNotReadableException.class)
@RequestMapping(produces="application/json")
@ResponseStatus(value=BAD_REQUEST)
@ResponseBody
public JsonErrorResponse handleHttpMessageNotReadableException(org.springframework.http.converter.HttpMessageNotReadableException ex)
                                                        throws IOException

Catch HttpMessageNotReadableException to log it (helps to diagnose errors and attacks on REST services).

Parameters:

ex - The exception trapped

Returns:

A standardized JsonErrorResponse

Throws:

IOException - if any.

handleDuplicateKeyException

@ExceptionHandler(value=org.springframework.dao.DuplicateKeyException.class)
@RequestMapping(produces="application/json")
@ResponseStatus(value=CONFLICT)
@ResponseBody
public JsonErrorResponse handleDuplicateKeyException(org.springframework.dao.DuplicateKeyException ex)
                                              throws IOException

Catch DuplicateKeyException when an entity creation or update doesn't a constraint of uniqueness in the mongo repository.

Parameters:

ex - The exception trapped

Returns:

A standardized JsonErrorResponse

Throws:

IOException - if any.

processValidationError

@ExceptionHandler(value=org.springframework.web.bind.MethodArgumentNotValidException.class)
@RequestMapping(produces="application/json")
@ResponseStatus(value=BAD_REQUEST)
@ResponseBody
public JsonErrorResponse processValidationError(org.springframework.web.bind.MethodArgumentNotValidException ex)
                                         throws IOException

Catch MethodArgumentNotValidException when a Bean Validation error occurs.

Parameters:

ex - The exception trapped

Returns:

A standardized JsonErrorResponse

Throws:

IOException - if any.

handleEntityNotFoundException

@ExceptionHandler(value=EntityNotFoundException.class)
@RequestMapping(produces="application/json")
@ResponseStatus(value=NOT_FOUND)
@ResponseBody
public JsonErrorResponse handleEntityNotFoundException(EntityNotFoundException ex)
                                                throws IOException

Catch EntityNotFoundException to return a 404 error.

Parameters:

ex - The exception trapped

Returns:

A standardized JsonErrorResponse

Throws:

IOException - if any.