Spring @ExceptionHandler does not work with @ResponseBody

by

Your method

@ExceptionHandler(IllegalArgumentException.class)
public @ResponseBody Map<String, Object> handleException(final Exception e, final HttpServletRequest request, Writer writer)

does not work because it has the wrong return type. @ExceptionHandler methods have only two valid return types:

  • String
  • ModelAndView.

See http://static.springsource.org/spring/docs/3.0.x/spring-framework-reference/html/mvc.html for more information. Here’s the specific text from the link:

The return type can be a String, which
is interpreted as a view name or a
ModelAndView object.

In response to the comment

Thanx, seems I overread this. That’s
bad… any ideas how to provides
exceptions automatically in xml/json
format? – Sven Haiges 7 hours ago

Here’s what I’ve done (I’ve actually done it in Scala so I’m not sure if the syntax is exactly correct, but you should get the gist).

@ExceptionHandler(Throwable.class)
@ResponseBody
public void handleException(final Exception e, final HttpServletRequest request,
        Writer writer)
{
    writer.write(String.format(
            "{\"error\":{\"java.class\":\"%s\", \"message\":\"%s\"}}",
            e.getClass(), e.getMessage()));
}

More Related Contents:

  1. When do I use path params vs. query params in a RESTful API?
  2. Spring 4 RestController JSON: characteristics not acceptable according to the request “accept” headers
  3. Difference between Swagger & HATEOAS
  4. RESTful URL design for search
  5. What is the proper REST response code for a valid request but an empty data?
  6. HTTP response code for POST when resource already exists
  7. Security of REST authentication schemes
  8. How to make remote REST call inside Node.js? any CURL?
  9. How does the Spring @ResponseBody annotation work?
  10. Http Post request with content type application/x-www-form-urlencoded not working in Spring
  11. Best practice for partial updates in a RESTful service
  12. Groovy built-in REST/HTTP client?
  13. Unable to upload zip file through karate framework
  14. API pagination best practices
  15. How to use cURL to send Cookies?
  16. Querystring in REST Resource url
  17. How to construct a REST API that takes an array of id’s for the resources
  18. Expose all IDs when using Spring Data Rest
  19. REST API Authentication
  20. Should I use Singular or Plural name convention for REST resources?
  21. How to download excel (.xls) file from API in postman?
  22. Where can I find jenkins restful api reference? [closed]
  23. Is it correct to return 404 when a REST resource is not found?
  24. When is it appropriate to respond with a HTTP 412 error?
  25. Websocket vs REST when sending data to server
  26. How to do a PUT request with cURL?
  27. What REST PUT/POST/DELETE calls should return by a convention?
  28. Spring REST security – Secure different URLs differently
  29. Trying to create REST-ful URLs with multiple dots in the “filename” part – Spring 3.0 MVC
  30. Get/post to RESTful web service

Leave a Comment