Throwing exceptions from Spring REST webservice as JSON/XML

Question

I have a REST web service controller that looks like this:

@RequestMapping(value = URIConstants.URL_DOCUMENT_SEARCH, method = RequestMethod.POST, produces = { MediaType.APPLICATION_XML_VALUE, MediaType.APPLICATION_JSON_VALUE }) protected DocumentSearchResponse getDocuments(@Valid @ModelAttribute DocumentSearchRequest objDMSRequest,BindingResult bindingResult, HttpServletRequest objServletRequest) throws AppException { if (bindingResult.hasErrors()) { //I want to throw my custom exception here ///Or can anyone suggest a more clean and efficient way } -----More code and logic }

I have a custom exception and handlers that will throw invalid HTTP invalid request exception. The custom exception has errorcode and error description fields. My requirement is is there a way to parse the error from the bindingresults to a custome exception and trow that in the controler.

Raphael Amoedo · Accepted Answer · 2015-05-15 04:26:49Z

3

What you can do:

return new ResponseEntity<String>(errorDescription,HttpStatus.BAD_REQUEST);

Or, you can do it hardcore if you really want to use Exception(not recommended):

try { throw new CustomException(); } catch(CustomException e) { e.printStackTrace(); return new ResponseEntity<String>(e.getErrorDescription(),e.getStatusCode()); }

By the way: returning a Exception it's not good, that's why I don't show it.

answered May 15, 2015 at 4:26

Raphael Amoedo

4,4954 gold badges32 silver badges39 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

Albert Pinto Over a year ago

thats a wonderful suggestion . Can you please tell me what will you suggest when my controller looks something like this:

Albert Pinto Over a year ago

Can u please suggest what if my controller looks like : @RequestMapping(method=RequestMethod.POST) public <custom Response Bean POJO> getResults(@Valid User user, BindingResult bindingResult) {

Raphael Amoedo Over a year ago

With public ResponseEntity , you can return your POJO normally. return new ResponseEntity<>(yourPOJO, HttpStatus.OK); Take a look here: stackoverflow.com/questions/26134331/…

chetank · Accepted Answer · 2015-05-15 04:32:46Z

@Albert-Pinto first of all the way you are trying to do this is completely wrong. If you want to consume a object it should come as @RequestBody and not as just a simple object. What you have done in your example is a MVC way which we do with the web applications, not the way we do for web service. so the above code will become as

@Controller @RequestMapping("/user") public class UserController { @RequestMapping(method=RequestMethod.POST) public ResponseEntity create(@RequestBody User user) { try { throw new CustomException(); } catch(CustomException e) { e.printStackTrace(); return new ResponseEntity<String>(e.getErrorDescription(),e.getStatusCode()); } }

Raphael Amoedo · Accepted Answer · 2017-06-23 05:09:30Z

Its is as simple as that 1. Create a class which extends Exception.

 class MyCustomException extends Exception{ MyCustomException(){ } MyCustomException(Object e){ super(e) } }

2. Make your code throw same type of exception

@Controller @RequestMapping("/user") public class UserController { @RequestMapping(method=RequestMethod.POST) public ResponseEntity create(@Valid User user, BindingResult bindingResult) { try{ if (bindingResult.hasErrors()) { throw new MyCustomException(); } } catch(MyCustomException e){ //do what ever you want to do with it } ... }

3. Man you already done... :)

Collectives™ on Stack Overflow

Throwing exceptions from Spring REST webservice as JSON/XML

3 Answers 3

3 Comments

Comments

Comments

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

3 Comments

Comments

Comments

Linked

Related