Skip to main content

Jersey (JAX-RS) JSON HTTP entity payload processing example

JSON (JavaScript Object Notation) is the most used structured data interchange format of the current generation. It is very common for REST clients to use it for data exchange. Several web client frameworks (e.g. AngularJS) natively handle JSON requests and responses. Jersey (JAX-RS) JSON support is very effective and easy to use.

Usually, clients send and receive JSON data as HTTP entity payload with Content-Type header set with value application/JSON.

 JSON HTTP entity payload handling jersey example

In this tutorial we will learn:

  1. Consuming / Reading JSON entity payload to Java Object.
  2. Producing / Writing JSON entity payload from Java Object.
  3. Different JSON processing framework support in Jersey.

Getting started

Jersey inbuilt support three ways to handle JSON data.

  1. POJO based JSON binding - Most widely used approach.
  2. JAXB based JSON binding - It provides XML read and writes capability straightaway.
  3. Low-level JSON read and write

Jersey supports JSON entity provider for these JSON libraries out of the box:

  1. MOXy - Jersey preferred and auto-configure it (if MOXy is on class-path).
  2. Java API for JSON Processing
  3. Jackson - Spring Boot auto-configuration register Jackson as JSON entity provider for Jersey. Hence Jackson used in Spring Boot Jersey application by default.
  4. Jettison

Note: Jettison is not actively developed. We should avoid it.

In this tutorial, we will work on the Movie entity and use POJO-based JSON binding. An example JSON:

{
  "id": 1,
  "title": "The Shawshank Redemption",
  "releaseYear": 1994,
  "imdbRating": 9.3,
  "actors": [
    {
      "id": 200,
      "name": "Tim Robbins"
    },
    {
      "id": 201,
      "name": "Morgan Freeman"
    }
  ]
}

We will create two Java classes to represent Actor and Movie entities.

File: org/geekmj/domain/Actor.java

package org.geekmj.domain;

public class Actor {
	private Long id;
	private String name;

	public Long getId() {
		return id;
	}

	public void setId(Long id) {
		this.id = id;
	}

	public String getName() {
		return name;
	}

	public void setName(String name) {
		this.name = name;
	}

}

File: org/geekmj/domain/Movie.java

package org.geekmj.domain;

import java.util.List;

public class Movie {
	private Long id;
	private String title;
	private Integer releaseYear;
	private Float imdbRating;
	private List<Actor> actors;

	public Long getId() {
		return id;
	}

	public void setId(Long id) {
		this.id = id;
	}

	public String getTitle() {
		return title;
	}

	public void setTitle(String title) {
		this.title = title;
	}

	public Integer getReleaseYear() {
		return releaseYear;
	}

	public void setReleaseYear(Integer releaseYear) {
		this.releaseYear = releaseYear;
	}

	public Float getImdbRating() {
		return imdbRating;
	}

	public void setImdbRating(Float imdbRating) {
		this.imdbRating = imdbRating;
	}

	public List<Actor> getActors() {
		return actors;
	}

	public void setActors(List<Actor> actors) {
		this.actors = actors;
	}
}

Jersey (JAX-RS) JSON payload read and write resource

File: org/geekmj/resource/JsonPayloadResource.java

package org.geekmj.resource;

import javax.ws.rs.Consumes;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;

import org.geekmj.domain.Movie;

@Path("/json-payload")
public class JsonPayloadResource {

	/*
	 * This Resource method takes HTTP entity pay-load in JSON format. 
	 * This Resource method gives back HTTP entity pay-load in JSON format. 
	 * Jackson is the default JSON Entity provider for Spring Boot + Jersey application.
	 * It convert JSON in the pay-load to Java Object. 
	 * It also convert Java Object to JSON.
	*/

	@POST
	@Path("/movie")
	@Produces(MediaType.APPLICATION_JSON)
	@Consumes(MediaType.APPLICATION_JSON)
	public Movie takeAndGiveMovie(final Movie movie) {

		System.out.println("Movie Title " + movie.getTitle());
		
		/* Appending (Checked) to title, It will show in response */
		movie.setTitle(movie.getTitle().concat("(Checked)"));
		
		return movie;

	}
}

In the above source code, the Jersey Resource method takeAndGiveMovie is mapped to POST URI /json-payload/movie.

Jackson is the default JSON Entity provider for Spring Boot + Jersey application. It converts JSON HTTP entity payload into Java Object, which is the Movie class object in our example. It also converts Movie Object into JSON which is returned as an HTTP response payload.

Note: We have appended String (checked) in the movie title and it will show in response.

Test this API using Postman

URI : https://localhost:8080/json-payload/movie

Request Header : Content-Type = application/json

JSON Payload Request Data in Postman JSON Payload Request Data in Postman
JSON Payload Response Data Postman

References

  1. Learn about JSON.
  2. Learn about HTTP payload versus form data.
  3. Learn about HTTP entity.
  4. Learn about Java API for JSON Processing.
  5. Learn about reference implementation of Java API for JSON Processing.
  6. Learn about MOXy.
  7. Learn about Jackson.
  8. Learn about Jettison.

Comments

Popular posts from this blog

Working with request header in Jersey (JAX-RS) guide

In the  previous post , we talked about, how to get parameters and their values from the request query string. In this guide learn how to get request header values in Jersey (JAX-RS) based application. We had tested or used the following tools and technologies in this project: Jersey (v 2.21) Gradle Build System (v 2.9) Spring Boot (v 1.3) Java (v 1.8) Eclipse IDE This is a part of  Jersey (JAX-RS) Restful Web Services Development Guides series. Please read Jersey + Spring Boot getting started guide . Gradle Build File We are using Gradle for our build and dependency management (Using Maven rather than Gradle is a very trivial task). File: build.gradle buildscript { ext { springBootVersion = '1.3.0.RELEASE' } repositories { mavenCentral() } dependencies { classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}") } } apply plugin: 'java' apply plugin: 'eclipse' a

Ajax Cross Domain Resource Access Using jQuery

Some time back in our project we faced a problem while making an Ajax call using jQuery. Chrome Browser console had given some weird error message like below when we try to access one of our web pages: When we try to access the same web page in the Firefox browser, it doesn't give any error in the console but some parsing error occurred. In our case, we were accessing XML as an Ajax request resource. I was curious to check if the non-XML cross-domain resource was successfully loading or not. But finally, I realized that it is not going through. jersey-spring-boot-quick-starter-guide In our Ajax call, requesting domain was not the same as the requested URL domain. $.ajax({ url: "https://10.11.2.171:81/xxxxxx/xxxxxxx.xml" , type : "get" , success: function (response) { alert( "Load was performed." ); }, error : function (xhr, status) {

FastAPI first shot

Setup on my Mac (Macbook Pro 15 inch Retina, Mid 2014) Prerequisite Python 3.6+ (I used 3.7.x. I recently reinstalled OS after cleaning up disk, where stock Python 2.7 was available. I installed Pyenv and then used it to install 3.7.x). I already had a git repo initialized at Github for this project. I checked that out. I use this approach to keep all the source code safe or at a specific place 😀. I set the Python version in .python-version file. I also initialize the virtual environment using pyenv in venv folder. I started the virtual environment. FastAPI specific dependencies setup Now I started with basic pip commands to install dependency for the project. I saved dependencies in requirements.txt  the file. Minimal viable code to spin an API Server FastAPI is as cool as NodeJS or Go Lang (?) to demonstrate the ability to spin an API endpoint up and running in no time. I had the same feeling for the Flask too, which was also super cool. app/main.py: from typing i