Package org.projectnessie.client.http

Class NessieHttpClientBuilder.AbstractNessieHttpClientBuilder

java.lang.Object

org.projectnessie.client.NessieClientBuilder.AbstractNessieClientBuilder

org.projectnessie.client.http.NessieHttpClientBuilder.AbstractNessieHttpClientBuilder

All Implemented Interfaces:

NessieHttpClientBuilder, NessieClientBuilder

Direct Known Subclasses:

NessieHttpClientBuilderImpl

Enclosing interface:

NessieHttpClientBuilder

public abstract static class NessieHttpClientBuilder.AbstractNessieHttpClientBuilder
extends NessieClientBuilder.AbstractNessieClientBuilder
implements NessieHttpClientBuilder

Convenience base class for implementations of NessieHttpClientBuilder.

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
AbstractNessieHttpClientBuilder()

Method Summary

Modifier and Type	Method	Description
NessieHttpClientBuilder	addRequestFilter(RequestFilter filter)	Add a request filter to the client.
NessieHttpClientBuilder	addResponseFilter(ResponseFilter filter)	Add a response filter to the client.
NessieHttpClientBuilder	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.
NessieHttpClientBuilder	withApiCompatibilityCheck(boolean enable)
NessieHttpClientBuilder	withAuthentication(NessieAuthentication authentication)	Sets the NessieAuthentication instance to be used.
NessieHttpClientBuilder	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.
NessieHttpClientBuilder	withClientName(String clientName)
NessieHttpClientBuilder	withConnectionTimeout(int connectionTimeoutMillis)	Sets the connect-timeout in milliseconds for remote requests.
NessieHttpClientBuilder	withDisableCompression(boolean disableCompression)	Disables compression for remote requests.
NessieHttpClientBuilder	withFollowRedirects(String redirects)	Whether HTTP redirects are followed, default is to not follow redirects.
NessieHttpClientBuilder	withForceUrlConnectionClient(boolean forceUrlConnectionClient)	Deprecated.
NessieHttpClientBuilder	withHttp2Upgrade(boolean http2Upgrade)	Whether to allow HTTP/2 upgrade, default is false.
NessieHttpClientBuilder	withReadTimeout(int readTimeoutMillis)	Sets the read-timeout in milliseconds for remote requests.
NessieHttpClientBuilder	withResponseFactory(HttpResponseFactory responseFactory)
NessieHttpClientBuilder	withSSLCertificateVerificationDisabled(boolean certificateVerificationDisabled)	Optional, disables certificate verifications, if set to true.
NessieHttpClientBuilder	withSSLContext(SSLContext sslContext)	Optionally configure a specific SSLContext, currently only the Java 11+ accepts this option.
NessieHttpClientBuilder	withSSLParameters(SSLParameters sslParameters)	Optionally configure specific SSLParameters.
NessieHttpClientBuilder	withTracing(boolean tracing)
NessieHttpClientBuilder	withUri(String uri)	Convenience method for NessieClientBuilder.withUri(URI) taking a string.
NessieHttpClientBuilder	withUri(URI uri)	Set the Nessie server URI.

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

asInstanceOf, fromSystemProperties, withCancellationFuture

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, build, fromSystemProperties, name, names, priority, withCancellationFuture

Constructor Details

AbstractNessieHttpClientBuilder

public AbstractNessieHttpClientBuilder()

Method Details

fromConfig

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

Specified by:

fromConfig in interface NessieHttpClientBuilder

Overrides:

fromConfig in class NessieClientBuilder.AbstractNessieClientBuilder

Parameters:

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

Returns:

this

See Also:

• NessieClientConfigSources

withHttp2Upgrade

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

withFollowRedirects

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

withForceUrlConnectionClient

@Deprecated
public NessieHttpClientBuilder withForceUrlConnectionClient(boolean forceUrlConnectionClient)

Deprecated.

Description copied from interface: NessieHttpClientBuilder

Whether to force using the URLConnection based client.

Specified by:

withForceUrlConnectionClient in interface NessieHttpClientBuilder

withClientName

public NessieHttpClientBuilder withClientName(String clientName)

Specified by:

withClientName in interface NessieHttpClientBuilder

withResponseFactory

public NessieHttpClientBuilder withResponseFactory(HttpResponseFactory responseFactory)

Specified by:

withResponseFactory in interface NessieHttpClientBuilder

addRequestFilter

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

addResponseFilter

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

withAuthenticationFromConfig

public NessieHttpClientBuilder 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 NessieClientBuilder.AbstractNessieClientBuilder

Parameters:

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

Returns:

this

See Also:

• NessieClientBuilder.fromConfig(Function)

withUri

public NessieHttpClientBuilder 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 NessieClientBuilder.AbstractNessieClientBuilder

Parameters:

uri - server URI

Returns:

this

withApiCompatibilityCheck

public NessieHttpClientBuilder withApiCompatibilityCheck(boolean enable)

Specified by:

withApiCompatibilityCheck in interface NessieClientBuilder

Specified by:

withApiCompatibilityCheck in interface NessieHttpClientBuilder

Overrides:

withApiCompatibilityCheck in class NessieClientBuilder.AbstractNessieClientBuilder

withAuthentication

public NessieHttpClientBuilder 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 NessieClientBuilder.AbstractNessieClientBuilder

Parameters:

authentication - authentication for this client

Returns:

this

withTracing

public NessieHttpClientBuilder withTracing(boolean tracing)

Specified by:

withTracing in interface NessieClientBuilder

Specified by:

withTracing in interface NessieHttpClientBuilder

Overrides:

withTracing in class NessieClientBuilder.AbstractNessieClientBuilder

withUri

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

Specified by:

withUri in interface NessieHttpClientBuilder

Overrides:

withUri in class NessieClientBuilder.AbstractNessieClientBuilder

Parameters:

uri - server URI

Returns:

this

withReadTimeout

public NessieHttpClientBuilder withReadTimeout(int readTimeoutMillis)

Description copied from interface: NessieClientBuilder

Sets the read-timeout in milliseconds for remote requests.

Specified by:

withReadTimeout in interface NessieClientBuilder

Specified by:

withReadTimeout in interface NessieHttpClientBuilder

Overrides:

withReadTimeout in class NessieClientBuilder.AbstractNessieClientBuilder

withConnectionTimeout

public NessieHttpClientBuilder withConnectionTimeout(int connectionTimeoutMillis)

Description copied from interface: NessieClientBuilder

Sets the connect-timeout in milliseconds for remote requests.

Specified by:

withConnectionTimeout in interface NessieClientBuilder

Specified by:

withConnectionTimeout in interface NessieHttpClientBuilder

Overrides:

withConnectionTimeout in class NessieClientBuilder.AbstractNessieClientBuilder

withDisableCompression

public NessieHttpClientBuilder withDisableCompression(boolean disableCompression)

Description copied from interface: NessieClientBuilder

Disables compression for remote requests.

Specified by:

withDisableCompression in interface NessieClientBuilder

Specified by:

withDisableCompression in interface NessieHttpClientBuilder

Overrides:

withDisableCompression in class NessieClientBuilder.AbstractNessieClientBuilder

withSSLCertificateVerificationDisabled

public NessieHttpClientBuilder 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 NessieClientBuilder.AbstractNessieClientBuilder

withSSLContext

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

Specified by:

withSSLContext in interface NessieHttpClientBuilder

Overrides:

withSSLContext in class NessieClientBuilder.AbstractNessieClientBuilder

withSSLParameters

public NessieHttpClientBuilder 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 NessieClientBuilder.AbstractNessieClientBuilder