How to create a JAX-RS Jersey client application for consuming a REST service

In this blog post, I will be demonstrating how you can create a JAX-RS client application using Jersey JAX-RS client implementation.

What is JAX-RS and Jersey Client API?

JAX-RS is the Java specification for Restful web services. It is just a specification, it does not provide an implementation. Jersey is the reference implementation of JAX-RS specification. There are other implementations of JAX-RS like RESTEasy, etc  The first release of JAX-RS was JAX-RS 1.0. It did not provide a client API. So vendors like Jersey, RESTEasy provided their own client APIs. JAX-RS 2.0 (which is the latest release of JAX-RS) provides a client API. The latest release of Jersey (2.25.1) implements this client API. So in addition to its proprietary client API, Jersey also implements the JAX-RS client API.  While implementing a REST client that uses Jersey, it is better to use the JAX-RS specific client implementation and not Jersey’s client API. So even if the JAX-RS vendor is changed from Jersey to something else like RESTEasy, the code will still work.

How to create a JAX-RS client

Project creation and configuration

Step 1 – Create a new Java Project in Eclipse (Refer to this blog post). You should see a project as follows:

Step 2 – Convert to a Maven project.

 

Step 2a – Right Click on Project –> Configure –> Convert to Maven Project

 

Step 2b – Click on finish

 

Step 3 – Add Maven dependencies to POM file.

Add the following:

  <dependencies>   <dependency>    <groupId>javax.ws.rs</groupId>    <artifactId>javax.ws.rs-api</artifactId>    <version>2.0.1</version></dependency>   <dependency>    <groupId>org.glassfish.jersey.core</groupId>    <artifactId>jersey-client</artifactId>    <version>2.25.1</version></dependency>  </dependencies>

So your POM file will look as follows:

Write Code

Create a new Java class and write the following code:

public class JaxRsClientDemo {    static String URI = "http://localhost:8080/RestJAXRSJerseyDemo/learnjava/myservice";  public static void main(String args[]) {  Client client = ClientBuilder.newClient();  WebTarget target = client.target(URI);  Invocation.Builder invocationBuilder = target.request();  Response response = invocationBuilder.get();  String responseStr = response.readEntity(String.class);  System.out.println("Server Response:"+responseStr);}

 

Test code

Step 1 – Ensure that a REST service is running. Refer to this blog post.

Step 2 – Run the JaxRsClientDemo as a java program. This will produce the following output on the console:

You can download the source code for this at the GitHub repository here.

 

 

Comments

Post a Comment

Popular posts from this blog

Java 8 DoubleFunction Example

In this blog post, I will be explaining how the Java 8 functional interface DoubleFunction works. To know more about functional interfaces, you can refer  this  blog post. Edit The   DoubleFunction interface provides a method called apply . It accepts a single parameter of double data type. It returns a result of any data type. So it basically applies the logic in the apply method to the input parameter and returns the result. The DoubleFunction interface is a specialization of the Function interface. While the Function interface accepts any data type, the DoubleFunction interface accepts a long value. To see an example of the Function interface, refer to  this  blog post. DoubleFunction Interface that returns an Integer Consider the following code snippet: DoubleFunction<Integer> integerRetriever = input -> new Double(input).intValue();Double input = 4.8;System.out.println("Integer Value "+integerRetriever.apply(input) );   Here, we have written a   Doubl...
Read more

How to convert a List to a Set

In this blog post ,I will be showing you how you can convert a List to a Set. Consider the following code snippet: public class ListToSetDemo {public static void main(String[] args) {List<Integer> list = Arrays.asList(5,3,11,15,9);//Method 1Set<Integer> set = new HashSet<Integer>(list);System.out.println("Set is "+set);//method 2Set<Integer> set2 = new HashSet<Integer>();set2.addAll(list);System.out.println("Set is "+set2);}} This code demonstrates two ways to convert a List to a Set. Method 1 Here, we are creating a new HashSet . We are invoking the constructor that accepts a Collection object. Here, we are passing in the input list to this constructor.   Method 2 Here again, we are creating a new HashSet . However, we are using the default constructor. We are then invoking the addAll method and passing in the input list.   When you run this code, it will print the following output: Set is [3, 5, 9, 11, 15]Set is [3, 5, 9, 1...
Read more

ArrayList Vs LinkedList

In this blog post, I will be comparing the ArrayList and LinkedList classes. I will be explaining how they are similar, how they are different and when you should use which.   Similarities: Both are Collections and implement the List interface Both are used to store a dynamic number of elements (Primitive or Object type) Differences ArrayList uses an array data structure internally to store the data. A LinkedList on the other hand, uses a doubly linked list internally as the data structure to store data. If you are not familiar with what a Linked List data structure is, you can refer this link . When you need to insert or delete data from the bottom of the List, an ArrayList is faster. If you need to insert or delete an element from the middle of the list,  a LinkedList is faster. An ArrayList  uses an array to store the data internally. So when you insert or delete an element from the bottom of the list, this does not affect the array. However if you insert or delete an element...
Read more