Package org.projectnessie.client.http

Class HttpClientBuilder

java.lang.Object

org.projectnessie.client.http.HttpClientBuilder

All Implemented Interfaces:

NessieClientBuilder<HttpClientBuilder>

public class HttpClientBuilder
extends Object
implements NessieClientBuilder<HttpClientBuilder>

A builder class that creates a NessieHttpClient via builder().

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	HttpClientBuilder()

Method Summary

Modifier and Type	Method	Description
<API extends NessieApi> API	build(Class<API> apiVersion)	Builds a new NessieApi.
static HttpClientBuilder	builder()
HttpClientBuilder	fromConfig(Function<String,String> configuration)	Configure this HttpClientBuilder instance using a configuration object and standard Nessie configuration keys defined by the constants defined in NessieConfigConstants.
HttpClientBuilder	fromSystemProperties()	Same semantics as fromConfig(Function), uses the system properties.
HttpClientBuilder	withAuthentication(NessieAuthentication authentication)	Sets the NessieAuthentication instance to be used.
HttpClientBuilder	withAuthenticationFromConfig(Function<String,String> configuration)	Configure only authentication in this HttpClientBuilder instance using a configuration object and standard Nessie configuration keys defined by the constants defined in NessieConfigConstants.
HttpClientBuilder	withConnectionTimeout(int connectionTimeoutMillis)	Set the connection timeout in milliseconds for this client.
HttpClientBuilder	withReadTimeout(int readTimeoutMillis)	Set the read timeout in milliseconds for this client.
HttpClientBuilder	withTracing(boolean tracing)	Whether to enable adding the HTTP headers of an active OpenTracing span to all Nessie requests.
HttpClientBuilder	withUri(String uri)	Convenience method for withUri(URI) taking a string.
HttpClientBuilder	withUri(URI uri)	Set the Nessie server URI.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpClientBuilder

protected HttpClientBuilder()

Method Detail

builder

public static HttpClientBuilder builder()

fromSystemProperties

public HttpClientBuilder fromSystemProperties()

Same semantics as fromConfig(Function), uses the system properties.

Specified by:

fromSystemProperties in interface NessieClientBuilder<HttpClientBuilder>

Returns:

this

See Also:

fromConfig(Function)

fromConfig

public HttpClientBuilder fromConfig(Function<String,String> configuration)

Configure this HttpClientBuilder instance using a configuration object and standard Nessie configuration keys defined by the constants defined in NessieConfigConstants. Non-null values returned by the configuration-function will override previously configured values.

Specified by:

fromConfig in interface NessieClientBuilder<HttpClientBuilder>

Parameters:

configuration - The function that returns a configuration value for a configuration key.

Returns:

this

See Also:

fromSystemProperties()

withAuthenticationFromConfig

public HttpClientBuilder withAuthenticationFromConfig(Function<String,String> configuration)

Configure only authentication in this HttpClientBuilder instance using a configuration object and standard Nessie configuration keys defined by the constants defined in NessieConfigConstants.

Specified by:

withAuthenticationFromConfig in interface NessieClientBuilder<HttpClientBuilder>

Parameters:

configuration - The function that returns a configuration value for a configuration key.

Returns:

this

See Also:

fromConfig(Function)

withUri

public HttpClientBuilder withUri(URI uri)

Set the Nessie server URI. A server URI must be configured.

Specified by:

withUri in interface NessieClientBuilder<HttpClientBuilder>

Parameters:

uri - server URI

Returns:

this

withUri

public HttpClientBuilder withUri(String uri)

Convenience method for withUri(URI) taking a string.

Specified by:

withUri in interface NessieClientBuilder<HttpClientBuilder>

Parameters:

uri - server URI

Returns:

this

withAuthentication

public HttpClientBuilder withAuthentication(NessieAuthentication authentication)

Description copied from interface: NessieClientBuilder

Sets the NessieAuthentication instance to be used.

Specified by:

withAuthentication in interface NessieClientBuilder<HttpClientBuilder>

Parameters:

authentication - authentication for this client

Returns:

this

withTracing

public HttpClientBuilder withTracing(boolean tracing)

Whether to enable adding the HTTP headers of an active OpenTracing span to all Nessie requests. If enabled, the OpenTracing dependencies must be present at runtime.

Parameters:

tracing - true to enable passing HTTP headers for active tracing spans.

Returns:

this

withReadTimeout

public HttpClientBuilder withReadTimeout(int readTimeoutMillis)

Set the read timeout in milliseconds for this client. Timeout will throw HttpClientReadTimeoutException.

Parameters:

readTimeoutMillis - number of seconds to wait for a response from server.

Returns:

this

withConnectionTimeout

public HttpClientBuilder withConnectionTimeout(int connectionTimeoutMillis)

Set the connection timeout in milliseconds for this client. Timeout will throw HttpClientException.

Parameters:

connectionTimeoutMillis - number of seconds to wait to connect to the server.

Returns:

this

build

public <API extends NessieApi> API build(Class<API> apiVersion)

Description copied from interface: NessieClientBuilder

Builds a new NessieApi.

Specified by:

build in interface NessieClientBuilder<HttpClientBuilder>

Returns:

A new NessieApi.