Package org.projectnessie.client

Class NessieClientBuilder.AbstractNessieClientBuilder

java.lang.Object

org.projectnessie.client.NessieClientBuilder.AbstractNessieClientBuilder

All Implemented Interfaces:

NessieClientBuilder

Direct Known Subclasses:

NessieHttpClientBuilder.AbstractNessieHttpClientBuilder

Enclosing interface:

NessieClientBuilder

public abstract static class NessieClientBuilder.AbstractNessieClientBuilder
extends Object
implements NessieClientBuilder

Convenience base class for implementations of NessieClientBuilder.

Nested Class Summary

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

NessieClientBuilder.AbstractNessieClientBuilder

Constructor Summary

Constructors

Constructor	Description
AbstractNessieClientBuilder()

Method Summary

Modifier and Type	Method	Description
<I extends NessieClientBuilder> I	asInstanceOf(Class<I> builderInterfaceType)
NessieClientBuilder	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.
NessieClientBuilder	fromSystemProperties()	Deprecated.
NessieClientBuilder	withApiCompatibilityCheck(boolean enable)
NessieClientBuilder	withAuthentication(NessieAuthentication authentication)	Sets the NessieAuthentication instance to be used.
NessieClientBuilder	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.
NessieClientBuilder	withConnectionTimeout(int connectionTimeoutMillis)	Sets the connect-timeout in milliseconds for remote requests.
NessieClientBuilder	withDisableCompression(boolean disableCompression)	Disables compression for remote requests.
NessieClientBuilder	withHttpHeader(String header, String value)	Optionally configure additional HTTP headers.
NessieClientBuilder	withReadTimeout(int readTimeoutMillis)	Sets the read-timeout in milliseconds for remote requests.
NessieClientBuilder	withSSLCertificateVerificationDisabled(boolean certificateVerificationDisabled)	Optional, disables certificate verifications, if set to true.
NessieClientBuilder	withSSLContext(SSLContext sslContext)	Optionally configure a specific SSLContext, currently only the Java 11+ accepts this option.
NessieClientBuilder	withSSLParameters(SSLParameters sslParameters)	Optionally configure specific SSLParameters.
NessieClientBuilder	withTracing(boolean tracing)
NessieClientBuilder	withUri(String uri)	Convenience method for NessieClientBuilder.withUri(URI) taking a string.
NessieClientBuilder	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

Methods inherited from interface org.projectnessie.client.NessieClientBuilder

build, name, names, priority

Constructor Details

AbstractNessieClientBuilder

public AbstractNessieClientBuilder()

Method Details

fromSystemProperties

@Deprecated
public NessieClientBuilder fromSystemProperties()

Deprecated.

Description copied from interface: NessieClientBuilder

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

Specified by:

fromSystemProperties in interface NessieClientBuilder

Returns:

this

See Also:

• NessieClientBuilder.fromConfig(Function)

fromConfig

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

Description copied from interface: NessieClientBuilder

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.

Calls NessieClientBuilder.withAuthenticationFromConfig(Function).

Specified by:

fromConfig in interface NessieClientBuilder

Parameters:

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

Returns:

this

See Also:

• NessieClientConfigSources
• NessieClientBuilder.withAuthenticationFromConfig(Function)

withAuthenticationFromConfig

public NessieClientBuilder 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

Parameters:

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

Returns:

this

See Also:

• NessieClientBuilder.fromConfig(Function)

withUri

public NessieClientBuilder withUri(String uri)

Description copied from interface: NessieClientBuilder

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

Specified by:

withUri in interface NessieClientBuilder

Parameters:

uri - server URI

Returns:

this

asInstanceOf

public <I extends NessieClientBuilder> I asInstanceOf(Class<I> builderInterfaceType)

Specified by:

asInstanceOf in interface NessieClientBuilder

withApiCompatibilityCheck

public NessieClientBuilder withApiCompatibilityCheck(boolean enable)

Specified by:

withApiCompatibilityCheck in interface NessieClientBuilder

withAuthentication

public NessieClientBuilder withAuthentication(NessieAuthentication authentication)

Description copied from interface: NessieClientBuilder

Sets the NessieAuthentication instance to be used.

Specified by:

withAuthentication in interface NessieClientBuilder

Parameters:

authentication - authentication for this client

Returns:

this

withTracing

public NessieClientBuilder withTracing(boolean tracing)

Specified by:

withTracing in interface NessieClientBuilder

withUri

public NessieClientBuilder withUri(URI uri)

Description copied from interface: NessieClientBuilder

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

Specified by:

withUri in interface NessieClientBuilder

Parameters:

uri - server URI

Returns:

this

withReadTimeout

public NessieClientBuilder withReadTimeout(int readTimeoutMillis)

Description copied from interface: NessieClientBuilder

Sets the read-timeout in milliseconds for remote requests.

Specified by:

withReadTimeout in interface NessieClientBuilder

withConnectionTimeout

public NessieClientBuilder withConnectionTimeout(int connectionTimeoutMillis)

Description copied from interface: NessieClientBuilder

Sets the connect-timeout in milliseconds for remote requests.

Specified by:

withConnectionTimeout in interface NessieClientBuilder

withDisableCompression

public NessieClientBuilder withDisableCompression(boolean disableCompression)

Description copied from interface: NessieClientBuilder

Disables compression for remote requests.

Specified by:

withDisableCompression in interface NessieClientBuilder

withSSLCertificateVerificationDisabled

public NessieClientBuilder 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

withSSLContext

public NessieClientBuilder withSSLContext(SSLContext sslContext)

Description copied from interface: NessieClientBuilder

Optionally configure a specific SSLContext, currently only the Java 11+ accepts this option.

Specified by:

withSSLContext in interface NessieClientBuilder

withSSLParameters

public NessieClientBuilder withSSLParameters(SSLParameters sslParameters)

Description copied from interface: NessieClientBuilder

Optionally configure specific SSLParameters.

Specified by:

withSSLParameters in interface NessieClientBuilder

withHttpHeader

public NessieClientBuilder withHttpHeader(String header,
 String value)

Description copied from interface: NessieClientBuilder

Optionally configure additional HTTP headers.

Specified by:

withHttpHeader in interface NessieClientBuilder

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