Package org.pkl.core.http

Interface HttpClient.Builder

Enclosing interface:

HttpClient

public static interface HttpClient.Builder

A builder of HTTP clients.

Method Summary

Modifier and Type	Method	Description
HttpClient.Builder	addCertificates(byte[] certificateBytes)	Adds CA certificate bytes to the client's trust store.
HttpClient.Builder	addCertificates(Path path)	Adds a CA certificate file to the client's trust store.
HttpClient	build()	Creates a new HttpClient from the current state of this builder.
HttpClient	buildLazily()	Returns an HTTPClient wrapper that defers building the actual HTTP client until the wrapper's HttpClient.send(java.net.http.HttpRequest, java.net.http.HttpResponse.BodyHandler<T>) method is called.
HttpClient.Builder	setConnectTimeout(Duration timeout)	Sets the timeout for connecting to a server.
HttpClient.Builder	setProxy(@Nullable URI proxyAddress, List<String> noProxy)	Configures HTTP connections to connect to the provided proxy address.
HttpClient.Builder	setProxySelector(ProxySelector proxySelector)	Sets the proxy selector to use when establishing connections.
HttpClient.Builder	setRequestTimeout(Duration timeout)	Sets the timeout for the interval between sending a request and receiving response headers.
HttpClient.Builder	setTestPort(int port)	Sets a test server's listening port.
HttpClient.Builder	setUserAgent(String userAgent)	Sets the User-Agent header.

Method Details

setUserAgent

HttpClient.Builder setUserAgent(String userAgent)

Sets the User-Agent header.

Defaults to "Pkl/$version ($os; $flavor)".

setConnectTimeout

HttpClient.Builder setConnectTimeout(Duration timeout)

Sets the timeout for connecting to a server.

Defaults to 60 seconds.

setRequestTimeout

HttpClient.Builder setRequestTimeout(Duration timeout)

Sets the timeout for the interval between sending a request and receiving response headers.

Defaults to 60 seconds. To set a timeout for a specific request, use HttpRequest.Builder.timeout(java.time.Duration).

addCertificates

HttpClient.Builder addCertificates(Path path)

Adds a CA certificate file to the client's trust store.

The given file must contain X.509 certificates in PEM format.

If no CA certificates are added via this method nor addCertificates(byte[]), the built-in CA certificates of the Pkl native executable or JVM are used.

addCertificates

HttpClient.Builder addCertificates(byte[] certificateBytes)

Adds CA certificate bytes to the client's trust store.

The given cert must be an X.509 certificate in PEM format.

If no CA certificates are added via this method nor addCertificates(Path), the built-in CA certificates of the Pkl native executable or JVM are used.

setTestPort

HttpClient.Builder setTestPort(int port)

Sets a test server's listening port.

If set, requests that specify port 0 will be modified to use the given port. This is an internal test option.

setProxySelector

HttpClient.Builder setProxySelector(ProxySelector proxySelector)

Sets the proxy selector to use when establishing connections.

Defaults to: ProxySelector.getDefault().

setProxy

HttpClient.Builder setProxy(@Nullable
 @Nullable URI proxyAddress,
 List<String> noProxy)

Configures HTTP connections to connect to the provided proxy address.

The provided proxyAddress must have scheme http, not contain userInfo, and not have a path segment.

If proxyAddress is null, uses the proxy address provided by ProxySelector.getDefault().

NOTE: Due to a limitation in the JDK, this does not configure the proxy server used for certificate revocation checking. To configure the certificate revocation checker, the result of ProxySelector.getDefault() needs to be changed either by setting system properties, or via ProxySelector.setDefault(java.net.ProxySelector).

Throws:

IllegalArgumentException - if `proxyAddress` is invalid.

build

HttpClient build()

Creates a new HttpClient from the current state of this builder.

Throws:

HttpClientInitException - if an error occurs while initializing the client

buildLazily

HttpClient buildLazily()

Returns an HTTPClient wrapper that defers building the actual HTTP client until the wrapper's HttpClient.send(java.net.http.HttpRequest, java.net.http.HttpResponse.BodyHandler<T>) method is called.

Note: When using this method, any exception thrown when building the actual HTTP client is equally deferred.