Package org.projectnessie.client.config

Class NessieClientConfigSources

java.lang.Object

org.projectnessie.client.config.NessieClientConfigSources

public final class NessieClientConfigSources
extends java.lang.Object

Provides functionality to retrieve configuration values from various sources, like Java properties, maps and environment variables.

Note that the current implementation does not need any additional libraries. If there is a need for advanced features like config encryption or expressions, the implementation might start using SmallRye-Config.

Method Summary

Modifier and Type	Method	Description
static NessieClientConfigSource	defaultConfigSources()	Creates a configuration value retriever using reasonable default config sources.
static NessieClientConfigSource	dotEnvFileConfigSource()	Uses values from the ~/.env file.
static NessieClientConfigSource	emptyConfigSource()
static NessieClientConfigSource	environmentConfigSource(java.util.Map<java.lang.String,java.lang.String> environment)	Uses values from the given map, where keys in the file follow the environment name mapping.
static NessieClientConfigSource	environmentFileConfigSource(java.nio.file.Path envFile)	Uses values from the given file, where keys in the file follow the environment name mapping.
static NessieClientConfigSource	mapConfigSource(java.util.Map<java.lang.String,java.lang.String> properties)	Uses values from the given Map.
static NessieClientConfigSource	nessieClientConfigFileConfigSource()	Uses values from the ~/.config/nessie/nessie-client.properties file.
static NessieClientConfigSource	propertiesConfigSource(java.util.Properties properties)	Uses values from the given Properties.
static NessieClientConfigSource	propertiesFileConfigSource(java.nio.file.Path propertiesFile)	Uses values from the given properties file.
static java.lang.String	propertyNameToEnvironmentName(java.lang.String propertyName)	Converts a given property name to the "environment variable name syntax", using upper-case characters and converting . ("dot") and - ("minus") to _ ("underscore").
static NessieClientConfigSource	systemEnvironmentConfigSource()	Uses values from the system environment, keys follow the environment name mapping.
static NessieClientConfigSource	systemPropertiesConfigSource()	Uses values from the Java system properties of the process.

Methods inherited from class java.lang.Object

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

Method Detail

dotEnvFileConfigSource

public static NessieClientConfigSource dotEnvFileConfigSource()

Uses values from the ~/.env file.

Similar to the behavior of smallrye-config, the ~/.env file must be in the Java properties file format.

See Also:

environmentFileConfigSource(Path), propertyNameToEnvironmentName(String)

nessieClientConfigFileConfigSource

public static NessieClientConfigSource nessieClientConfigFileConfigSource()

Uses values from the ~/.config/nessie/nessie-client.properties file.

See Also:

systemPropertiesConfigSource(), propertiesFileConfigSource(Path), propertiesConfigSource(Properties)

systemEnvironmentConfigSource

public static NessieClientConfigSource systemEnvironmentConfigSource()

Uses values from the system environment, keys follow the environment name mapping.

See Also:

environmentConfigSource(Map), dotEnvFileConfigSource()

systemPropertiesConfigSource

public static NessieClientConfigSource systemPropertiesConfigSource()

Uses values from the Java system properties of the process.

See Also:

propertiesConfigSource(Properties)

environmentFileConfigSource

public static NessieClientConfigSource environmentFileConfigSource(java.nio.file.Path envFile)

Uses values from the given file, where keys in the file follow the environment name mapping.

Similar to the behavior of smallrye-config, the .env file must be in the Java properties file format.

See Also:

dotEnvFileConfigSource(), propertyNameToEnvironmentName(String)

environmentConfigSource

public static NessieClientConfigSource environmentConfigSource(java.util.Map<java.lang.String,java.lang.String> environment)

Uses values from the given map, where keys in the file follow the environment name mapping.

See Also:

systemEnvironmentConfigSource(), environmentFileConfigSource(Path), dotEnvFileConfigSource()

propertiesFileConfigSource

public static NessieClientConfigSource propertiesFileConfigSource(java.nio.file.Path propertiesFile)

Uses values from the given properties file.

See Also:

propertiesConfigSource(Properties), nessieClientConfigFileConfigSource()

propertiesConfigSource

public static NessieClientConfigSource propertiesConfigSource(java.util.Properties properties)

Uses values from the given Properties.

See Also:

systemPropertiesConfigSource(), mapConfigSource(Map)

mapConfigSource

public static NessieClientConfigSource mapConfigSource(java.util.Map<java.lang.String,java.lang.String> properties)

Uses values from the given Map.

See Also:

propertiesConfigSource(Properties)

propertyNameToEnvironmentName

public static java.lang.String propertyNameToEnvironmentName(java.lang.String propertyName)

Converts a given property name to the "environment variable name syntax", using upper-case characters and converting . ("dot") and - ("minus") to _ ("underscore").

defaultConfigSources

public static NessieClientConfigSource defaultConfigSources()

Creates a configuration value retriever using reasonable default config sources.

Config values are retrieved from the following sources:

1. Java system properties, see systemPropertiesConfigSource()
2. Process environment, see systemEnvironmentConfigSource()
3. ~/.config/nessie/nessie-client-properties file, see nessieClientConfigFileConfigSource()
4. ~/.env file, see dotEnvFileConfigSource()

emptyConfigSource

public static NessieClientConfigSource emptyConfigSource()