Skip to main content

JAX-rs client with connection and response timeout using jersey

In this tutorial we will learn how to use JAX-rs API with jersey client API to communicate with Restful service.

Maven dependencies

I have created this example using the Spring boot application, so I need only starter dependencies which are listed as below.
  <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-jersey</artifactId>
  </dependency>

  <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-web</artifactId>
  </dependency>
If you are not using spring application then you need to add below dependencies in your pom.
 <dependency>
    <groupId>org.glassfish.jersey.core</groupId>
    <artifactId>jersey-client</dependency>
 </dependency>

 <dependency>
    <groupId>org.glassfish.jersey.inject</groupId>
    <artifactId>jersey-hk2</dependency>
 </dependency>

 <dependency>
    <groupId>org.glassfish.jersey.media</groupId>
    <artifactId>jersey-media-json-jackson</dependency>
    <scope>runtime</scope>
 </dependency>

 <dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-annotaions</dependency>
 </dependency>

 <dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</dependency>
 </dependency>

 <dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-core</dependency>
 </dependency>

 <dependency>
    <groupId>com.fasterxml.jackson.module</groupId>
    <artifactId>jackson-module-jaxb-annotaions</dependency>
 </dependency>

Rest service code

For the demonstrations purpose I have created a simple service which takes the input as path variable and returns a text as response.
@RestController
@RequestMapping("/hello")
public class HelloService {

 @RequestMapping("/welcome/{name}")
 @GET
 @Produces(MediaType.APPLICATION_JSON)
 public String welcome(@PathVariable("name") String name) {
    return "Welcome "+name;
 }
}

Rest client code

Below is the client code which makes call to rest service and prints the response to console. It also specifies connectivity and read timeout which results in timeout exception if it is not able to connect in given milliseconds or it is not able to get the response in specified milliseconds.
//Annotated as component to be managed by the spring context
@Component
public class HelloClient {

 //this annotation guarantees the invocation of this method 
 //once the spring boot application is up and running 
 @EventListener(ApplicationReadyEvent.class)
 public void clientHello() {
    Client client = ClientBuilder.newClient();

    //below code sets timeout for server connectivity 
    client.property(ClientProperties.CONNECT_TIMEOUT, 40000);

    //setting timeout for service response
    client.property(ClientProperties.READ_TIMEOUT, 40000);

    Response resp = client.target("http://localhost:8080/hello/")
        .path("welcome")
        .path("Test user")
        .request(MediaType.APPLICATION_JSON).get();

    StatusType status = resp.getStatusInfo();

    System.out.println("Response status code: "+status.getStatusCode());
    System.out.println("Response status: "+status.getReasonPhrase());
    System.out.println(resp.readEntity(String.class));
 }
}
Below is the output of above client.

Response status code: 200
Response status: OK
Welcome Test user

Comments

Popular Posts

Setting up kerberos in Mac OS X

Kerberos in MAC OS X Kerberos authentication allows the computers in same domain network to authenticate certain services with prompting the user for credentials. MAC OS X comes with Heimdal Kerberos which is an alternate implementation of the kerberos and uses LDAP as identity management database. Here we are going to learn how to setup a kerberos on MAC OS X which we will configure latter in our application. Installing Kerberos In MAC we can use Homebrew for installing any software package. Homebrew makes it very easy to install the kerberos by just executing a simple command as given below. brew install krb5 Once installation is complete, we need to set the below export commands in user's profile which will make the kerberos utility commands and compiler available to execute from anywhere. Open user's bash profile: vi ~/.bash_profile Add below lines: export PATH=/usr/local/opt/krb5/bin:$PATH export PATH=/usr/local/opt/krb5/sbin:$PATH export LDFLAGS=&

SpringBoot - @ConditionalOnProperty example for conditional bean initialization

@ConditionalOnProperty annotation is used to check if specified property available in the environment or it matches some specific value so it can control the execution of some part of code like bean creation. It may be useful in many cases for example enable/disable service if specific property is available. Below are the attributes which can be used for property check. havingValue - Provide the value which need to check against specified property otherwise it will check that value should not be false. matchIfMissing - If true it will match the condition and execute the annotated code when property itself is not available in environment. name - Name of the property to be tested. If you want to test single property then you can directly put the property name as string like "property.name" and if you have multiple properties to test then you can put the names like {"prop.name1","prop.name2"} prefix - It can be use when you want to apply some prefix to

Why HashMap key should be immutable in java

HashMap is used to store the data in key, value pair where key is unique and value can be store or retrieve using the key. Any class can be a candidate for the map key if it follows below rules. 1. Overrides hashcode() and equals() method.   Map stores the data using hashcode() and equals() method from key. To store a value against a given key, map first calls key's hashcode() and then uses it to calculate the index position in backed array by applying some hashing function. For each index position it has a bucket which is a LinkedList and changed to Node from java 8. Then it will iterate through all the element and will check the equality with key by calling it's equals() method if a match is found, it will update the value with the new value otherwise it will add the new entry with given key and value. In the same way it check for the existing key when get() is called. If it finds a match for given key in the bucket with given hashcode(), it will return the value other

jaxb2-maven-plugin to generate java code from XSD schema

In this tutorial I will show how to generate the Java source code from XSD schema. I will use jaxb2-maven-plugin to generate the code using XSD file which will be declared in pom.xml to make it part of build, so when maven build is executed it will generate the java code using XSD. Class generation can be controlled in plugin configuration. Maven changes (pom.xml) Include below plugin in your pom.xml. Here we have done some configuration under configuration section as given below. schemaDirectory : This is the directory where I keep my schema (XSD file). outputDirectory : This is the java source location where I want to generate the Java files. If it is not given then by default it will be generate inside target folder. clearOutputDir : If this property is true then it will generate the classes on each build otherwise it will generate only if output directory is empty. <plugin> <groupId>org.codehaus.mojo</groupId> <artifactId>jaxb2-maven-plugin</art