Package org.projectnessie.client.http

Class NessieHttpClientBuilderImpl

java.lang.Object

org.projectnessie.client.NessieClientBuilder.AbstractNessieClientBuilder

org.projectnessie.client.http.NessieHttpClientBuilder.AbstractNessieHttpClientBuilder

org.projectnessie.client.http.NessieHttpClientBuilderImpl

All Implemented Interfaces:

NessieHttpClientBuilder, NessieClientBuilder

Direct Known Subclasses:

HttpClientBuilder

public class NessieHttpClientBuilderImpl
extends NessieHttpClientBuilder.AbstractNessieHttpClientBuilder

NessieHttpClientBuilder and NessieClientBuilder implementation for HTTP/REST.

Nested Class Summary

Nested classes/interfaces inherited from interface org.projectnessie.client.NessieClientBuilder

NessieClientBuilder.AbstractNessieClientBuilder

Nested classes/interfaces inherited from interface org.projectnessie.client.http.NessieHttpClientBuilder

NessieHttpClientBuilder.AbstractNessieHttpClientBuilder

Constructor Summary

Constructors

Constructor	Description
NessieHttpClientBuilderImpl()

Method Summary

Modifier and Type	Method	Description
<API extends NessieApi> API	build(Class<API> apiVersion)	Builds a new NessieApi.
String	name()	The name of the Nessie client implementation, for example HTTP for the HTTP/REST client.
int	priority()	Priority ordinal used to select the most relevant NessieClientBuilder implementation.
NessieHttpClientBuilderImpl	withApiCompatibilityCheck(boolean enable)
NessieHttpClientBuilderImpl	withAuthentication(NessieAuthentication authentication)	Sets the NessieAuthentication instance to be used.
NessieHttpClientBuilderImpl	withConnectionTimeout(int connectionTimeoutMillis)	Set the connection timeout in milliseconds for this client.
NessieHttpClientBuilderImpl	withDisableCompression(boolean disableCompression)	Set whether the compression shall be disabled or not.
NessieHttpClientBuilderImpl	withFollowRedirects(String redirects)	Whether HTTP redirects are followed, default is to not follow redirects.
NessieHttpClientBuilderImpl	withForceUrlConnectionClient(boolean forceUrlConnectionClient)	Whether to force using the "old" URLConnection based client when running on Java 11 and newer with Java's new HTTP client.
NessieHttpClientBuilderImpl	withHttp2Upgrade(boolean http2Upgrade)	Whether to allow HTTP/2 upgrade, default is false.
NessieHttpClientBuilderImpl	withReadTimeout(int readTimeoutMillis)	Set the read timeout in milliseconds for this client.
NessieHttpClientBuilderImpl	withResponseFactory(HttpResponseFactory responseFactory)
NessieHttpClientBuilderImpl	withSSLContext(SSLContext sslContext)	Set the SSL context for this client.
NessieHttpClientBuilderImpl	withSSLParameters(SSLParameters sslParameters)	Optionally configure specific SSLParameters.
NessieHttpClientBuilderImpl	withTracing(boolean tracing)	Whether to enable adding the HTTP headers of an active OpenTracing span to all Nessie requests.
NessieHttpClientBuilderImpl	withUri(URI uri)	Set the Nessie server URI.

Methods inherited from class org.projectnessie.client.http.NessieHttpClientBuilder.AbstractNessieHttpClientBuilder

fromConfig

Methods inherited from class org.projectnessie.client.NessieClientBuilder.AbstractNessieClientBuilder

asInstanceOf, fromSystemProperties, withAuthenticationFromConfig, withUri

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.projectnessie.client.NessieClientBuilder

asInstanceOf, fromSystemProperties, withAuthenticationFromConfig, withUri

Constructor Details

NessieHttpClientBuilderImpl

public NessieHttpClientBuilderImpl()

Method Details

name

public String name()

Description copied from interface: NessieClientBuilder

The name of the Nessie client implementation, for example HTTP for the HTTP/REST client.

priority

public int priority()

Description copied from interface: NessieClientBuilder

Priority ordinal used to select the most relevant NessieClientBuilder implementation.

withUri

@CanIgnoreReturnValue
public NessieHttpClientBuilderImpl withUri(URI uri)

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

Specified by:

withUri in interface NessieClientBuilder

Overrides:

withUri in class NessieClientBuilder.AbstractNessieClientBuilder

Parameters:

uri - server URI

Returns:

this

withAuthentication

@CanIgnoreReturnValue
public NessieHttpClientBuilderImpl withAuthentication(NessieAuthentication authentication)

Description copied from interface: NessieClientBuilder

Sets the NessieAuthentication instance to be used.

Specified by:

withAuthentication in interface NessieClientBuilder

Overrides:

withAuthentication in class NessieClientBuilder.AbstractNessieClientBuilder

Parameters:

authentication - authentication for this client

Returns:

this

withTracing

@CanIgnoreReturnValue
public NessieHttpClientBuilderImpl 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.

Specified by:

withTracing in interface NessieClientBuilder

Overrides:

withTracing in class NessieClientBuilder.AbstractNessieClientBuilder

Parameters:

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

Returns:

this

withReadTimeout

@CanIgnoreReturnValue
public NessieHttpClientBuilderImpl withReadTimeout(int readTimeoutMillis)

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

Specified by:

withReadTimeout in interface NessieClientBuilder

Overrides:

withReadTimeout in class NessieClientBuilder.AbstractNessieClientBuilder

Parameters:

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

Returns:

this

withConnectionTimeout

@CanIgnoreReturnValue
public NessieHttpClientBuilderImpl withConnectionTimeout(int connectionTimeoutMillis)

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

Specified by:

withConnectionTimeout in interface NessieClientBuilder

Overrides:

withConnectionTimeout in class NessieClientBuilder.AbstractNessieClientBuilder

Parameters:

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

Returns:

this

withDisableCompression

@CanIgnoreReturnValue
public NessieHttpClientBuilderImpl withDisableCompression(boolean disableCompression)

Set whether the compression shall be disabled or not.

Specified by:

withDisableCompression in interface NessieClientBuilder

Overrides:

withDisableCompression in class NessieClientBuilder.AbstractNessieClientBuilder

Parameters:

disableCompression - whether the compression shall be disabled or not.

Returns:

this

withSSLContext

@CanIgnoreReturnValue
public NessieHttpClientBuilderImpl withSSLContext(SSLContext sslContext)

Set the SSL context for this client.

Specified by:

withSSLContext in interface NessieClientBuilder

Overrides:

withSSLContext in class NessieClientBuilder.AbstractNessieClientBuilder

Parameters:

sslContext - the SSL context to use

Returns:

this

withSSLParameters

@CanIgnoreReturnValue
public NessieHttpClientBuilderImpl withSSLParameters(SSLParameters sslParameters)

Description copied from interface: NessieClientBuilder

Optionally configure specific SSLParameters.

Specified by:

withSSLParameters in interface NessieClientBuilder

Overrides:

withSSLParameters in class NessieClientBuilder.AbstractNessieClientBuilder

withHttp2Upgrade

@CanIgnoreReturnValue
public NessieHttpClientBuilderImpl withHttp2Upgrade(boolean http2Upgrade)

Description copied from interface: NessieHttpClientBuilder

Whether to allow HTTP/2 upgrade, default is false.

Only valid on Java 11 and newer with Java's new HTTP client.

Specified by:

withHttp2Upgrade in interface NessieHttpClientBuilder

Overrides:

withHttp2Upgrade in class NessieHttpClientBuilder.AbstractNessieHttpClientBuilder

withFollowRedirects

@CanIgnoreReturnValue
public NessieHttpClientBuilderImpl withFollowRedirects(String redirects)

Description copied from interface: NessieHttpClientBuilder

Whether HTTP redirects are followed, default is to not follow redirects.

Valid values are the enum names of HttpClient.Redirect.

Only valid on Java 11 and newer with Java's new HTTP client.

Specified by:

withFollowRedirects in interface NessieHttpClientBuilder

Overrides:

withFollowRedirects in class NessieHttpClientBuilder.AbstractNessieHttpClientBuilder

withForceUrlConnectionClient

@CanIgnoreReturnValue
public NessieHttpClientBuilderImpl withForceUrlConnectionClient(boolean forceUrlConnectionClient)

Description copied from interface: NessieHttpClientBuilder

Whether to force using the "old" URLConnection based client when running on Java 11 and newer with Java's new HTTP client.

Specified by:

withForceUrlConnectionClient in interface NessieHttpClientBuilder

Overrides:

withForceUrlConnectionClient in class NessieHttpClientBuilder.AbstractNessieHttpClientBuilder

withApiCompatibilityCheck

@CanIgnoreReturnValue
public NessieHttpClientBuilderImpl withApiCompatibilityCheck(boolean enable)

Specified by:

withApiCompatibilityCheck in interface NessieClientBuilder

Overrides:

withApiCompatibilityCheck in class NessieClientBuilder.AbstractNessieClientBuilder

withResponseFactory

@CanIgnoreReturnValue
public NessieHttpClientBuilderImpl withResponseFactory(HttpResponseFactory responseFactory)

Specified by:

withResponseFactory in interface NessieHttpClientBuilder

Overrides:

withResponseFactory in class NessieHttpClientBuilder.AbstractNessieHttpClientBuilder

build

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

Description copied from interface: NessieClientBuilder

Builds a new NessieApi.

Returns:

A new NessieApi.