RESTful java web service with XML Response
- Saturday, May 4, 2013, 5:53
- Web service
- 20,998 views
In my previous post I discuss about how to write a simple REST web service using jersey, today we discuss more on it and demonstrate how you can create custom java class with JAXB and deal with XML response using jersey.
Let’s first create eclipse Java EE project and add all depending jersey jar files in classpath.
Edit your web.xml to look like similar to following.
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 |
<?xml version="1.0" encoding="UTF-8"?> <web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee" xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd" id="WebApp_ID" version="3.0"> <display-name>RESTfulTest</display-name> <servlet> <servlet-name>jersey-serlvet</servlet-name> <servlet-class>com.sun.jersey.spi.container.servlet.ServletContainer</servlet-class> <init-param> <param-name>com.sun.jersey.config.property.packages</param-name> <param-value>org.techzoo.restful</param-value> </init-param> <load-on-startup>1</load-on-startup> </servlet> <servlet-mapping> <servlet-name>jersey-serlvet</servlet-name> <url-pattern>/rest/*</url-pattern> </servlet-mapping> </web-app> |
We create Car class and make it JAXB compatible so it will be easy for jersey to return response in XML-format. Your class should like below. The annotation is self-explanatory.
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 |
package org.techzoo.restful; import javax.xml.bind.annotation.XmlAttribute; import javax.xml.bind.annotation.XmlElement; import javax.xml.bind.annotation.XmlRootElement; @XmlRootElement(name="car-details") public class Car { private int carId; private String carName, make; private double price; public Car(){} public Car(int carId, String carName, String make, double price) { super(); this.carId = carId; this.carName = carName; this.make = make; this.price = price; } @XmlAttribute(name = "car-id") public int getCarId() {return carId;} public void setCarId(int carId) {this.carId = carId;} @XmlElement (name="car-name") public String getCarName() {return carName;} public void setCarName(String carName) {this.carName = carName;} @XmlElement public String getMake() {return make;} public void setMake(String make) {this.make = make;} @XmlElement public double getPrice() {return price;} public void setPrice(double price) {this.price = price;} @Override public String toString() { return String.format("Car Details " + "[Name=%s, Make=%s, Price=%f]", carName, make, price); } } |
Customized exception class for proper exception propagation to client.
|
1 2 3 4 5 6 |
package org.techzoo.restful; public class CarNotFoundException extends RuntimeException { public CarNotFoundException(){super();} public CarNotFoundException(String msg){super(msg);} } |
Now write web service class which uses Car class and return response to client in XML format. We use @Produces (MediaType.APPLICATION_XML) annotation for returning XML format.
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 |
package org.techzoo.restful; import java.util.HashMap; import java.util.Map; 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; @Path("/xml/car") public class CarWebService { private Map<String, Car> cars; public CarWebService(){ cars = new HashMap<String, Car>(); cars.put("nano", new Car(1,"Nano","TATA",165000)); cars.put("tavera", new Car(2, "Tavera", "Chervolet", 865000)); cars.put("scorpio", new Car(2, "Scorpio", "Mahindra", 870000)); } @GET @Path("/{name}") @Produces (MediaType.APPLICATION_XML) public Car getCarDetailsByName(@PathParam("name") String name) { if(cars.containsKey(name)) return cars.get(name); else throw new CarNotFoundException( "Car with name = "+name+" not found."); } @GET @Path("/{name}/{make}") @Produces (MediaType.APPLICATION_XML) public Car getCarDetailsByNameAndMake(@PathParam("name") String name, @PathParam("make") String make) { if(cars.containsKey(name)){ Car car = cars.get(name); if(car.getMake().equals(make)) { return car; } else throw new CarNotFoundException( "Car with name = "+name+" doesn't belong to "+make); } else throw new CarNotFoundException( "Car with name = "+name+" not found."); } } |
After publishing this web service you can access this through browser using following URL.
http://localhost:8080/RESTfulTest/rest/xml/car/nano
Write java client to access this web service…
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 |
package org.techzoo.clients; import org.techzoo.restful.Car; import com.sun.jersey.api.client.Client; import com.sun.jersey.api.client.ClientResponse; import com.sun.jersey.api.client.WebResource; /** * @author Tousif Khan **/ public class CarWebServiceClient { private static final String URL = "http://localhost:8080/RESTfulTest/rest/xml/car/scorpio"; public static void main(String[] args) throws Exception { try { Client client = Client.create(); WebResource webResource = client.resource(URL); WebResource.Builder builder = webResource.accept("application/xml"); ClientResponse response = builder.get(ClientResponse.class); if (response.getStatus() != 200) { throw new RuntimeException("Failed : HTTP error code : "+ response.getStatus()); } Car car = response.getEntity(Car.class); System.out.println(car); } catch (Exception e) { e.printStackTrace(); } } } |
About the Author
Tousif Khan has written 54 posts.
I Love Coding, Analyzing, Designing and doing it the right way. I am obsessed about learn anything new daily and sharing what I have learn each Day. This Blog is journey of my Zeal, going through step by step to the mountain of desire to become prefect. Google