Spring rest controller @ExceptionHandler return xml content and json errors

Question

So I have a @RestController and I want to return and validate XML based on a schema for a front-end application in order to display them in an editor. I want the errors to be in json format in order to handle and display them with js.

@RestController
public class UserController {

    @RequestMapping(value = "/test",
        method = RequestMethod.GET,
        produces = MediaType.APPLICATION_XML_VALUE)
    public ResponseEntity<String> throwException(
        @RequestParam(value = "flag", defaultValue = "false") Boolean flag
    ) throws Exception {
        if (flag) {
            throw new Exception();
        } else {
            return ResponseEntity.ok("<xml>hello</xml>");
        }
    }


    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ExceptionHandler(Exception.class)
    @ResponseBody
    ServerError exceptionHandler(HttpServletRequest req, Exception ex) {
        return new ServerError(req.getRequestURL().toString(),ex);
    }

}

The ServerError I want to return in JSON format :

public class ServerError {

    public final String url;
    public final String error;

    public ServerError(String url, Exception ex) {
        this.url = url;
        this.error = ex.getMessage();
    }

    public String getUrl() {
        return url;
    }

    public String getError() {
        return error;
    }
}

So the <xml>hello</xml> is returned just fine but when I set the flag to true I get

ERROR   2017-10-18 12:56:53,189 [http-nio-0.0.0.0-8080-exec-2] org.springframework.web.servlet.mvc.method.annotation.ExceptionHandlerExceptionResolver  - Failed to invoke @ExceptionHandler method: eu.openminted.registry.core.exception.ServerError eu.openminted.registry.service.UserController.malformedExeption(javax.servlet.http.HttpServletRequest,java.lang.Exception)
org.springframework.web.HttpMediaTypeNotAcceptableException: Could not find acceptable representation

Also, setting the produces to both XML and JSON yields the same result

@RequestMapping(value = "/test",
        method = RequestMethod.GET,
        produces = {MediaType.APPLICATION_XML_VALUE,MediaType.APPLICATION_JSON_UTF8_VALUE})

stefanos · Accepted Answer · 2017-10-18 10:31:18Z

4

I have managed to solve this by removing the produces from @RequestMapping and specifying with ResponseEntity the type I want to return

@RequestMapping(value = "/test", method = RequestMethod.GET)
public ResponseEntity<String> throwException(
    @RequestParam(value = "flag", defaultValue = "false") Boolean flag
) throws Exception {
    if (flag) {
        throw new Exception();
    } else {
        ResponseEntity response = ResponseEntity.ok().
            contentType(MediaType.APPLICATION_XML).
            body("<xml>hello</xml>");
        return response;
    }
}

The problem with that solution is that all of the methods have an @annotation with the type they produce and this doesn't, breaking uniformity.

answered Oct 18, 2017 at 10:31

stefanos

2703 silver badges13 bronze badges

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

2 Comments

araknoid Over a year ago

Since you solved the issue, you should accept your own answer so people that will see your question know it's solved and therefore could be helpful.

stefanos Over a year ago

@araknoid there is a 2 day waiting period before I can accept it.

Amit K Bist · Accepted Answer · 2017-10-18 14:43:52Z

3

You need to add below dependency in your pom.xml and it will work with your code with produces = MediaType.APPLICATION_XML_VALUE,

    <dependency>
        <groupId>com.fasterxml.jackson.dataformat</groupId>
        <artifactId>jackson-dataformat-xml</artifactId>
    </dependency>

answered Oct 18, 2017 at 14:43

Amit K Bist

6,8581 gold badge13 silver badges26 bronze badges

2 Comments

stefanos Over a year ago

I didn't (de)serialize any XML in this minimal example, why would this help?

Amit K Bist Over a year ago

You did try to serialize by converting ServerError object to XML, so above dependency will take care of serializing this object when sending it as XML

silk · Accepted Answer · 2019-07-12 07:12:50Z

0

One option is to add content type to ResponseEntity explicitly in ExceptionHandler.

Controller:

@GetMapping("/path", produces = [MediaType.TEXT_XML_VALUE])

ControllerAdvice:

@ExceptionHandler(org.springframework.validation.BindException::class)
    fun handleBindException(
        e: org.springframework.validation.BindException
    ): ResponseEntity<ErrorResponse> {    
        return ResponseEntity
            .status(HttpStatus.BAD_REQUEST)
            .contentType(MediaType.APPLICATION_JSON_UTF8)
            .body(ErrorResponse(e.message))
    }

ErrorResponse

data class ErrorResponse(val message: String?)

Tested on Spring Boot 2.1.3.RELEASE with Kotlin

answered Jul 12, 2019 at 7:12

silk

1711 silver badge5 bronze badges

Comments

Alex · Accepted Answer · 2021-10-08 14:52:57Z

0

In order to make ExceptionHandler return XML format(by default it returns JSON format), there two steps need to do:

import the maven dependency:

 <dependency>
     <groupId>com.fasterxml.jackson.dataformat</groupId>
     <artifactId>jackson-dataformat-xml</artifactId>
 </dependency>

use ResposneEntity's static method internalServerError(): ResponseEntity.internalServerError().header("MyHeader","MyValue").contentType(MediaType.APPLICATION_XML).body(ex);

inside the contentType, specify MediaType.APPLICATION_XML.

answered Oct 8, 2021 at 14:52

Alex

6498 silver badges25 bronze badges

Collectives™ on Stack Overflow

Spring rest controller @ExceptionHandler return xml content and json errors

4 Answers 4

2 Comments

2 Comments

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

2 Comments

2 Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related