Package org.projectnessie.client

Class NessieClient.Builder

java.lang.Object

org.projectnessie.client.NessieClient.Builder

Enclosing interface:

NessieClient

public static class NessieClient.Builder
extends Object

Builder to configure a new NessieClient. Currently, the NessieClient.Builder is only capable of building a NessieClient for HTTP, but that may change.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
NessieClient	build()	Build a new NessieClient.
NessieClient.Builder	fromConfig(Function<String,String> configuration)	Configure this builder instance using a configuration object and standard Nessie configuration keys defined by the constants defined in NessieConfigConstants.
NessieClient.Builder	fromSystemProperties()	Same semantics as fromConfig(Function), uses the system properties.
NessieClient.Builder	withAuthType(NessieClient.AuthType authType)	Set the authentication type.
NessieClient.Builder	withConnectionTimeout(int connectionTimeoutMillis)	Set the connection timeout in milliseconds for this client.
NessieClient.Builder	withPassword(String password)	Set the password for NessieClient.AuthType.BASIC authentication.
NessieClient.Builder	withReadTimeout(int readTimeoutMillis)	Set the read timeout in milliseconds for this client.
NessieClient.Builder	withTracing(boolean tracing)	Whether to enable adding the HTTP headers of an active OpenTracing span to all Nessie requests.
NessieClient.Builder	withUri(String uri)	Convenience method for withUri(URI) taking a string.
NessieClient.Builder	withUri(URI uri)	Set the Nessie server URI.
NessieClient.Builder	withUsername(String username)	Set the username for NessieClient.AuthType.BASIC authentication.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

fromSystemProperties

public NessieClient.Builder fromSystemProperties()

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

Returns:

this

See Also:

fromConfig(Function)

fromConfig

public NessieClient.Builder fromConfig(Function<String,String> configuration)

Configure this builder 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.

Parameters:

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

Returns:

this

See Also:

fromSystemProperties()

withAuthType

public NessieClient.Builder withAuthType(NessieClient.AuthType authType)

Set the authentication type. Default is NessieClient.AuthType.NONE.

Parameters:

authType - new auth-type

Returns:

this

withUri

public NessieClient.Builder withUri(URI uri)

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

Parameters:

uri - server URI

Returns:

this

withUri

public NessieClient.Builder withUri(String uri)

Convenience method for withUri(URI) taking a string.

Parameters:

uri - server URI

Returns:

this

withUsername

public NessieClient.Builder withUsername(String username)

Set the username for NessieClient.AuthType.BASIC authentication.

Parameters:

username - username

Returns:

this

withPassword

public NessieClient.Builder withPassword(String password)

Set the password for NessieClient.AuthType.BASIC authentication.

Parameters:

password - password

Returns:

this

withTracing

public NessieClient.Builder 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.

Parameters:

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

Returns:

this

withReadTimeout

public NessieClient.Builder withReadTimeout(int readTimeoutMillis)

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

Parameters:

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

Returns:

this

withConnectionTimeout

public NessieClient.Builder withConnectionTimeout(int connectionTimeoutMillis)

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

Parameters:

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

Returns:

this

build

public NessieClient build()

Build a new NessieClient.

Returns:

new NessieClient