org.apache.gravitino.client

Class HTTPClient.Builder

java.lang.Object

org.apache.gravitino.client.HTTPClient.Builder

Enclosing class:

HTTPClient

public static class HTTPClient.Builder
extends java.lang.Object

Builder class for configuring and creating instances of HTTPClient.

This class allows for setting various configuration options for the HTTP client such as base URI, request headers, and ObjectMapper.

Method Summary

Modifier and Type	Method and Description
HTTPClient	build() Builds and returns an instance of the HTTPClient with the configured options.
HTTPClient.Builder	uri(java.lang.String baseUri) Sets the base URI for the HTTP client.
HTTPClient.Builder	withAuthDataProvider(org.apache.gravitino.client.AuthDataProvider authDataProvider) Sets the AuthDataProvider for the HTTP client.
HTTPClient.Builder	withHeader(java.lang.String key, java.lang.String value) Adds a single request header to the HTTP client.
HTTPClient.Builder	withHeaders(java.util.Map<java.lang.String,java.lang.String> headers) Adds multiple request headers to the HTTP client.
HTTPClient.Builder	withObjectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper) Sets the custom ObjectMapper for the HTTP client.
HTTPClient.Builder	withPreConnectHandler(java.lang.Runnable beforeConnectHandler) Sets the preConnect handle for the HTTP client.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

uri

public HTTPClient.Builder uri(java.lang.String baseUri)

Sets the base URI for the HTTP client.

Parameters:

baseUri - The base URI to be used for all HTTP requests.

Returns:

This Builder instance for method chaining.

withHeader

public HTTPClient.Builder withHeader(java.lang.String key,
                                     java.lang.String value)

Adds a single request header to the HTTP client.

Parameters:

key - The header name.

value - The header value.

Returns:

This Builder instance for method chaining.

withHeaders

public HTTPClient.Builder withHeaders(java.util.Map<java.lang.String,java.lang.String> headers)

Adds multiple request headers to the HTTP client.

Parameters:

headers - A map of request headers (key-value pairs) to be included in all HTTP requests.

Returns:

This Builder instance for method chaining.

withObjectMapper

public HTTPClient.Builder withObjectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Sets the custom ObjectMapper for the HTTP client.

Parameters:

objectMapper - The custom ObjectMapper to be used for request/response serialization.

Returns:

This Builder instance for method chaining.

withPreConnectHandler

public HTTPClient.Builder withPreConnectHandler(java.lang.Runnable beforeConnectHandler)

Sets the preConnect handle for the HTTP client.

Parameters:

beforeConnectHandler - The handle run before connect to the server .

Returns:

This Builder instance for method chaining.

withAuthDataProvider

public HTTPClient.Builder withAuthDataProvider(org.apache.gravitino.client.AuthDataProvider authDataProvider)

Sets the AuthDataProvider for the HTTP client.

Parameters:

authDataProvider - The authDataProvider providing the data used to authenticate.

Returns:

This Builder instance for method chaining.

build

public HTTPClient build()

Builds and returns an instance of the HTTPClient with the configured options.

Returns:

An instance of HTTPClient with the configured options.