Package com.luciad.net.http

Class HttpClient.Builder

java.lang.Object

com.luciad.net.http.HttpClient.Builder

All Implemented Interfaces:

AutoCloseable

Enclosing class:

HttpClient

public static final class HttpClient.Builder
extends Object
implements AutoCloseable

Builder for the HttpClient class.

Instances of HttpClient.Builder are created by calling HttpClient#newBuilder.

Since:

2023.0

Constructor Summary

Constructors

Constructor	Description
Builder(HttpClient.Builder other)	Copy constructor.

Method Summary

Modifier and Type	Method	Description
HttpClient	build()	Returns an HttpClient, based on the properties set on this builder.
HttpClient.Builder	caCertFile(String caCertFile)	Sets the Certificate Authority (CA) to use for SSL verification.
void	close()
HttpClient.Builder	credentialProvider(ICredentialsProvider credentialsProvider)	Sets the credentials provider used by the HttpClient.
protected void	finalize()
HttpClient.Builder	httpRequestOptions(HttpRequestOptions httpRequestOptions)	Sets the HTTP request options to send with each HTTP request.
HttpClient.Builder	proxySelector(IProxySelector proxySelector)	Sets the proxy selector used by the HttpClient.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder(@NotNull
 HttpClient.Builder other)

Copy constructor.

Parameters:

other - the builder to copy.

Method Details

finalize

protected void finalize()

Overrides:

finalize in class Object

close

public void close()

Specified by:

close in interface AutoCloseable

build

@NotNull
public HttpClient build()
                 throws IllegalStateException

Returns an HttpClient, based on the properties set on this builder.

Returns:

an HttpClient, based on the properties set on this builder.

Throws:

IllegalStateException - if there is something wrong when building the HTTP client.

credentialProvider

@NotNull
public HttpClient.Builder credentialProvider(@Nullable
 ICredentialsProvider credentialsProvider)

Sets the credentials provider used by the HttpClient.

This parameter is optional. If not set, the credentials provider is taken from the environment.

Parameters:

credentialsProvider - The credential provider to use.

Returns:

this builder.

proxySelector

@NotNull
public HttpClient.Builder proxySelector(@Nullable
 IProxySelector proxySelector)

Sets the proxy selector used by the HttpClient.

This parameter is optional. If not set, the proxy selector is taken from the environment.

Parameters:

proxySelector - The proxy selector to use.

Returns:

this builder.

httpRequestOptions

@NotNull
public HttpClient.Builder httpRequestOptions(@NotNull
 HttpRequestOptions httpRequestOptions)

Sets the HTTP request options to send with each HTTP request.

This parameter is optional.

Parameters:

httpRequestOptions - The http request options.

Returns:

this builder.

caCertFile

@NotNull
public HttpClient.Builder caCertFile(@NotNull
 String caCertFile)

Sets the Certificate Authority (CA) to use for SSL verification.

The existence of the CA file is checked in the build method.

Parameters:

caCertFile - path to a CA (certificate authority) file to use. Overrides the default.

Returns:

this builder.

Since:

2026.1