XML example with Jersey + JAXB

This tutorial show you how to use JAXB to convert object to XML in Jersey, and return it back to user.

1. Dependency

To integrate JAXB with Jersey, no extra dependency is required. Just include “jersey-server.jar” will do.

2. JAXB Annotation

Annotate object with JAXB annotation, for conversion later.

import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
 
@XmlRootElement(name = "customer")
public class Customer {
 
	String name;
	int pin;
 
	@XmlElement
	public String getName() {
		return name;
	}
 
	public void setName(String name) {
		this.name = name;
	}
 
	@XmlAttribute
	public int getPin() {
		return pin;
	}
 
	public void setPin(int pin) {
		this.pin = pin;
	}
 
}

Above object will convert into following XML format.

  <customer pin="value">
	<name>value</name>
  </customer>

3. Jersey and XML

To return a XML file, annotate the method with @Produces(MediaType.APPLICATION_XML). Jersey will convert the JAXB annotated object into XML file automatically.

import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;
import com.mkyong.Customer;
 
@Path("/xml/customer")
public class XMLService {
 
	@GET
	@Path("/{pin}")
	@Produces(MediaType.APPLICATION_XML)
	public Customer getCustomerInXML(@PathParam("pin") int pin) {
 
		Customer customer = new Customer();
		customer.setName("mkyong");
		customer.setPin(pin);
 
		return customer;
 
	}
 
}

4. Demo

When URI pattern “xml/customer/{param value}” is requested, a formatted XML file will be returned.

URL : http://localhost:8080/RESTfulExample/rest/xml/customer/999

xml and jersey

Download Source Code

Download it – XML-Support-Jersey-Example.zip (6 KB)

References

  1. JAXB Official Website
  2. XML support in Jersey
Tags :

About the Author

mkyong
Founder of Mkyong.com and HostingCompass.com, love Java and open source stuff. Follow him on Twitter, or befriend him on Facebook or Google Plus. If you like my tutorials, consider make a donation to these charities.

Comments

  • Pingback: best bottled water()

  • Pingback: water ionizers()

  • Pingback: watch movies online free()

  • Pingback: watch free movies online()

  • Pingback: watch movies online()

  • Pingback: free movie downloads()

  • Pingback: Blue Coaster33()

  • Pingback: JAX-RS TUTORIALS | BUYWORKSELL()

  • Rajvi

    Hi,
    I found this tutorials very helpful,
    but I have a question that
    suppose I want this kind of output for xml than how can I do???

    means I want attributes in subelement using ur technique to generate xml authomatically..
    I know how to generate it mannually.

    • Rajvi

      #customer pin=”value”#
      #Name name=”name”/#
      #/customer#

  • TT

    Your example is always simple and easy to understand, very good for beginners, thanks.

  • Maurizio

    Great example. Thank you very much.

  • Kunal Handa

    Desired output. Please see my first comment.

  • Kunal Handa

    Hi,
    How I can Choose to return only specific fields instead of complete Bean?
    e.g. In above example how can I return only below output?

    though my bean has 2 members, I want to return only one (pin) but not name?
    Is it possible?

    Thanks
    Kunal Handa

  • John Sc

    Very helpful, thank you!

  • avi_yach

    How can we reply a list containing objects instead of a single object? I am a newbie to this technology, help of any sort is appreciated :) Thanks in advanced.

  • George

    How would you use a post method on the client side? to post xml, I only find post json.

    Thanks