Module io.avaje.http.client

Package io.avaje.http.client

Interface HttpClientContext.Builder

Enclosing interface:

HttpClientContext

public static interface HttpClientContext.Builder

Builds the HttpClientContext.

Method Summary

Modifier and Type	Method	Description
HttpClientContext	build()	Build and return the context.
HttpClientContext.Builder	with(HttpClient client)	Set the underlying HttpClient to use.
HttpClientContext.Builder	withBaseUrl(String baseUrl)	Set the base URL to use for requests created from the context.
HttpClientContext.Builder	withBodyAdapter(BodyAdapter adapter)	Set the body adapter to use to convert beans to body content and response content back to beans.
HttpClientContext.Builder	withCookieHandler(CookieHandler cookieHandler)	Specify a cookie handler to use on the HttpClient.
HttpClientContext.Builder	withExecutor(Executor executor)	Specify the Executor to use for asynchronous tasks.
HttpClientContext.Builder	withRedirect(HttpClient.Redirect redirect)	Specify the redirect policy.
HttpClientContext.Builder	withRequestTimeout(Duration requestTimeout)	Set the default request timeout.
HttpClientContext.Builder	withResponseListener(ResponseListener requestListener)	Add a response listener.
HttpClientContext.Builder	withVersion(HttpClient.Version version)	Specify the HTTP version.

Method Details

with

HttpClientContext.Builder with(HttpClient client)

Set the underlying HttpClient to use.

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

withBaseUrl

HttpClientContext.Builder withBaseUrl(String baseUrl)

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

withRequestTimeout

HttpClientContext.Builder withRequestTimeout(Duration requestTimeout)

Set the default request timeout.

See Also:

HttpRequest.Builder.timeout(Duration)

withBodyAdapter

HttpClientContext.Builder withBodyAdapter(BodyAdapter adapter)

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

withResponseListener

HttpClientContext.Builder withResponseListener(ResponseListener requestListener)

Add a response listener. Note that RequestLogger is an implementation for debug logging request/response headers and content.

withCookieHandler

HttpClientContext.Builder withCookieHandler(CookieHandler cookieHandler)

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

See Also:

HttpClient.Builder.cookieHandler(CookieHandler)

withRedirect

HttpClientContext.Builder withRedirect(HttpClient.Redirect redirect)

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

See Also:

HttpClient.Builder.followRedirects(HttpClient.Redirect)

withVersion

HttpClientContext.Builder withVersion(HttpClient.Version version)

Specify the HTTP version. Defaults to not set.

See Also:

HttpClient.Builder.version(HttpClient.Version)

withExecutor

HttpClientContext.Builder withExecutor(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)

build

HttpClientContext build()

Build and return the context.