Convert java object to XML REST response

Question

I want to return XML response message after API REST call. I tried this simple test:

@RestController
public class HelloWorldRestController {

    @Autowired
    ApiService apiService;
    @RequestMapping(value = "/api", method = RequestMethod.GET)
        public ResponseEntity<VisaResponse> listAllUsers() {
            VisaResponse obj = apiService.visaresponse();
            return new ResponseEntity<VisaResponse>(obj, HttpStatus.OK);
        }
    .......
}

I tried to convert simple object to XML

public class VisaResponse {

    public VisaResponse() {
        jaxbObjectToXML(new VisaResponseHeader());
    }

    private static String jaxbObjectToXML(VisaResponseHeader customer) {
        String xmlString = "";
        try {
            JAXBContext context = JAXBContext.newInstance(VisaResponseHeader.class);
            Marshaller m = context.createMarshaller();

            m.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, Boolean.TRUE); // To format XML

            StringWriter sw = new StringWriter();
            m.marshal(customer, sw);
            xmlString = sw.toString();

        } catch (JAXBException e) {
            e.printStackTrace();
        }
        return xmlString;
    }
}

public class VisaResponseHeader {

    private int id;

    public VisaResponseHeader() {
        id = 3;
    }   
}

But when I make a rest request nothing happens - no any response. Do you have any idea where I'm wrong? Simple content should be returned.

Dharita Chokshi · Accepted Answer · 2018-05-30 13:15:11Z

1

Add produces = "application/xml" inside the @RequestMapping. @RequestMapping(value="/api", method=RequestMethod.GET, produces=application/xml")
You need to add number of JAXB annotations to your bean class (VisaResponseHeader) to allow it to be marshalled into XML.

@XmlRootElement: This annotation is used at the top level class to indicate the root element in the XML document. The name attribute in the annotation is optional. If not specified, the class name is used as the root XML element in the document.

@XmlAttribute: This annotation is used to indicate the attribute of the root element.

@XmlElement: This annotation is used on the properties of the class which will be the sub-elements of the root element.

HelloWorldRestController .java

@RestController
public class HelloWorldRestController {

    @Autowired
    ApiService apiService;

    @RequestMapping(value = "/api", method = RequestMethod.GET)
    public ResponseEntity<String> listAllUsers() {
        // get data from database
        VisaResponse visaResponse = apiService.visaresponse();

        // convert bean to XML
        String xmlResponse = jaxbObjectToXML(visaResponse);

        return new ResponseEntity<>(xmlResponse, HttpStatus.OK);
    }

    private static String jaxbObjectToXML(VisaResponse customer) {
        String xmlString = "";
        try {
            JAXBContext context = JAXBContext.newInstance(VisaResponse.class);
            Marshaller m = context.createMarshaller();

            m.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, Boolean.TRUE);
            StringWriter sw = new StringWriter();
            m.marshal(customer, sw);
            xmlString = sw.toString();
        } catch (JAXBException e) {
            e.printStackTrace();
        }
        return xmlString;
    }
}

VisaResponse.java

    @XmlRootElement
    @XmlAccessorType(XmlAccessType.FIELD)
    public class VisaResponse {

        @XmlElement
        private int id;

        // for testing purpose. Remove once database integration is done and data is received via service and repository.
        public VisaResponse() {
            id = 3;
        }
    }

No need of VisaResponseHeader.java class.

Expected output(Tested using Postman)

edited May 30, 2018 at 13:15

answered May 30, 2018 at 10:18

Dharita Chokshi

1,2733 gold badges19 silver badges41 bronze badges

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

4 Comments

Dharita Chokshi Over a year ago

@PeterPenzov Try modified code. This is working fine, giving expected XML output

Peter Penzov Over a year ago

Looks like I have wrong project setup. Can I ask you to upload your project?

Dharita Chokshi Over a year ago

I have uploaded my sample project on github.com/Dharita/Java_object_to_XML_REST_Response. You can clone it.

Peter Penzov Over a year ago

Thanks you very much. If you have time can you show me how I can add authentication and SSL encryption in communication?

user9869525 · Accepted Answer · 2018-05-30 10:25:05Z

1

@XmlRootElement
public class VisaResponseHeader {

    @XmlElement(name = "id")
    private int id;

    public VisaResponseHeader() {
        id = 3;
    }   
}

answered May 30, 2018 at 10:25

user9869525

1 Comment

Peter Penzov Over a year ago

Unfortunately I get empty result again.

pranjal nartam · Accepted Answer · 2018-05-30 10:40:14Z

1

Try adding produces = "application/xml" inside the @RequestMapping. Your annotation should be like @RequestMapping(value = "/api", method = RequestMethod.GET,produces = "application/xml").

Along with this, you should add @XmlRootElement(name = "visa") @XmlAccessorType(XmlAccessType.FIELD) to your VisaResponse POJO and @XmlElement to each element you want in the XML.

Edited:

import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;

@XmlRootElement
@XmlAccessorType(XmlAccessType.FIELD)
public class VisaResponse {

    @XmlElement
    private int visaNumber;

    public int getVisaNumber() {
        return visaNumber;
    }

    public void setVisaNumber(int visaNumber) {
        this.visaNumber = visaNumber;
    }

}

Hope this helps.

edited May 30, 2018 at 10:40

answered May 30, 2018 at 10:30

pranjal nartam

134 bronze badges

2 Comments

Peter Penzov Over a year ago

probably you mean VisaResponseHeader class?

pranjal nartam Over a year ago

@PeterPenzov yes

Niranga Sandaruwan · Accepted Answer · 2018-05-30 11:10:27Z

0

 @RequestMapping(value = "/api", method = RequestMethod.GET, produces = {
        "application/xml" })
    public ResponseEntity<VisaResponse> listAllUsers() {
        VisaResponse obj = apiService.visaresponse();
        return new ResponseEntity<VisaResponse>(obj, HttpStatus.OK);
    }



    @XmlRootElement
    public class VisaResponse implements Serializable{

        private int id;

        public VisaResponse() {
            id = 3;
        } 
public getId(){
return id;
}  
public setId(int id) {
this.id = id;
}
    }

edited May 30, 2018 at 11:10

answered May 30, 2018 at 10:41

Niranga Sandaruwan

7115 gold badges22 silver badges41 bronze badges

Collectives™ on Stack Overflow

Convert java object to XML REST response

4 Answers 4

4 Comments

1 Comment

2 Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

4 Comments

1 Comment

2 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related