Jersey 2.x web service using both (JSON + XML) example

October 11, 2014 SJ Jersey 2.x 2

In this article, we will learn and implement a JAX-RS Restful Web Service which consumes & produces in both XML/JSON format

Jersey is the most popular amongst Restful web service development. Latest Jersey 2.x version has been developed by Oracle/Glassfish team in accordance with JAX-RS 2.0 specification. Earlier Jersey 1.x version was developed and supported by Oracle/Sun team

Latest Jersey release version is 2.12 see here and look documentation and API for details. We will implement Jersey examples in the following articles based on latest 2.x version

The trick is to set method/class annotated with @Produces & @Consumes with multiple formats in the form of an array-of-string. See example to understand

Here, the rest web service client needs to make sure in setting up required format in the header. Otherwise, first of the multiple formats annotated on top of method/class will be returned. Similarly, if the clients intended to send the request body in the JSON format or XML format, then it’s the responsibility of the client to set those values in the header

Header for,
request body –> Content-Type
response –> accept

Note: Extending/combining the last two applications to support multiple formats APPLICATION_XML and APPLICATION_JSON, etc

Annotation Used

  • @Path (ws.rs.Path)
  • @GET (ws.rs.GET)
  • @POST (ws.rs.POST)
  • @PUT (ws.rs.PUT)
  • @DELETE (ws.rs.DELETE)
  • @PathParam (ws.rs.PathParam)
  • @Consumes (ws.rs.Consumes)
  • @Produces (ws.rs.Produces)
  • MediaType (ws.rs.core.MediaType)

Technology Used

  • Java 1.7
  • Eclipse Luna IDE
  • Jersey-2.12
  • Apache Maven 3.2.1
  • Apache Tomcat 8.0.54
  • Glassfish-4.1

Mavenize or download required jars

Add Jersey-2.12 dependencies to pom.xml

	<properties>
		<jersey.version>2.12</jersey.version>
		<jersey.scope>compile</jersey.scope>
		<compileSource>1.7</compileSource>
		<maven.compiler.target>1.7</maven.compiler.target>
		<maven.compiler.source>1.7</maven.compiler.source>
		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
	</properties>

	<dependencies>
		<!-- Jersey core Servlet 2.x implementation -->
		<dependency>
			<groupId>org.glassfish.jersey.containers</groupId>
			<artifactId>jersey-container-servlet-core</artifactId>
			<version>${jersey.version}</version>
			<scope>${jersey.scope}</scope>
		</dependency>

		<!-- Jersey JSON Jackson (2.x) entity providers support module -->
		<dependency>
			<groupId>org.glassfish.jersey.media</groupId>
			<artifactId>jersey-media-json-jackson</artifactId>
			<version>${jersey.version}</version>
			<scope>${jersey.scope}</scope>
		</dependency>
	</dependencies>

Note: Jackson – high performance parser is included as dependencies for JSON support

Folks who aren’t familiar with Maven concepts or don’t require maven for their project, can download the below jars individually from the central repository or maven repository and include them in the classpath

 

JAXB – Generating java source files from XSD

Steps to generate java-sources from XML Schema Definition (XSD)

  • configure JAXB Maven plugin in pom.xml
  • write well-defined XSD for your service
  • use maven command “mvn generate-sources” to generate java source files

Configure JAXB Maven plugin

<!-- JAXB plugin to generate-sources from XSD -->
<plugin>
	<groupId>org.codehaus.mojo</groupId>
	<artifactId>jaxb2-maven-plugin</artifactId>
	<version>1.6</version>
	<executions>
		<execution>
			<goals>
				<goal>xjc</goal><!-- xjc/generate -->
			</goals>
			<configuration>
				<outputDirectory>${basedir}/generated/java/source</outputDirectory>
				<schemaDirectory>${basedir}/src/main/resources/com/jersey/series/xml/json/service/entities</schemaDirectory>
				<schemaFiles>*.xsd</schemaFiles>
				<schemaLanguage>XMLSCHEMA</schemaLanguage>
				<extension>true</extension>
				<args>
					<arg>-XtoString</arg>
				</args>
				<plugins>
					<plugin>
						<groupId>org.jvnet.jaxb2_commons</groupId>
						<artifactId>jaxb2-basics</artifactId>
						<version>0.6.4</version>
					</plugin>
				</plugins>
			</configuration>
		</execution>
	</executions>
</plugin>

Book.xsd

Below XSD contains two elements with name “BookType” and “BookListType”

  • BookType contains four attributes namely bookId, bookName, author, category
  • BookListType which returns list of BookType
<?xml version="1.0" encoding="UTF-8"?>
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
	targetNamespace="http://benchresources.in/cdm/Book" xmlns:tns="http://benchresources.in/cdm/Book"
	elementFormDefault="qualified">

	<!-- book object with four attributes -->
	<xsd:element name="BookType">
		<xsd:complexType>
			<xsd:sequence>
				<xsd:element name="bookId" type="xsd:int" />
				<xsd:element name="bookName" type="xsd:string" />
				<xsd:element name="author" type="xsd:string" />
				<xsd:element name="category" type="xsd:string" />
			</xsd:sequence>
		</xsd:complexType>
	</xsd:element>

	<!-- an object to contain lists of books referencing above Book object -->
	<xsd:element name="BookListType">
		<xsd:complexType>
			<xsd:sequence>
				<xsd:element ref="tns:BookType" minOccurs="0" maxOccurs="unbounded" />
			</xsd:sequence>
		</xsd:complexType>
	</xsd:element>

</xsd:schema>

Run mvn generate-sources

Look at the generated java source files in the generated folder

BookType.java

package in.benchresources.cdm.book;

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

@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "", propOrder = {
    "bookId",
    "bookName",
    "author",
    "category"
})
@XmlRootElement(name = "BookType")
public class BookType {

    protected int bookId;
    @XmlElement(required = true)
    protected String bookName;
    @XmlElement(required = true)
    protected String author;
    @XmlElement(required = true)
    protected String category;

    public int getBookId() {
        return bookId;
    }
    public void setBookId(int value) {
        this.bookId = value;
    }

    public String getBookName() {
        return bookName;
    }
    public void setBookName(String value) {
        this.bookName = value;
    }

    public String getAuthor() {
        return author;
    }
    public void setAuthor(String value) {
        this.author = value;
    }

    public String getCategory() {
        return category;
    }
    public void setCategory(String value) {
        this.category = value;
    }
}

BookListType.java

package in.benchresources.cdm.book;

import java.util.ArrayList;
import java.util.List;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlType;

@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "", propOrder = {
    "bookType"
})
@XmlRootElement(name = "BookListType")
public class BookListType {

    @XmlElement(name = "BookType")
    protected List<BookType> bookType;

    public List<BookType> getBookType() {
        if (bookType == null) {
            bookType = new ArrayList<BookType>();
        }
        return this.bookType;
    }
}

Directory Structure

Before moving on, let us understand the directory/package structure once you create project in Eclipse IDE

Maven has to follow certain directory structure

  • src/test/java –> test related files, mostly JUnit test cases
  • src/main/java –> create java source files under this folder
  • src/main/resources –> all configuration files placed here
  • src/test/resources –> all test related configuration files placed here
  • Maven Dependencies or Referenced Libraries –> includes jars in the classpath
  • WEB-INF under webapp –> stores web.xml & other configuration files related to web application

Project Structure (Package Explorer view in Eclipse)

1_Jersey-XML-JSON-IO_Project_Structure_In_Eclipse

Jars Libraries Used in the Project (Maven Dependencies)

2_Jersey-JSON-IO_Jars_In_Classpath

 

Web application

For any web application, entry point is web.xml which describes how the incoming http requests are served / processed. Further, it describes about the global-context and local-context param (i.e.; <context-param> & <init-param>) for loading files particular to project requirements & contains respective listener

With this introduction, we will understand how we configured web.xml for Jersey JAX-RS Restful web service

web.xml (the entry point –> under WEB-INF)

This web.xml file describes,

  • Like any JEE web framework register “org.glassfish.jersey.servlet.ServletContainer” with servlet container
  • http requests with URL pattern “/rest/*” will be sent to the registered servlet called “jersey-servlet” i.e.; (org.glassfish.jersey.servlet.ServletContainer)
  • Set <init-param> with <param-name> as “jersey.config.server.provider.packages” and <param-value> describing the qualified package name of the JAX-RS annotated Resource/Provider classes. In this example, “com.jersey.series.xml.json.service”
  • <welcome-file-list> files under this tag is the start-up page

web.xml

<?xml version="1.0" encoding="UTF-8"?>
<web-app version="3.0" xmlns="http://java.sun.com/xml/ns/javaee"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd">

	<display-name>Jersey-XML-JSON-IO</display-name>

	<!-- Jersey Servlet -->
	<servlet>
		<servlet-name>jersey-servlet</servlet-name>
		<servlet-class>org.glassfish.jersey.servlet.ServletContainer</servlet-class>
		<!-- Register resources and providers -->
		<init-param>
			<param-name>jersey.config.server.provider.packages</param-name>
			<param-value>com.jersey.series.xml.json.service</param-value>
		</init-param>
		<load-on-startup>1</load-on-startup>
	</servlet>

	<servlet-mapping>
		<servlet-name>jersey-servlet</servlet-name>
		<url-pattern>/rest/*</url-pattern>
	</servlet-mapping>

	<!-- welcome file -->
	<welcome-file-list>
		<welcome-file>index.html</welcome-file>
	</welcome-file-list>

</web-app>

 

Let’s see coding in action

 

URL Pattern

Http url for any common web application is http://<server>:<port>/<root-context>/<from_here_application_specific_path>

In our example, we are going to deploy the war into Tomcat 8.0 server so our server and port are localhost and 8080 respectively. Context root is the project name i.e.; Jersey-XML-JSON-IO. Initial path for this application is http://localhost:8080/Jersey-XML-JSON-IO

We have configured “/rest/*” as url-pattern for the “jersey-servlet” servlet in web.xml and at class-level path configured is “/bookservice” using @Path annotation. Next respective path for each method annotated with @Path (method-level)

 

Book Service interface

Defines basic CRUD operations for Book Service

NOTE: It’s always a good programming practice to do code-to-interface and have its implementation separately

IBookService.java

package com.jersey.series.xml.json.service;

import in.benchresources.cdm.book.BookListType;
import in.benchresources.cdm.book.BookType;

public interface IBookService {

	// Basic CRUD operations for Book Service

	public String createOrSaveBookInfo(BookType bookType);
	public BookType getBookInfo(int bookId);
	public String updateBookInfo(BookType bookType);
	public String deleteBookInfo(int bookId);
	public BookListType getAllBookInfo();
}

Book Service implementation

Implements above interface

Defines simple CURD operations

  • @POST – create/inserts a new resource (adds new book information)
  • @GET – read/selects internal resource representation based on the bookId
  • @PUT – update/modifies an internal resource representation (modify book)
  • @DELETE – delete/removes a resource (delete book)
  • @GET – retrieves all books (get all books information)

Let’s discuss @Produces, @Consumes and MediaType

@Consumes
Defines which MIME type is consumed by this method. For this example, exposed methods supports both XML & JSON formats i.e.; methods are annotated with @Consumes({MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON})

Note: When Content-Type is not specified in the header, then by default it expects request body in “application/x-www-form-urlencoded”. So, Content-Type needs to be set/sent in the header

@Produces
Defines which MIME type it will produce. For this example, exposed methods produce response in both XML & JSON formats i.e.; methods are annotated with @Produces({MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON})

Note: By default, when invoked it returns the response in XML as it is the first string in the array. So, to get the response in the JSON format then set accept=”application/json” in the header

Most widely used Media Types are

  • APPLICATION_XML,
  • APPLICATION_JSON,
  • TEXT_PLAIN,
  • TEXT_XML,
  • APPLICATION_FORM_URLENCODED,
  • etc

Note: Jersey doesn’t inherit JAX-RS annotations. So we are annotating Resource/Provider classes and then defining qualified package name in web.xml

BookServiceImpl.java

package com.jersey.series.xml.json.service;

import in.benchresources.cdm.book.BookListType;
import in.benchresources.cdm.book.BookType;

import javax.ws.rs.Consumes;
import javax.ws.rs.DELETE;
import javax.ws.rs.GET;
import javax.ws.rs.POST;
import javax.ws.rs.PUT;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;

@Path("/bookservice")
public class BookServiceImpl implements IBookService {

	// Basic CRUD operations for Book Service

	// http://localhost:8080/Jersey-XML-JSON-IO/rest/bookservice/addbook
	@POST
	@Path("addbook")
	@Consumes({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
	@Produces(MediaType.APPLICATION_FORM_URLENCODED)
	public String createOrSaveBookInfo(BookType bookType) {

		// get book information from formal arguments and inserts into database & return bookId (primary_key)
		return "New Book information saved successfully with Book_ID " + bookType.getBookId();
	}

	// http://localhost:8080/Jersey-XML-JSON-IO/rest/bookservice/getbook/10001
	@GET
	@Path("getbook/{id}")
	@Consumes(MediaType.APPLICATION_FORM_URLENCODED)
	@Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
	public BookType getBookInfo(@PathParam("id") int bookId) {

		// retrieve book information based on the id supplied in the formal argument
		BookType bookType = new BookType();
		bookType.setBookId(bookId);
		bookType.setBookName("Fundamental Food Microbiology");
		bookType.setAuthor("Bibek Ray");
		bookType.setCategory("Microbiology");
		return bookType;
	}

	// http://localhost:8080/Jersey-XML-JSON-IO/rest/bookservice/updatebook
	@PUT
	@Path("updatebook")
	@Consumes({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
	@Produces(MediaType.APPLICATION_FORM_URLENCODED)
	public String updateBookInfo(BookType bookType) {

		// update book info & return SUCCESS message
		return "Book information updated successfully";
	}

	// http://localhost:8080/Jersey-XML-JSON-IO/rest/bookservice/deletebook/10001
	@DELETE
	@Path("deletebook/{id}")
	@Consumes(MediaType.APPLICATION_FORM_URLENCODED)
	@Produces(MediaType.APPLICATION_FORM_URLENCODED)
	public String deleteBookInfo(@PathParam("id") int bookId) {

		// delete book info & return SUCCESS message
		return "Book information with Book_ID " + bookId +  " deleted successfully";
	}

	// http://localhost:8080/Jersey-XML-JSON-IO/rest/bookservice/getallbook
	@GET
	@Path("getallbook")
	@Consumes(MediaType.APPLICATION_FORM_URLENCODED)
	@Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
	public BookListType getAllBookInfo() {

		// create a object of type BookListType which takes book objects in its list
		BookListType bookListType = new BookListType();

		BookType bookOne = new BookType();
		bookOne.setBookId(10037);
		bookOne.setBookName("Veterinary Microbiology and Microbial Diseases");
		bookOne.setAuthor("P. J. Quinn, W.J. Donnelly");
		bookOne.setCategory("Microbiology");
		bookListType.getBookType().add(bookOne); // add to bookListType

		BookType bookTwo = new BookType();
		bookTwo.setBookId(10048);
		bookTwo.setBookName("Clinical Microbiology and Infectious Diseases");
		bookTwo.setAuthor("W. John Spicer");
		bookTwo.setCategory("Microbiology");
		bookListType.getBookType().add(bookTwo); // add to bookListType

		return bookListType;
	}
}

 

Tomcat-8.0.12 Deployment

  • Run maven command to build the war: mvn clean install (use command prompt or integrated maven in eclipse IDE
  • Copy(ctrl+c) the war file from the target folder
  • Paste(ctrl+v) it into apache tomcat (webapps folder)
  • Start the tomcat server

 

Glassfish-4.1 Deployment

  • Run maven command to build the war: mvn clean install (use command prompt or integrated maven in eclipse IDE
  • Once you see “BUILD SUCCESS” after running maven command, keep the war file ready to be deployed
  • There are two ways to deploy war file into Glassfish-4.1
    1. Online
    2. Offline
  • Click here to understand above deployments process in detail

Test the service !!

 

Testing

There are many ways to do testing

  • Access html page from web browser
  • Copy the URL of GET service into web browser
  • Advanced REST client from Google Chrome
  • Rest client in Mozilla Firefox Add On
  • Write your own client for example, Java client using improved CloseableHttpClient from Apache
  • JDK’s in-built classes like HttpURLConnection
  • Using Client, WebTarget from core JAX-RS classes javax.ws.rs.client

 

1. Using RestClient from Mozilla Firefox Add-On

 

Every service tested setting up header parameters “accept” & “Content-Type” in the request. First for JSON format and then XML format

First service: @POST (createOrSaveBookInfo())
URL: http://localhost:8080/Jersey-XML-JSON-IO/rest/bookservice/addbook
Request:

{
  "bookId": 12569,
  "bookName": "Molecular Biology of The Gene",
  "author": "James D Watson",
  "category": "Microbiology"
}

Content-Type: application/json
Accept: application/x-www-form-urlencoded
Response: New Book information saved successfully with Book_ID 12569
MF_3_Jersey-XML-JSON-IO_advanced_rest_client_addbook_json

Request:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<BookType xmlns="http://benchresources.in/cdm/Book">
	<bookId>12569</bookId>
	<bookName>Fundamental Food Microbiology</bookName>
	<author>Bibek Ray</author>
	<category>Microbiology</category>
</BookType>

Content-Type: application/xml
Accept: application/x-www-form-urlencoded
Response: New Book information saved successfully with Book_ID 12569
MF_3_Jersey-XML-JSON-IO_advanced_rest_client_addbook_xml

 

Second service: @GET (getBookInfo())
URL: http://localhost:8080/Jersey-XML-JSON-IO/rest/bookservice/getbook/12569
Request: None
Content-Type: application/x-www-form-urlencoded
Accept: application/json
Response:

{
  "bookId": 12569,
  "bookName": "Fundamental Food Microbiology",
  "author": "Bibek Ray",
  "category": "Microbiology"
}

MF_4_Jersey-XML-JSON-IO_advanced_rest_client_getbook_json

Request: None
Content-Type: application/x-www-form-urlencoded
Accept: application/xml
Response:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<BookType xmlns="http://benchresources.in/cdm/Book">
	<bookId>12569</bookId>
	<bookName>Fundamental Food Microbiology</bookName>
	<author>Bibek Ray</author>
	<category>Microbiology</category>
</BookType>

MF_4_Jersey-XML-JSON-IO_advanced_rest_client_getbook_xml

 

Third service: @PUT (updateBookInfo())
URL: http://localhost:8080/Jersey-XML-JSON-IO/rest/bookservice/updatebook
Request:

{
  "bookId": 12569,
  "bookName": "Molecular Biology of The Gene",
  "author": "James D Watson",
  "category": "Microbiology"
}

Content-Type: application/json
Accept: application/x-www-form-urlencoded
Response:  Book information updated successfully
MF_5_Jersey-XML-JSON-IO_advanced_rest_client_updatebook_json

Request:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<BookType xmlns="http://benchresources.in/cdm/Book">
	<bookId>12569</bookId>
	<bookName>Fundamental Food Microbiology</bookName>
	<author>Bibek Ray</author>
	<category>Microbiology</category>
</BookType>

Content-Type: application/xml
Accept: application/x-www-form-urlencoded
Response:  Book information updated successfully
MF_5_Jersey-XML-JSON-IO_advanced_rest_client_updatebook_xml

 

Fourth service: @DELETE (deleteBookInfo())
URL: http://localhost:8080/Jersey-XML-JSON-IO/rest/bookservice/deletebook/12357
Request: None
Content-Type: application/x-www-form-urlencoded
Accept: application/x-www-form-urlencoded
Response: Book information with Book_ID 12357 deleted successfully
MF_6_Jersey-XML-JSON-IO_advanced_rest_client_deletebook

 

Fifth service: @GET (getAllBookInfo())
URL: http://localhost:8080/Jersey-XML-JSON-IO/rest/bookservice/getallbook
Request: None
Content-Type: application/x-www-form-urlencoded
Accept: application/json
Response:

{
  "BookType": [
    {
      "bookId": 10037,
      "bookName": "Veterinary Microbiology and Microbial Diseases",
      "author": "P. J. Quinn, W.J. Donnelly",
      "category": "Microbiology"
    },
    {
      "bookId": 10048,
      "bookName": "Clinical Microbiology and Infectious Diseases",
      "author": "W. John Spicer",
      "category": "Microbiology"
    }
  ]
}

MF_7_Jersey-XML-JSON-IO_advanced_rest_client_getallbook_json

Request: None
Content-Type: application/x-www-form-urlencoded
Accept: application/xml
Response:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<BookListType xmlns="http://benchresources.in/cdm/Book">
	<BookType>
		<bookId>10037</bookId>
		<bookName>Veterinary Microbiology and Microbial Diseases</bookName>
		<author>P. J. Quinn, W.J. Donnelly</author>
		<category>Microbiology</category>
	</BookType>
	<BookType>
		<bookId>10048</bookId>
		<bookName>Clinical Microbiology and Infectious Diseases</bookName>
		<author>W. John Spicer</author>
		<category>Microbiology</category>
	</BookType>
</BookListType>

MF_7_Jersey-XML-JSON-IO_advanced_rest_client_getallbook_xml

 

 2. Java client

Uses Client, ClientBuilder, WebTarget and Response classes from core JAX-RS package javax.ws.rs.client for invoking Restful web service

Note: Commented lines will help out us to try (set) various http request header parameters

TestBookService.java

package test.jersey.series.xml.json.service;

import javax.ws.rs.client.Client;
import javax.ws.rs.client.ClientBuilder;
import javax.ws.rs.client.Entity;
import javax.ws.rs.client.Invocation;
import javax.ws.rs.client.Invocation.Builder;
import javax.ws.rs.client.WebTarget;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;

import org.glassfish.jersey.client.ClientConfig;

public class TestBookService {

	public static void main(String[] args) {

		// setting & invoking first service getBook/10001
		System.out.println("Invoking and executing getBook service for book id 25311");
		String httpGetURL = "http://localhost:8080/Jersey-XML-JSON-IO/rest/bookservice/getbook/25311";
		String responseStringGet = testBookServiceForGetRequest(httpGetURL);
		System.out.println("GET >> Response String : " + responseStringGet);

		// setting & invoking second service addBook with XML request
		System.out.println("\n\nInvoking and executing addBook service with request XML");
		String httpPostURL = "http://localhost:8080/Jersey-XML-JSON-IO/rest/bookservice/addbook";
		String requestString = "{"
				+ 					" \"bookId\": 21156, "
				+ 					" \"bookName\": \"Clinical Veterinary Microbiology\","
				+ 					" \"author\": \"Patrick Quinn\","
				+					" \"category\": \"Microbiology\""
				+				"}";
		String responseStringPost = testBookServiceForPostRequest(httpPostURL, requestString);
		System.out.println("POST >> Response String : " + responseStringPost);
	}

	/**
	 *
	 * @param httpURL
	 * @return
	 */
	public static String testBookServiceForGetRequest(String httpURL){

		// local variables
		ClientConfig clientConfig = null;
		Client client = null;
		WebTarget webTarget = null;
		Invocation.Builder invocationBuilder = null;
		Response response = null;
		int responseCode;
		String responseMessageFromServer = null;
		String responseString = null;

		try{
			// invoke service after setting necessary parameters
			clientConfig = new ClientConfig();
			client =  ClientBuilder.newClient(clientConfig);
			//			client.property("Content-Type", MediaType.APPLICATION_FORM_URLENCODED);
			//			client.property("accept", MediaType.APPLICATION_XML);
			webTarget = client.target(httpURL);

			// invoke service
			invocationBuilder = webTarget.request(MediaType.APPLICATION_FORM_URLENCODED).accept(MediaType.APPLICATION_XML);
			//			invocationBuilder.header("some-header", "header-value");
			response = invocationBuilder.get();

			// get response code
			responseCode = response.getStatus();
			System.out.println("Response code: " + responseCode);

			if (response.getStatus() != 200) {
				throw new RuntimeException("Failed with HTTP error code : " + responseCode);
			}

			// get response message
			responseMessageFromServer = response.getStatusInfo().getReasonPhrase();
			System.out.println("ResponseMessageFromServer: " + responseMessageFromServer);

			// get response string
			responseString = response.readEntity(String.class);
		}
		catch(Exception ex) {
			ex.printStackTrace();
		}
		finally{
			// release resources, if any
			response.close();
			client.close();
		}
		return responseString;
	}

	/**
	 *
	 * @param httpURL
	 * @param requestString
	 * @return
	 */
	public static String testBookServiceForPostRequest(String httpURL, String requestString) {

		// local variables
		ClientConfig clientConfig = null;
		Client client = null;
		WebTarget webTarget = null;
		Builder builder = null;
		Response response = null;
		int responseCode;
		String responseMessageFromServer = null;
		String responseString = null;

		try{
			// invoke service after setting necessary parameters
			clientConfig = new ClientConfig();
			client =  ClientBuilder.newClient(clientConfig);
			//			client.property("Content-Type", MediaType.APPLICATION_FORM_URLENCODED);
			//			client.property("accept", MediaType.APPLICATION_JSON);
			webTarget = client.target(httpURL);

			// invoke service
			builder = webTarget.request(MediaType.APPLICATION_FORM_URLENCODED).accept(MediaType.APPLICATION_JSON);
			response = builder.post(Entity.entity(requestString, MediaType.APPLICATION_JSON));

			// get response code
			responseCode = response.getStatus();
			System.out.println("Response code: " + responseCode);

			if (response.getStatus() != 200) {
				throw new RuntimeException("Failed with HTTP error code : " + responseCode);
			}

			// get response message
			responseMessageFromServer = response.getStatusInfo().getReasonPhrase();
			System.out.println("ResponseMessageFromServer: " + responseMessageFromServer);

			// get response string
			responseString = response.readEntity(String.class);
		}
		catch(Exception ex) {
			ex.printStackTrace();
		}
		finally{
			// release resources, if any
			response.close();
			client.close();
		}
		return responseString;
	}
}

Output in console

Invoking and executing getBook service for book id 25311
Response code: 200
ResponseMessageFromServer: OK
GET >> Response String : 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<BookType xmlns="http://benchresources.in/cdm/Book">
	<bookId>25311</bookId>
	<bookName>Fundamental Food Microbiology</bookName>
	<author>Bibek Ray</author>
	<category>Microbiology</category>
</BookType>


Invoking and executing addBook service with request XML
Response code: 200
ResponseMessageFromServer: OK
POST >> Response String : New Book information saved successfully with Book_ID 21156

Conclusion: With this implementation, we can say that web service request/response can be exchanged in different formats depending upon the business requirements

Download project

Jersey-2x-XML-JSON-IO(13kB)

Happy Coding !!
Happy Learning !!

Jersey 2.x web service + Integrating with Spring framework using annotation
Jersey 2.x web service using JAXB + JSON example

Related posts:

  1. Jersey 2.x web service using JAXB + XML example
  2. Jersey 2.x web service using JAXB + JSON example
  3. Apache CXF: JAX-RS Restful web service using both (JSON + XML) example
  4. RestEasy: JAX-RS web service using both (JSON + XML) example