Apache HttpClient GET HTTP Request Example

---

< Previous Next >

Apache HttpClient Tutorial

---

Introduction

Apache HttpClient is a powerful and flexible library for handling HTTP requests in Java. It provides a wide range of capabilities, including support for different HTTP methods, connection management, cookie handling, and more. Whether you are interacting with RESTful APIs, downloading web content, or automating web tasks, Apache HttpClient simplifies these operations with a straightforward and robust API. This tutorial will demonstrate how to make a GET HTTP request using Apache HttpClient, showcasing its ease of use and versatility.

Understanding the HTTP GET Method

The HTTP GET method is used to request data from a specified resource. GET requests are typically used to retrieve data from a server, such as a web page, an image, or data from a RESTful API. The main characteristics of a GET request include:

1. Read-Only: GET requests are used to retrieve data without making any changes to the resource.
2. Safe: Making a GET request should not have any side effects on the server.
3. Idempotent: Multiple identical GET requests should have the same effect as a single request.
4. Cacheable: Responses to GET requests can be cached by browsers or proxies to improve performance.

In this example, we will make a GET request to the JSONPlaceholder API, a free online REST API that you can use for testing and prototyping. The API provides various endpoints to simulate typical RESTful API responses.

JSONPlaceholder API

The JSONPlaceholder API provides fake online RESTful endpoints for testing and prototyping. We will use the /posts/1 endpoint to retrieve a single post. The URL for this endpoint is:

https://jsonplaceholder.typicode.com/posts/1

Maven Dependencies

To use Apache HttpClient, you need to add the following dependency to your pom.xml file:

<!-- https://mvnrepository.com/artifact/org.apache.httpcomponents.client5/httpclient5 -->
<dependency>
    <groupId>org.apache.httpcomponents.client5</groupId>
    <artifactId>httpclient5</artifactId>
    <version>5.3</version>
</dependency>

Example Scenario

We will create a simple Java class that sends a GET request to the JSONPlaceholder API and prints the response.

Java Class for Sending GET Request

Create a class named HttpClientExample with the following code:

import org.apache.hc.client5.http.classic.methods.HttpGet;
import org.apache.hc.client5.http.classic.methods.CloseableHttpResponse;
import org.apache.hc.client5.http.impl.classic.CloseableHttpClient;
import org.apache.hc.client5.http.impl.classic.HttpClients;
import org.apache.hc.core5.http.io.entity.EntityUtils;

public class HttpClientExample {

    public static void main(String[] args) {
        String url = "https://jsonplaceholder.typicode.com/posts/1";
        
        // Create HttpClient
        try (CloseableHttpClient httpClient = HttpClients.createDefault()) {
            
            // Create HttpGet request
            HttpGet request = new HttpGet(url);
            
            // Execute the request
            try (CloseableHttpResponse response = httpClient.execute(request)) {
                
                // Get HttpResponse Status
                System.out.println("Response Code: " + response.getCode());
                
                // Get HttpResponse Content
                String content = EntityUtils.toString(response.getEntity());
                System.out.println("Response Content: \n" + content);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

Explanation

1. Adding Maven Dependencies:

   • The org.apache.httpcomponents.client5:httpclient5 dependency provides the classes needed to create and execute HTTP requests using Apache HttpClient.

2. Creating HttpClient:

   • CloseableHttpClient httpClient = HttpClients.createDefault(); creates an instance of CloseableHttpClient using the default configuration.

3. Creating HttpGet Request:

   • HttpGet request = new HttpGet(url); creates an HttpGet request for the specified URL.

4. Executing the Request:

   • try (CloseableHttpResponse response = httpClient.execute(request)) { ... } executes the GET request and retrieves the response.

5. Getting HttpResponse Status:

   • System.out.println("Response Code: " + response.getCode()); prints the status code of the HTTP response.

6. Getting HttpResponse Content:

   • String content = EntityUtils.toString(response.getEntity()); converts the response entity to a string and prints the content.

Running the Example

To run the example, simply execute the HttpClientExample class. You should see the status code and the response content printed in the console.

Example Output

Response Code: 200
Response Content: 
{
  "userId": 1,
  "id": 1,
  "title": "sunt aut facere repellat provident occaecati excepturi optio reprehenderit",
  "body": "quia et suscipit\nsuscipit...
}

Additional Configuration

Setting Custom Headers

You can set custom headers for the GET request by using the setHeader method on the HttpGet object.

request.setHeader("User-Agent", "Mozilla/5.0");

Handling Redirects

By default, Apache HttpClient handles redirects automatically. You can customize this behavior by using a custom HttpClientBuilder.

CloseableHttpClient httpClient = HttpClients.custom()
    .setRedirectStrategy(new DefaultRedirectStrategy() {
        @Override
        protected boolean isRedirectable(String method) {
            return true;
        }
    })
    .build();

Setting Timeouts

You can set connection and socket timeouts by using RequestConfig.

RequestConfig requestConfig = RequestConfig.custom()
    .setConnectTimeout(5000)
    .setSocketTimeout(5000)
    .build();

HttpGet request = new HttpGet(url);
request.setConfig(requestConfig);

Conclusion

Using Apache HttpClient to make a GET HTTP request is straightforward and flexible. By following this tutorial, you should now be able to create and execute GET requests, handle responses, and customize various aspects of the HTTP request and response process. Apache HttpClient provides a comprehensive set of features that make it an excellent choice for handling HTTP operations in Java applications. The JSONPlaceholder API serves as a practical and convenient source for testing and prototyping your HTTP requests.

---

< Previous Next >

Apache HttpClient Tutorial

---