Package org.projectnessie.client.http

Interface NessieHttpClientBuilder

All Superinterfaces:

NessieClientBuilder

All Known Implementing Classes:

NessieHttpClientBuilder.AbstractNessieHttpClientBuilder, NessieHttpClientBuilderImpl

public interface NessieHttpClientBuilder
extends NessieClientBuilder

HTTP specific Nessie client builder interface.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	NessieHttpClientBuilder.AbstractNessieHttpClientBuilder	Convenience base class for implementations of NessieHttpClientBuilder.

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

NessieClientBuilder.AbstractNessieClientBuilder

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. use withClientName(String) with the name URLConnection instead.
NessieHttpClientBuilder	withHttp2Upgrade(boolean http2Upgrade)	Whether to allow HTTP/2 upgrade, default is false.
NessieHttpClientBuilder	withHttpHeader(String header, String value)	Optionally configure additional HTTP headers.
NessieHttpClientBuilder	withReadTimeout(int readTimeoutMillis)	Sets the read-timeout in milliseconds for remote requests.
NessieHttpClientBuilder	withResponseFactory(HttpResponseFactory responseFactory)
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 interface org.projectnessie.client.NessieClientBuilder

asInstanceOf, build, fromSystemProperties, name, names, priority, withCancellationFuture, withSSLCertificateVerificationDisabled

Method Details

withHttp2Upgrade

@CanIgnoreReturnValue
NessieHttpClientBuilder withHttp2Upgrade(boolean http2Upgrade)

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

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

withFollowRedirects

@CanIgnoreReturnValue
NessieHttpClientBuilder withFollowRedirects(String redirects)

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.

withForceUrlConnectionClient

@Deprecated
@CanIgnoreReturnValue
NessieHttpClientBuilder withForceUrlConnectionClient(boolean forceUrlConnectionClient)

Deprecated.

use withClientName(String) with the name URLConnection instead.

Whether to force using the URLConnection based client.

withClientName

@CanIgnoreReturnValue
NessieHttpClientBuilder withClientName(String clientName)

withResponseFactory

@CanIgnoreReturnValue
NessieHttpClientBuilder withResponseFactory(HttpResponseFactory responseFactory)

addRequestFilter

@CanIgnoreReturnValue
NessieHttpClientBuilder addRequestFilter(RequestFilter filter)

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

addResponseFilter

@CanIgnoreReturnValue
NessieHttpClientBuilder addResponseFilter(ResponseFilter filter)

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

fromConfig

@CanIgnoreReturnValue
NessieHttpClientBuilder 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)

withApiCompatibilityCheck

@CanIgnoreReturnValue
NessieHttpClientBuilder withApiCompatibilityCheck(boolean enable)

Specified by:

withApiCompatibilityCheck in interface NessieClientBuilder

withAuthenticationFromConfig

@CanIgnoreReturnValue
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

Parameters:

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

Returns:

this

See Also:

• NessieClientBuilder.fromConfig(Function)

withAuthentication

@CanIgnoreReturnValue
NessieHttpClientBuilder 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

@CanIgnoreReturnValue
NessieHttpClientBuilder withTracing(boolean tracing)

Specified by:

withTracing in interface NessieClientBuilder

withUri

@CanIgnoreReturnValue
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

Parameters:

uri - server URI

Returns:

this

withUri

@CanIgnoreReturnValue
NessieHttpClientBuilder 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

withReadTimeout

@CanIgnoreReturnValue
NessieHttpClientBuilder withReadTimeout(int readTimeoutMillis)

Description copied from interface: NessieClientBuilder

Sets the read-timeout in milliseconds for remote requests.

Specified by:

withReadTimeout in interface NessieClientBuilder

withConnectionTimeout

@CanIgnoreReturnValue
NessieHttpClientBuilder withConnectionTimeout(int connectionTimeoutMillis)

Description copied from interface: NessieClientBuilder

Sets the connect-timeout in milliseconds for remote requests.

Specified by:

withConnectionTimeout in interface NessieClientBuilder

withDisableCompression

@CanIgnoreReturnValue
NessieHttpClientBuilder withDisableCompression(boolean disableCompression)

Description copied from interface: NessieClientBuilder

Disables compression for remote requests.

Specified by:

withDisableCompression in interface NessieClientBuilder

withSSLContext

@CanIgnoreReturnValue
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

withSSLParameters

@CanIgnoreReturnValue
NessieHttpClientBuilder withSSLParameters(SSLParameters sslParameters)

Description copied from interface: NessieClientBuilder

Optionally configure specific SSLParameters.

Specified by:

withSSLParameters in interface NessieClientBuilder

withHttpHeader

@CanIgnoreReturnValue
NessieHttpClientBuilder 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