How do I follow redirects using Java 11 HttpClient?

Java 11 introduced a new HttpClient API in the java.net.http package, making it much easier and more flexible to handle HTTP requests and responses. By default, the HttpClient does not follow redirects automatically. However, you can configure it to follow redirects if required.

Here’s how you can configure the HttpClient to follow redirects:

Code Example

package org.kodejava.net.http;

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.http.HttpClient.Redirect;

public class FollowRedirectExample {

   public static void main(String[] args) {
      try {
         // Create the HttpClient and configure it to follow redirects
         HttpResponse<String> response;
         try (HttpClient httpClient = HttpClient.newBuilder()
                 .followRedirects(Redirect.ALWAYS) // Configures the client to always follow redirects
                 .build()) {

            // Create an HttpRequest
            HttpRequest request = HttpRequest.newBuilder()
                    .uri(URI.create("https://httpbin.org/redirect-to?url=https://example.com")) // URL that redirects
                    .GET() // HTTP GET request
                    .build();

            // Send the request and get the response
            response = httpClient.send(request, HttpResponse.BodyHandlers.ofString());
         }

         // Print the status code and body
         System.out.println("Response Status Code: " + response.statusCode());
         System.out.println("Response Body: " + response.body());
      } catch (Exception e) {
         e.printStackTrace();
      }
   }
}

Explanation of Key Parts

  1. followRedirects Option:
    • The followRedirects method accepts one of the HttpClient.Redirect enum values:
      • Redirect.NEVER: Never follows redirects. (Default)
      • Redirect.ALWAYS: Always follows redirects.
      • Redirect.NORMAL: Follows redirects for GET and HEAD requests only.
    • In this example, Redirect.ALWAYS is used, which instructs the client to follow all redirects.
  2. Building the Client:
    • HttpClient is created using its builder (HttpClient.newBuilder()).
  3. Making the Request:
    • An HttpRequest is built specifying the URI.
    • You can set methods (GET, POST, etc.), headers, and request configurations as needed.
  4. Handling the Response:
    • The send method executes the request and waits for the response.
    • Use HttpResponse.BodyHandlers.ofString() to handle the response body as a String.

Expected Output

If the redirection succeeds:

Response Status Code: 200
Response Body: <HTML content of https://example.com>

Notes

  • If you set Redirect.NEVER (the default), you will need to handle 3xx responses manually, which include the Location header containing the redirection URL.
  • If an infinite redirection loop exists, the client may fail. You can control this by setting a timeout using HttpClient.Builder.connectTimeout(Duration).

How do I use HttpResponse.BodyHandlers to read responses?

To read HTTP responses in Java 11 using HttpResponse.BodyHandlers, you use the Java 11 java.net.http package, which introduced the HttpClient API. The HttpResponse.BodyHandlers class provides various static methods to handle the HTTP response body in different formats, such as strings, files, or byte arrays.

Here’s a step-by-step guide to using HttpResponse.BodyHandlers with examples:

Step 1: Create an HttpClient

Start by creating an instance of the HttpClient. It’s used to send an HTTP request and receive an HTTP response.

HttpClient client = HttpClient.newHttpClient();

Step 2: Create an HttpRequest

Build an HTTP request using the HttpRequest class. Specify the URI and HTTP method (like GET, POST).

HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://jsonplaceholder.typicode.com/posts/1"))
        .GET() // Optional, as GET is the default
        .build();

Step 3: Use HttpResponse.BodyHandlers

The HttpResponse.BodyHandlers provides different ways to read and handle the response body.

  1. Reading the Response as a String You can use BodyHandlers.ofString() to read the response body as a String.
    HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println("Response status code: " + response.statusCode());
    System.out.println("Response body: " + response.body());
    
  2. Reading the Response as a Byte Array If you need the raw bytes of the response, use BodyHandlers.ofByteArray().
    HttpResponse<byte[]> response = client.send(request, HttpResponse.BodyHandlers.ofByteArray());
    System.out.println("Response status code: " + response.statusCode());
    byte[] responseBody = response.body();
    System.out.println("Response body length: " + responseBody.length);
    
  3. Writing the Response Directly to a File To save the HTTP response directly to a file, use BodyHandlers.ofFile(Path).
    Path filePath = Path.of("response.json");
    HttpResponse<Path> response = client.send(request, HttpResponse.BodyHandlers.ofFile(filePath));
    System.out.println("Response status code: " + response.statusCode());
    System.out.println("Response written to: " + filePath.toAbsolutePath());
    
  4. Using HttpResponse.BodySubscribers for Custom Processing For advanced use cases, you can use BodyHandlers.fromSubscriber() in combination with BodySubscribers to handle the response body in a custom way.

Step 4: Handle Exceptions

Since the send() method can throw exceptions like IOException and InterruptedException, wrap your code in a try-catch block.

try {
    HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println("Response status code: " + response.statusCode());
    System.out.println("Response body: " + response.body());
} catch (IOException | InterruptedException e) {
    e.printStackTrace();
}

Example: Putting It All Together

package org.kodejava.net.http;

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.nio.file.Path;
import java.io.IOException;

public class MainHttpHClient{
    public static void main(String[] args) {
        try (HttpClient client = HttpClient.newHttpClient()) {

            HttpRequest request = HttpRequest.newBuilder()
                    .uri(URI.create("https://jsonplaceholder.typicode.com/posts/1"))
                    .GET()
                    .build();

            try {
                // Using BodyHandler to read response as String
                HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

                System.out.println("Response Status Code: " + response.statusCode());
                System.out.println("Response Body: " + response.body());
            } catch (IOException | InterruptedException e) {
                e.printStackTrace();
            }
        }
    }
}

Common BodyHandlers Methods

Method Description
HttpResponse.BodyHandlers.ofString() Read the response as a String.
HttpResponse.BodyHandlers.ofByteArray() Read the response as a byte[].
HttpResponse.BodyHandlers.ofFile(Path path) Write the response directly to a file.
HttpResponse.BodyHandlers.ofInputStream() Read the response body as an InputStream.
HttpResponse.BodyHandlers.fromSubscriber(BodySubscriber<T>) Custom handling of response body.

Notes:

  1. The HttpClient, HttpRequest, and HttpResponse classes are part of the java.net.http package introduced in Java 11.
  2. This API is asynchronous-capable. For better scalability, you can use the sendAsync() method for non-blocking calls, along with CompletableFuture.

How do I use HttpRequest.BodyPublishers in Java effectively?

Java 11 introduced the java.net.http package, providing a modern API to work with HTTP. The HttpRequest.BodyPublishers class is part of this package and is used for sending request bodies when creating HTTP requests using HttpClient. Here’s a breakdown of how to use HttpRequest.BodyPublishers effectively in Java 11:

1. Overview of HttpRequest.BodyPublishers

HttpRequest.BodyPublishers is a utility class that provides methods to create body publishers. These publishers are responsible for converting data (strings, files, streams, etc.) into a format suitable for sending as the HTTP request body.

2. Commonly Used Methods

Here are some handy static methods provided by HttpRequest.BodyPublishers:

  • noBody()
    • Sends a request without any body (useful for GET, DELETE, etc.).
    • Example: HttpRequest.BodyPublishers.noBody()
  • ofString(String body)
    • Sends a plain string as the request body.
    • Example: HttpRequest.BodyPublishers.ofString("my-data")
  • ofByteArray(byte[] body)
    • Sends a raw byte array as the request body.
    • Example: HttpRequest.BodyPublishers.ofByteArray(someByteArray)
  • ofFile(Path file)
    • Sends the content of a file as the request body.
    • Example: HttpRequest.BodyPublishers.ofFile(Paths.get("example.txt"))
  • ofInputStream(Supplier<InputStream> streamSupplier)
    • Allows streaming data for large payloads, using an InputStream.
    • Example: HttpRequest.BodyPublishers.ofInputStream(() -> new FileInputStream("largeFile.data"))
  • ofByteArrayConsumer(IntFunction<Optional<byte[]>> consumer)
    • Produces request bodies chunk by chunk (useful for advanced use cases).

3. Practical Examples

a) Simple String Request Body

For a POST request with a plain text payload:

package org.kodejava.net.http;

import java.net.http.*;
import java.net.URI;

public class HttpClientDemo {
    public static void main(String[] args) throws Exception {
        HttpResponse<String> response;
        try (HttpClient client = HttpClient.newHttpClient()) {
            HttpRequest request = HttpRequest.newBuilder()
                    .uri(URI.create("https://example.com/api"))
                    .POST(HttpRequest.BodyPublishers.ofString("Hello, World!"))
                    .header("Content-Type", "text/plain")
                    .build();

            response = client.send(request, HttpResponse.BodyHandlers.ofString());
        }
        System.out.println("Response code: " + response.statusCode());
        System.out.println("Response body: " + response.body());
    }
}

b) Sending File as Request Body

This example uploads content from a file:

package org.kodejava.net.http;

import java.net.http.*;
import java.net.URI;
import java.nio.file.Paths;

public class FileUploadExample {
    public static void main(String[] args) throws Exception {
        HttpResponse<String> response;
        try (HttpClient client = HttpClient.newHttpClient()) {
            HttpRequest request = HttpRequest.newBuilder()
                    .uri(URI.create("https://example.com/upload"))
                    .POST(HttpRequest.BodyPublishers.ofFile(Paths.get("example.txt")))
                    .header("Content-Type", "text/plain")
                    .build();

            response = client.send(request, HttpResponse.BodyHandlers.ofString());
        }
        System.out.println("Response code: " + response.statusCode());
    }
}

c) Using InputStream for Large Files

For large files, using InputStream can be more memory-efficient:

package org.kodejava.net.http;

import java.net.http.*;
import java.net.URI;
import java.io.FileInputStream;

public class StreamUploadExample {
    public static void main(String[] args) throws Exception {
        HttpResponse<String> response;
        try (HttpClient client = HttpClient.newHttpClient()) {
            HttpRequest request = HttpRequest.newBuilder()
                    .uri(URI.create("https://example.com/upload"))
                    .POST(HttpRequest.BodyPublishers.ofInputStream(() -> {
                        try {
                            return new FileInputStream("large-file.data");
                        } catch (Exception e) {
                            throw new RuntimeException(e);
                        }
                    }))
                    .header("Content-Type", "application/octet-stream")
                    .build();

            response = client.send(request, HttpResponse.BodyHandlers.ofString());
        }
        System.out.println("Response code: " + response.statusCode());
    }
}

4. Best Practices

  • Choose the Right BodyPublisher: Pick the appropriate method for your data type:
    • Use ofString for small text payloads.
    • Use ofFile for files.
    • Use ofInputStream for large data to avoid memory issues.
  • Set Proper Headers: Use Content-Type and other relevant headers to ensure the server can interpret the body correctly.
  • Error Handling: Handle potential IO or HTTP communication exceptions gracefully.
  • Streaming for Large Data: When sending large amounts of data, consider using ofInputStream instead of loading the entire data into memory at once.

5. Advantages of HttpRequest.BodyPublishers

  • Ease of Use: Simplifies working with different types of data (strings, files, streams, etc.).
  • Memory Efficiency: Supports streaming for large data payloads.
  • Modern API: Works seamlessly with the HttpClient introduced in Java 11.

By combining the capabilities of HttpRequest.BodyPublishers with other features of the Java 11 HTTP Client API, you can efficiently send HTTP requests tailored to your application’s needs.

How do I build an HttpRequest with query parameters?

In Java 11, you can use the HttpRequest class (from the java.net.http package) to build HTTP requests, including adding query parameters to a URI.

Here’s how you can build an HttpRequest with query parameters:

Example

package org.kodejava.net.http;

import java.net.URI;
import java.net.URISyntaxException;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.http.HttpHeaders;
import java.net.URLEncoder;
import java.nio.charset.StandardCharsets;
import java.util.Map;

public class HttpRequestExample {

   public static void main(String[] args) throws Exception {
      // Base URI
      String baseUri = "https://example.com/api";

      // Query Parameters
      Map<String, String> queryParams = Map.of(
              "_param1", "value1",
              "_param2", "value2",
              "_param3", "value3"
      );

      // Build the URI with query parameters
      String uriWithParams = buildUriWithQueryParams(baseUri, queryParams);

      // Create the HttpRequest
      HttpRequest request = HttpRequest.newBuilder()
              .uri(URI.create(uriWithParams))
              .GET()
              .build();

      // Print Request Information
      System.out.println("Request URI: " + request.uri());

      // Send the HTTP request (optional, for demo purposes)
      HttpClient client = HttpClient.newHttpClient();
      HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
      System.out.println("Response Status Code: " + response.statusCode());
      System.out.println("Response Body: " + response.body());
   }

   private static String buildUriWithQueryParams(String baseUri, Map<String, String> queryParams) {
      StringBuilder uriBuilder = new StringBuilder(baseUri);

      if (!queryParams.isEmpty()) {
         uriBuilder.append("?");
         // Encode each query parameter
         queryParams.forEach((key, value) -> {
            uriBuilder
                    .append(URLEncoder.encode(key, StandardCharsets.UTF_8))
                    .append("=")
                    .append(URLEncoder.encode(value, StandardCharsets.UTF_8))
                    .append("&");
         });
         // Remove the trailing "&"
         uriBuilder.deleteCharAt(uriBuilder.length() - 1);
      }

      return uriBuilder.toString();
   }
}

Explanation

  1. Base URI: The starting point for the requested resource, e.g., `https://example.com/api`.
  2. Query Parameters: These are typically a set of key-value pairs added to the URI. In the example, we used the Map<String, String> to store the parameters.
  3. Encoding Parameters: The URLEncoder.encode(key, StandardCharsets.UTF_8) ensures that special characters in the keys or values (e.g., spaces, ampersands) are properly encoded.
  4. Build the Query String:
    • We check if there are query parameters to append.
    • Iterate through the Map, encode each key-value pair, and append them as a query string.
    • Remove the trailing ampersand (&) after adding all query parameters.
  5. Build the HttpRequest: We use the HttpRequest.newBuilder() to configure a GET request. You can change the HTTP method or add headers as needed (e.g., .header(key, value)).
  6. Send the Request: We use HttpClient to send the request and capture the response (optional for the example).

Sample Output

For baseUri = "https://example.com/api" and queryParams = {"_param1": "value1", "_param2": "value2", "_param3": "value3"}, the output would be:

Request URI: https://example.com/api?_param1=value1&_param2=value2&_param3=value3
Response Status Code: 200
Response Body: <response body here>

You can adapt this approach for POST requests or other configurations if needed.

How do I use HttpClient to call REST APIs?

Java 11 introduced a new HttpClient API (java.net.HttpClient) that simplifies making HTTP requests and handling responses. It provides a clean and concise way to perform synchronous and asynchronous HTTP operations, and it fully supports RESTful APIs.

Here’s a step-by-step guide with examples for how to use the Java 11 HttpClient to call REST APIs.


1. Create an HttpClient Instance

The HttpClient is the main entry point for sending HTTP requests and receiving responses. You can create an HttpClient using its builder.

HttpClient client = HttpClient.newHttpClient();

2. Build an HttpRequest

The HttpRequest represents the HTTP request that you want to send. You can build it using a static builder where you set the HTTP method, headers, URI, etc.

Example: Build a GET Request

HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://jsonplaceholder.typicode.com/posts/1"))
        .GET() // Use GET method
        .build();

Example: Build a POST Request

For a POST request, you also need to include a body in the request.

HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://jsonplaceholder.typicode.com/posts"))
        .header("Content-Type", "application/json")
        .POST(HttpRequest.BodyPublishers.ofString("{\"title\": \"foo\", \"body\": \"bar\", \"userId\": 1}"))
        .build();

3. Send the HttpRequest

The HttpClient provides methods to send HTTP requests. You can choose to execute the request synchronously or asynchronously.

Synchronous Call

Use HttpClient.send() to execute the request synchronously and retrieve an HttpResponse.

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println("Status Code: " + response.statusCode());
System.out.println("Response Body: " + response.body());

Asynchronous Call

Use HttpClient.sendAsync() to execute the request asynchronously. It returns a CompletableFuture which allows non-blocking operations.

client.sendAsync(request, HttpResponse.BodyHandlers.ofString())
      .thenApply(HttpResponse::body) // Extract body
      .thenAccept(System.out::println); // Print response body

The above code sends the request in the background and processes the response once received.


4. Handle Response

The HttpResponse provides access to the response details like status code, headers, and body. You can use HttpResponse.BodyHandlers to specify how the body should be processed.

Available BodyHandlers:

  • HttpResponse.BodyHandlers.ofString(): Read the response as a String.
  • HttpResponse.BodyHandlers.ofFile(): Save the response to a file.
  • HttpResponse.BodyHandlers.ofInputStream(): Access the response as an InputStream.

For example:

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println("Headers: " + response.headers());
System.out.println("Body: " + response.body());

5. Complete Example for a GET Request

Here’s a complete program that sends a GET request to a REST API and prints the response:

package org.kodejava.net.http;

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class HttpClientGetExample {
    public static void main(String[] args) {
        try {
            // Step 1: Create HttpClient
            HttpClient client = HttpClient.newHttpClient();

            // Step 2: Create HttpRequest
            HttpRequest request = HttpRequest.newBuilder()
                    .uri(URI.create("https://jsonplaceholder.typicode.com/posts/1"))
                    .GET()
                    .build();

            // Step 3: Send the request and receive HttpResponse
            HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

            // Step 4: Process the response
            System.out.println("Status Code: " + response.statusCode());
            System.out.println("Response Body: " + response.body());
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

6. Complete Example for a POST Request

Here’s how you can do a POST request to send JSON data:

package org.kodejava.net.http;

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class HttpClientPostExample {
    public static void main(String[] args) {
        try {
            // Step 1: Create HttpClient
            HttpClient client = HttpClient.newHttpClient();

            // Step 2: Build HttpRequest with POST body
            HttpRequest request = HttpRequest.newBuilder()
                    .uri(URI.create("https://jsonplaceholder.typicode.com/posts"))
                    .header("Content-Type", "application/json")
                    .POST(HttpRequest.BodyPublishers.ofString("{\"title\": \"foo\", \"body\": \"bar\", \"userId\": 1}"))
                    .build();

            // Step 3: Send the POST request and receive response
            HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

            // Step 4: Process the response
            System.out.println("Status Code: " + response.statusCode());
            System.out.println("Response Body: " + response.body());
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

Key Points to Remember:

  1. Use java.net.URI for specifying the API endpoint.
  2. Always handle exceptions (e.g., IOException and InterruptedException).
  3. You may need to set headers (e.g., Content-Type or Authorization) depending on the API requirements.
  4. Handle different response codes appropriately.

This approach is suitable for working with REST APIs and provides both blocking and non-blocking operations for flexibility.