Package liquibase.configuration

Class LiquibaseConfiguration

java.lang.Object

liquibase.configuration.LiquibaseConfiguration

All Implemented Interfaces:

SingletonObject

public class LiquibaseConfiguration
extends Object
implements SingletonObject

Provides unified management of configuration properties within Liquibase core and in extensions.

Because this class focuses on raw/untyped access to what is actually configured, it is usually best to interact with ConfigurationDefinition instances which provide type safety, standardized key naming, default values, and more.

"Registered" configuration definitions will be available for generated help.

This class will search through the configured ConfigurationValueProviders. Standard value providers are auto-loaded on startup, but more can be added/removed at runtime.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	REGISTERED_VALUE_PROVIDERS_KEY
static final String	SCOPED_VALUE_PROVIDERS_KEY	Scope key holding a List<ConfigurationValueProvider> visible only to the current scope and its children.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	LiquibaseConfiguration()

Method Summary

Modifier and Type	Method	Description
<T extends ConfigurationContainer> T	getConfiguration(Class<T> type)	Deprecated. use ConfigurationDefinition instances directly
<DataType> ConfiguredValue<DataType>	getCurrentConfiguredValue(ConfigurationValueConverter<DataType> converter, ConfigurationValueObfuscator<DataType> obfuscator, String... keyAndAliases)	Convenience method for getCurrentConfiguredValue(ConfigurationValueConverter, ConfigurationValueObfuscator, ConfigurationValueProvider[], String...) with no additional value providers.
<DataType> ConfiguredValue<DataType>	getCurrentConfiguredValue(ConfigurationValueConverter<DataType> converter, ConfigurationValueObfuscator<DataType> obfuscator, ConfigurationValueProvider[] additionalValueProviders, String... keyAndAliases)	Searches for the given keys in the current providers and applies any applicable modifiers.
List<ConfigurationValueProvider>	getEffectiveProviders()	Returns the globally registered providers merged with the current scope's ones, ordered by ConfigurationValueProvider.getPrecedence() exactly as getCurrentConfiguredValue(liquibase.configuration.ConfigurationValueConverter<DataType>, liquibase.configuration.ConfigurationValueObfuscator<DataType>, java.lang.String...) resolves them.
static LiquibaseConfiguration	getInstance()	Deprecated. use Scope.getSingleton(Class)
ConfigurationValueProvider	getProvider(ConfigurationValueProvider provider)
SortedSet<ConfigurationValueProvider>	getProviders()	Returns only the globally registered providers.
ConfigurationDefinition<?>	getRegisteredDefinition(String key)
SortedSet<ConfigurationDefinition<?>>	getRegisteredDefinitions(boolean includeInternal)	Returns all registered ConfigurationDefinitions.
void	init(Scope scope)	Finishes configuration of this service.
void	registerDefinition(ConfigurationDefinition<?> definition)	Registers a ConfigurationDefinition so it will be returned by getRegisteredDefinitions(boolean)
void	registerProvider(ConfigurationValueProvider valueProvider)	Adds a new ConfigurationValueProvider to the active collection of providers.
boolean	removeProvider(ConfigurationValueProvider provider)	Removes a specific ConfigurationValueProvider from the active collection of providers.
boolean	unregisterProvider(ConfigurationValueProvider valueProvider)	Removes the given ConfigurationValueProvider from the active collection of providers.

Methods inherited from class java.lang.Object

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

Field Details

SCOPED_VALUE_PROVIDERS_KEY

public static final String SCOPED_VALUE_PROVIDERS_KEY

Scope key holding a List<ConfigurationValueProvider> visible only to the current scope and its children. Integrations that run executions side by side (CLI, maven) put their per-execution providers here instead of registerProvider(ConfigurationValueProvider), so one execution's arguments never leak into or vanish from another running in parallel.

A nested scope that sets this key shadows the outer list rather than combining with it; integrations set it once per execution.

See Also:

• Constant Field Values

REGISTERED_VALUE_PROVIDERS_KEY

public static final String REGISTERED_VALUE_PROVIDERS_KEY

See Also:

• Constant Field Values

Constructor Details

LiquibaseConfiguration

protected LiquibaseConfiguration()

Method Details

getInstance

public static LiquibaseConfiguration getInstance()

Deprecated.

use Scope.getSingleton(Class)

init

public void init(Scope scope)

Finishes configuration of this service. Called as the root scope is set up, should not be called elsewhere.

registerProvider

public void registerProvider(ConfigurationValueProvider valueProvider)

Adds a new ConfigurationValueProvider to the active collection of providers.

unregisterProvider

public boolean unregisterProvider(ConfigurationValueProvider valueProvider)

Removes the given ConfigurationValueProvider from the active collection of providers.

Returns:

true if the given provider was previously registered.

removeProvider

public boolean removeProvider(ConfigurationValueProvider provider)

Removes a specific ConfigurationValueProvider from the active collection of providers.

Returns:

true if the provider was removed.

getConfiguration

public <T extends ConfigurationContainer> T getConfiguration(Class<T> type)

Deprecated.

use ConfigurationDefinition instances directly

getProviders

public SortedSet<ConfigurationValueProvider> getProviders()

Returns only the globally registered providers. Callers that need everything resolution would see, including the current scope's per-execution providers, want getEffectiveProviders().

getEffectiveProviders

public List<ConfigurationValueProvider> getEffectiveProviders()

Returns the globally registered providers merged with the current scope's ones, ordered by ConfigurationValueProvider.getPrecedence() exactly as getCurrentConfiguredValue(liquibase.configuration.ConfigurationValueConverter<DataType>, liquibase.configuration.ConfigurationValueObfuscator<DataType>, java.lang.String...) resolves them.

getProvider

public ConfigurationValueProvider getProvider(ConfigurationValueProvider provider)

getCurrentConfiguredValue

public <DataType> ConfiguredValue<DataType> getCurrentConfiguredValue(ConfigurationValueConverter<DataType> converter,
 ConfigurationValueObfuscator<DataType> obfuscator,
 String... keyAndAliases)

Convenience method for getCurrentConfiguredValue(ConfigurationValueConverter, ConfigurationValueObfuscator, ConfigurationValueProvider[], String...) with no additional value providers.

getCurrentConfiguredValue

public <DataType> ConfiguredValue<DataType> getCurrentConfiguredValue(ConfigurationValueConverter<DataType> converter,
 ConfigurationValueObfuscator<DataType> obfuscator,
 ConfigurationValueProvider[] additionalValueProviders,
 String... keyAndAliases)

Searches for the given keys in the current providers and applies any applicable modifiers.

Parameters:

additionalValueProviders - additional ConfigurationValueProviders to use with higher priority than the ones registered in LiquibaseConfiguration. The higher the array index, the higher the priority. Can be null.

keyAndAliases - The first element should be the canonical key name, with later elements being aliases. At least one element must be provided.

Returns:

the value for the key, or null if not configured.

registerDefinition

public void registerDefinition(ConfigurationDefinition<?> definition)

Registers a ConfigurationDefinition so it will be returned by getRegisteredDefinitions(boolean)

getRegisteredDefinitions

public SortedSet<ConfigurationDefinition<?>> getRegisteredDefinitions(boolean includeInternal)

Returns all registered ConfigurationDefinitions. Registered definitions are used for generated help documentation.

Parameters:

includeInternal - if true, include ConfigurationDefinition.isInternal() definitions.

getRegisteredDefinition

public ConfigurationDefinition<?> getRegisteredDefinition(String key)

Returns:

the registered ConfigurationDefinition associated with this key. Null if none match.