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

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
NessieHttpClientBuilderImpl	addRequestFilter(RequestFilter filter)	Add a request filter to the client.
NessieHttpClientBuilderImpl	addResponseFilter(ResponseFilter filter)	Add a response filter to the client.
<API extends NessieApi> API	build(Class<API> apiVersion)	Builds a new NessieApi.
NessieHttpClientBuilderImpl	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.
String	name()	The name of the Nessie client implementation, for example HTTP for the HTTP/REST client.
Set<String>	names()	Client names supported by this implementation.
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	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.
NessieClientBuilder	withCancellationFuture(CompletionStage<?> cancellationFuture)	Registers a future to cancel an ongoing, blocking client setup.
NessieHttpClientBuilderImpl	withClientName(String clientName)
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)	Deprecated.
NessieHttpClientBuilderImpl	withHttp2Upgrade(boolean http2Upgrade)	Whether to allow HTTP/2 upgrade, default is false.
NessieHttpClientBuilder	withHttpHeader(String header, String value)	Optionally configure additional HTTP headers.
NessieHttpClientBuilderImpl	withReadTimeout(int readTimeoutMillis)	Set the read timeout in milliseconds for this client.
NessieHttpClientBuilderImpl	withResponseFactory(HttpResponseFactory responseFactory)
NessieHttpClientBuilderImpl	withSSLCertificateVerificationDisabled(boolean certificateVerificationDisabled)	Optional, disables certificate verifications, if set to true.
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(String uri)	Convenience method for NessieClientBuilder.withUri(URI) taking a string.
NessieHttpClientBuilderImpl	withUri(URI uri)	Set the Nessie server URI.

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

asInstanceOf, fromSystemProperties

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

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.

names

public Set<String> names()

Description copied from interface: NessieClientBuilder

Client names supported by this implementation.

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

Specified by:

withUri in interface NessieHttpClientBuilder

Overrides:

withUri in class NessieHttpClientBuilder.AbstractNessieHttpClientBuilder

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

Specified by:

withAuthentication in interface NessieHttpClientBuilder

Overrides:

withAuthentication in class NessieHttpClientBuilder.AbstractNessieHttpClientBuilder

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

Specified by:

withTracing in interface NessieHttpClientBuilder

Overrides:

withTracing in class NessieHttpClientBuilder.AbstractNessieHttpClientBuilder

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

Specified by:

withReadTimeout in interface NessieHttpClientBuilder

Overrides:

withReadTimeout in class NessieHttpClientBuilder.AbstractNessieHttpClientBuilder

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

Specified by:

withConnectionTimeout in interface NessieHttpClientBuilder

Overrides:

withConnectionTimeout in class NessieHttpClientBuilder.AbstractNessieHttpClientBuilder

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

Specified by:

withDisableCompression in interface NessieHttpClientBuilder

Overrides:

withDisableCompression in class NessieHttpClientBuilder.AbstractNessieHttpClientBuilder

Parameters:

disableCompression - whether the compression shall be disabled or not.

Returns:

this

withSSLCertificateVerificationDisabled

@CanIgnoreReturnValue
public NessieHttpClientBuilderImpl withSSLCertificateVerificationDisabled(boolean certificateVerificationDisabled)

Description copied from interface: NessieClientBuilder

Optional, disables certificate verifications, if set to true. Can be useful for testing purposes, not recommended for production systems.

Specified by:

withSSLCertificateVerificationDisabled in interface NessieClientBuilder

Overrides:

withSSLCertificateVerificationDisabled in class NessieHttpClientBuilder.AbstractNessieHttpClientBuilder

withSSLContext

@CanIgnoreReturnValue
public NessieHttpClientBuilderImpl withSSLContext(SSLContext sslContext)

Set the SSL context for this client.

Specified by:

withSSLContext in interface NessieClientBuilder

Specified by:

withSSLContext in interface NessieHttpClientBuilder

Overrides:

withSSLContext in class NessieHttpClientBuilder.AbstractNessieHttpClientBuilder

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

Specified by:

withSSLParameters in interface NessieHttpClientBuilder

Overrides:

withSSLParameters in class NessieHttpClientBuilder.AbstractNessieHttpClientBuilder

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
@Deprecated
public NessieHttpClientBuilderImpl withForceUrlConnectionClient(boolean forceUrlConnectionClient)

Deprecated.

Description copied from interface: NessieHttpClientBuilder

Whether to force using the URLConnection based client.

Specified by:

withForceUrlConnectionClient in interface NessieHttpClientBuilder

Overrides:

withForceUrlConnectionClient in class NessieHttpClientBuilder.AbstractNessieHttpClientBuilder

withClientName

@CanIgnoreReturnValue
public NessieHttpClientBuilderImpl withClientName(String clientName)

Specified by:

withClientName in interface NessieHttpClientBuilder

Overrides:

withClientName in class NessieHttpClientBuilder.AbstractNessieHttpClientBuilder

withApiCompatibilityCheck

@CanIgnoreReturnValue
public NessieHttpClientBuilderImpl withApiCompatibilityCheck(boolean enable)

Specified by:

withApiCompatibilityCheck in interface NessieClientBuilder

Specified by:

withApiCompatibilityCheck in interface NessieHttpClientBuilder

Overrides:

withApiCompatibilityCheck in class NessieHttpClientBuilder.AbstractNessieHttpClientBuilder

withResponseFactory

@CanIgnoreReturnValue
public NessieHttpClientBuilderImpl withResponseFactory(HttpResponseFactory responseFactory)

Specified by:

withResponseFactory in interface NessieHttpClientBuilder

Overrides:

withResponseFactory in class NessieHttpClientBuilder.AbstractNessieHttpClientBuilder

addRequestFilter

@CanIgnoreReturnValue
public NessieHttpClientBuilderImpl addRequestFilter(RequestFilter filter)

Description copied from interface: NessieHttpClientBuilder

Add a request filter to the client. Enables low-level access to the request/response processing.

Specified by:

addRequestFilter in interface NessieHttpClientBuilder

Overrides:

addRequestFilter in class NessieHttpClientBuilder.AbstractNessieHttpClientBuilder

addResponseFilter

@CanIgnoreReturnValue
public NessieHttpClientBuilderImpl addResponseFilter(ResponseFilter filter)

Description copied from interface: NessieHttpClientBuilder

Add a response filter to the client. Enables low-level access to the request/response processing.

Specified by:

addResponseFilter in interface NessieHttpClientBuilder

Overrides:

addResponseFilter in class NessieHttpClientBuilder.AbstractNessieHttpClientBuilder

fromConfig

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

Description copied from class: NessieHttpClientBuilder.AbstractNessieHttpClientBuilder

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

Specified by:

fromConfig in interface NessieHttpClientBuilder

Overrides:

fromConfig in class NessieHttpClientBuilder.AbstractNessieHttpClientBuilder

Parameters:

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

Returns:

this

See Also:

• NessieClientConfigSources

withAuthenticationFromConfig

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

Description copied from interface: NessieClientBuilder

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

Specified by:

withAuthenticationFromConfig in interface NessieHttpClientBuilder

Overrides:

withAuthenticationFromConfig in class NessieHttpClientBuilder.AbstractNessieHttpClientBuilder

Parameters:

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

Returns:

this

See Also:

• NessieClientBuilder.fromConfig(Function)

withUri

public NessieHttpClientBuilderImpl withUri(String uri)

Description copied from interface: NessieClientBuilder

Convenience method for NessieClientBuilder.withUri(URI) taking a string.

Specified by:

withUri in interface NessieClientBuilder

Specified by:

withUri in interface NessieHttpClientBuilder

Overrides:

withUri in class NessieHttpClientBuilder.AbstractNessieHttpClientBuilder

Parameters:

uri - server URI

Returns:

this

withHttpHeader

public NessieHttpClientBuilder withHttpHeader(String header,
 String value)

Description copied from interface: NessieClientBuilder

Optionally configure additional HTTP headers.

Specified by:

withHttpHeader in interface NessieClientBuilder

Specified by:

withHttpHeader in interface NessieHttpClientBuilder

Overrides:

withHttpHeader in class NessieHttpClientBuilder.AbstractNessieHttpClientBuilder

Parameters:

header - header name

value - header value

withCancellationFuture

public NessieClientBuilder withCancellationFuture(CompletionStage<?> cancellationFuture)

Description copied from interface: NessieClientBuilder

Registers a future to cancel an ongoing, blocking client setup.

When using "blocking" authentication, for example OAuth2 device or code flows, is being used, users may want to cancel an ongoing authentication. An application can register a callback that can be called asynchronously, for example from a SIGINT handler.

To implement cancellation:

 CompletableFuture<?> cancel = new CompletableFuture<>();

 registerYourInterruptHandler(cancel::complete);

 NessieClientBuilder.createClientBuilderFromSystemSettings(...)
   .withCancellationFuture(cancel);
 

Specified by:

withCancellationFuture in interface NessieClientBuilder

Overrides:

withCancellationFuture in class NessieClientBuilder.AbstractNessieClientBuilder

build

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

Description copied from interface: NessieClientBuilder

Builds a new NessieApi.

Returns:

A new NessieApi.