Module io.avaje.http.client

Package io.avaje.http.client

Interface HttpClient.Builder

Enclosing interface:

HttpClient

public static interface HttpClient.Builder

Builds the HttpClient.

   HttpClient client = HttpClient.builder()
       .baseUrl("http://localhost:8080")
       .bodyAdapter(new JacksonBodyAdapter())
       .build();

  HelloDto dto = client.request()
       .path("hello")
       .queryParam("name", "Rob")
       .queryParam("say", "Whats up")
       .GET()
       .bean(HelloDto.class);

 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	HttpClient.Builder.State	The state of the builder with methods to read the set state.

Method Summary

Modifier and Type	Method	Description
HttpClient.Builder	authenticator(Authenticator authenticator)	Set a HttpClient authenticator to the underlying HttpClient.
HttpClient.Builder	authTokenProvider(AuthTokenProvider authTokenProvider)	Add a Authorization token provider.
HttpClient.Builder	baseUrl(String baseUrl)	Set the base URL to use for requests created from the context.
HttpClient.Builder	bodyAdapter(BodyAdapter adapter)	Set the body adapter to use to convert beans to body content and response content back to beans.
HttpClient	build()	Build and return the context.
HttpClient.Builder	client(HttpClient client)	Set the underlying HttpClient to use.
HttpClient.Builder	configureWith(io.avaje.inject.BeanScope beanScope)	Configure BodyAdapter and RetryHandler using dependency injection BeanScope.
HttpClient.Builder	connectionTimeout(Duration connectionTimeout)	Set the connection timeout to use.
HttpClient.Builder	cookieHandler(CookieHandler cookieHandler)	Specify a cookie handler to use on the HttpClient.
HttpClient.Builder	executor(Executor executor)	Specify the Executor to use for asynchronous tasks.
HttpClient.Builder	globalErrorMapper(Function<HttpException,RuntimeException> errorMapper)	Set the default mapper to be used to transform HttpException into a different kind of exception.
HttpClient.Builder	priority(int priority)	Set the priority for HTTP/2 requests to the underlying HttpClient.
HttpClient.Builder	proxy(ProxySelector proxySelector)	Set the proxy to the underlying HttpClient.
HttpClient.Builder	redirect(HttpClient.Redirect redirect)	Specify the redirect policy.
HttpClient.Builder	requestIntercept(RequestIntercept... requestIntercept)	Add a request interceptor.
HttpClient.Builder	requestListener(RequestListener... requestListener)	Add a request listener.
HttpClient.Builder	requestLogging(boolean requestLogging)	Disable or enable built in request and response logging.
HttpClient.Builder	requestTimeout(Duration requestTimeout)	Set the default request timeout.
HttpClient.Builder	retryHandler(RetryHandler retryHandler)	Set a RetryHandler to use to retry requests.
HttpClient.Builder	sslContext(SSLContext sslContext)	Set the sslContext to the underlying HttpClient.
HttpClient.Builder	sslParameters(SSLParameters sslParameters)	Set the sslParameters to the underlying HttpClient.
HttpClient.Builder.State	state()	Return the state of the builder.
HttpClient.Builder	version(HttpClient.Version version)	Specify the HTTP version.

Method Details

baseUrl

HttpClient.Builder baseUrl(String baseUrl)

Set the base URL to use for requests created from the context.

Note that the base url can be replaced via HttpClientRequest.url(String).

globalErrorMapper

HttpClient.Builder globalErrorMapper(Function<HttpException,RuntimeException> errorMapper)

Set the default mapper to be used to transform HttpException into a different kind of exception. Individual requests can override with their own mapper.

When set, all HttpException that are thrown by this client will be caught and rethrown with the given function by default.

Parameters:

errorMapper - The function to map the httpException

Returns:

The request being built

connectionTimeout

HttpClient.Builder connectionTimeout(Duration connectionTimeout)

Set the connection timeout to use.

See Also:

• HttpClient.Builder.connectTimeout(Duration)

requestTimeout

HttpClient.Builder requestTimeout(Duration requestTimeout)

Set the default request timeout.

See Also:

• HttpRequest.Builder.timeout(Duration)

bodyAdapter

HttpClient.Builder bodyAdapter(BodyAdapter adapter)

Set the body adapter to use to convert beans to body content and response content back to beans.

retryHandler

HttpClient.Builder retryHandler(RetryHandler retryHandler)

Set a RetryHandler to use to retry requests.

requestLogging

HttpClient.Builder requestLogging(boolean requestLogging)

Disable or enable built in request and response logging.

By default request logging is enabled. Set this to false to stop the default RequestLogger being registered to log request and response headers and bodies etc.

With logging level set to DEBUG for io.avaje.http.client.RequestLogger the request and response are logged as a summary with response status and time.

Set the logging level to TRACE to include the request and response headers and body payloads with truncation for large bodies.

Suppression

We can also use HttpClientRequest.suppressLogging() to suppress logging on specific requests.

Logging of Authorization headers is suppressed. AuthTokenProvider requests are suppressed.

Parameters:

requestLogging - Disable/enable the registration of the default logger

See Also:

• RequestLogger

requestListener

HttpClient.Builder requestListener(RequestListener... requestListener)

Add a request listener. Multiple listeners may be added, when do so they will process events in the order they were added.

Note that RequestLogger is an implementation for debug logging request/response headers and content which is registered by default depending on requestLogging(boolean).

See Also:

• RequestLogger

requestIntercept

HttpClient.Builder requestIntercept(RequestIntercept... requestIntercept)

Add a request interceptor. Multiple interceptors may be added.

authTokenProvider

HttpClient.Builder authTokenProvider(AuthTokenProvider authTokenProvider)

Add a Authorization token provider.

When set all requests are expected to use a Authorization Bearer token unless they are marked via HttpClientRequest.skipAuthToken().

The AuthTokenProvider obtains a new token typically with an expiry. This is automatically called as needed and the Authorization Bearer header set on all requests (not marked with skipAuthToken()).

client

HttpClient.Builder client(HttpClient client)

Set the underlying HttpClient to use.

Used when we wish to control all options of the HttpClient.

cookieHandler

HttpClient.Builder cookieHandler(CookieHandler cookieHandler)

Specify a cookie handler to use on the HttpClient. This would override the default cookie handler.

See Also:

• HttpClient.Builder.cookieHandler(CookieHandler)

redirect

HttpClient.Builder redirect(HttpClient.Redirect redirect)

Specify the redirect policy. Defaults to HttpClient.Redirect.NORMAL.

See Also:

• HttpClient.Builder.followRedirects(java.net.http.HttpClient.Redirect)

version

HttpClient.Builder version(HttpClient.Version version)

Specify the HTTP version. Defaults to not set.

See Also:

• HttpClient.Builder.version(java.net.http.HttpClient.Version)

executor

HttpClient.Builder executor(Executor executor)

Specify the Executor to use for asynchronous tasks. If not specified a default executor will be used.

See Also:

• HttpClient.Builder.executor(Executor)

proxy

HttpClient.Builder proxy(ProxySelector proxySelector)

Set the proxy to the underlying HttpClient.

See Also:

• HttpClient.Builder.proxy(ProxySelector)

sslContext

HttpClient.Builder sslContext(SSLContext sslContext)

Set the sslContext to the underlying HttpClient.

See Also:

• HttpClient.Builder.sslContext(SSLContext)

sslParameters

HttpClient.Builder sslParameters(SSLParameters sslParameters)

Set the sslParameters to the underlying HttpClient.

See Also:

• HttpClient.Builder.sslParameters(SSLParameters)

authenticator

HttpClient.Builder authenticator(Authenticator authenticator)

Set a HttpClient authenticator to the underlying HttpClient.

See Also:

• HttpClient.Builder.authenticator(Authenticator)

priority

HttpClient.Builder priority(int priority)

Set the priority for HTTP/2 requests to the underlying HttpClient.

See Also:

• HttpClient.Builder.priority(int)

configureWith

HttpClient.Builder configureWith(io.avaje.inject.BeanScope beanScope)

Configure BodyAdapter and RetryHandler using dependency injection BeanScope.

state

HttpClient.Builder.State state()

Return the state of the builder.

build

HttpClient build()

Build and return the context.

   HttpClient client = HttpClient.builder()
       .baseUrl("http://localhost:8080")
       .bodyAdapter(new JacksonBodyAdapter())
       .build();

  HelloDto dto = client.request()
       .path("hello")
       .queryParam("say", "Whats up")
       .GET()
       .bean(HelloDto.class);