Package org.projectnessie.client.auth

Interface NessieAuthenticationProvider

All Known Implementing Classes:

AwsAuthenticationProvider, BasicAuthenticationProvider, BearerAuthenticationProvider, NoneAuthenticationProvider, OAuth2AuthenticationProvider

public interface NessieAuthenticationProvider

Base interface for different authentication methods like "basic" (username + plain password), bearer token, etc.

Method Summary

Modifier and Type	Method	Description
NessieAuthentication	build(Function<String,String> configSupplier)	Build the implementation that provides authentication credentials using the given parameters.
static NessieAuthentication	fromConfig(Function<String,String> configuration)	Configure a NessieAuthentication instance using the configuration supplied by configuration.
String	getAuthTypeValue()	The authentication type discriminator.

Method Details

fromConfig

static NessieAuthentication fromConfig(Function<String,String> configuration)

Configure a NessieAuthentication instance using the configuration supplied by configuration.

Checks all instances returned by Java's ServiceLoader for the NessieAuthenticationProvider interface.

Uses the config option NessieConfigConstants.CONF_NESSIE_AUTH_TYPE to determine the authentication type by comparing the config value with the value returned by implementations' getAuthTypeValue(). If NessieConfigConstants.CONF_NESSIE_AUTH_TYPE is not configured, null will be returned. If no implementation could be found, an IllegalArgumentException is thrown.

If a NessieAuthenticationProvider instance was found, the implementation's builder build(Function) will be called.

getAuthTypeValue

String getAuthTypeValue()

The authentication type discriminator. If authentication is configured via properties, like NessieClientBuilder.fromConfig(Function)/NessieClientBuilder.withAuthenticationFromConfig(Function), set the a NessieAuthenticationProvider instance is used, if NessieConfigConstants.CONF_NESSIE_AUTH_TYPE equals the value returned by this method.

build

NessieAuthentication build(Function<String,String> configSupplier)

Build the implementation that provides authentication credentials using the given parameters.

The implementation must throw appropriate exceptions, like NullPointerException or IllegalArgumentException with proper and readable explanations, if mandatory configuration options are missing or have wrong/incompatible/invalid values.