Jersey 2 Restful (JAX-RS) Tutorial

By admin | April 11, 2017 | Updated : December 07, 2017 jersey, rest, 1 Comments

Jersey 2 Restful(JAX-RS) Tutorial explains step by step details of Creating / Developing Java rest Web services using Jersey and Eclipse

JAX-RS is Java API for RESTful Webservices which is very rely upon Representational State Transfer model, you can view JAX-RS specification

Jersey framework is more than the JAX-RS Reference Implementation. Jersey provides it’s own API that extend the JAX-RS toolkit with additional features and utilities to further simplify RESTful service and client development. Jersey also exposes numerous extension SPIs so that developers may extend Jersey to best suit their needs

Reference -> https://jersey.java.net

You can see the below example, which is demonstrating How to create a Restful service using Jersey 2

Required Libraries

You need to download

Following jar must be in classpath

hk2-api-2.4.0-b06.jar
hk2-locator-2.4.0-b06.jar
hk2-utils-2.4.0-b06.jar
jackson-annotations-2.4.6.jar
jackson-core-2.4.6.jar
jackson-databind-2.4.6.jar
jackson-jaxrs-base-2.3.2.jar
jackson-jaxrs-json-provider-2.3.2.jar
jackson-module-jaxb-annotations-2.3.2.jar
javax.annotation-api-1.2.jar
javax.inject-2.4.0-b25.jar
javax.ws.rs-api-2.0.1.jar
jersey-client.jar
jersey-common.jar
jersey-container-servlet-core.jar
jersey-container-servlet.jar
jersey-guava-2.19.jar
jersey-media-json-jackson-2.14.jar
jersey-server.jar
validation-api-1.1.0.Final.jar

Jersey 2 Restful Tutorial

I am creating a sample restful service project that pass Student object and return with some changes on that object. The service is using simple POJO (Plain Old Java Object) bean.

Firstly create a Dynamic Web Project (File->New->Dynamic Web Project) named "Jersey2Example" according to following screenshot
Create CXF Project
Jersey Restful Tutorial

Create a Student Object

package com.entity;

public class Student {
private String name;

public String getName() {
return name;
}

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

}

Create a Controller

Here StudentController will defines which methods of restful service, to be invoked by the client

Here we are using one example showing with GET method & another with POST method

GET---> Calling this method will not result any changes to the server

POST---> Calling this method will result changes to the server, This have more secure than GET method

package com.controller;

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

import com.entity.Student;

@Path("Services")
public class StudentController {

@POST
@Path("/changeName")
@Produces(MediaType.APPLICATION_JSON)
public Student changeName(Student student) {
student.setName("HELLO " + student.getName());
return student;
}

@GET
@Path("/getName")
@Produces(MediaType.APPLICATION_JSON)
public Student getName() {
Student student = new Student();
student.setName("Rockey");
return student;
}
}

@Consumes annotation specifies, the request is coming from the client

you can specify the Mime type as @Consumes("application/xml"), if the request is in xml format

@Produces annotation specifies, the response is going to the client

you can specify the Mime type as @Produces ("application/xml"), if the response need to be in xml format

Create ApplicationConfig

Here we register the StudentController class, so that jersey will invoke properly

package com.config;

import org.glassfish.jersey.server.ResourceConfig;

import com.controller.StudentController;

public class ApplicationConfig extends ResourceConfig {

public ApplicationConfig() {
register(StudentController.class);
}
}

web.xml

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns="http://xmlns.jcp.org/xml/ns/javaee" 
xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee 
http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd" id="WebApp_ID" version="3.1">
  <display-name>Jersey2Example</display-name>
  <servlet>
    <servlet-name>jersey</servlet-name>
    <servlet-class>org.glassfish.jersey.servlet.ServletContainer</servlet-class>
     <!-- specify the application confiuration-->
     <init-param>
      <param-name>javax.ws.rs.Application</param-name>
      <param-value>com.config.ApplicationConfig</param-value>
    </init-param>
    <load-on-startup>1</load-on-startup>
  </servlet>
  <servlet-mapping>
    <servlet-name>jersey</servlet-name>
    <url-pattern>/rest/*</url-pattern>
  </servlet-mapping>
</web-app>

Publishing Jersey 2 Restful Service

Run Jersey Restful On Tomcat

Jersey 2 Output

Jersey 2 response

Note

you can also see the examples of using GET and POST method Restful Client

You might also like following tutorials :

1 Responses to "Jersey 2 Restful (JAX-RS) Tutorial"

Gangadhar 2018-01-23 04:14:03.0
```
good
```

Your email address will not be published. Required fields are marked *

Name*

Email*

Website