liquibase.configuration
Class LiquibaseConfiguration

java.lang.Object
  extended by liquibase.configuration.LiquibaseConfiguration

public class LiquibaseConfiguration
extends Object

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

This class is the top level container used to access ConfigurationContainer implementations which contain the actual configuration properties. Normal use is to call LiquibaseConfiguration.getInstance().getConfiguration(NEEDED_CONFIGURATION.class).getYOUR_PROPERTY()

This class is implemented as a singleton with a single global set of configuration objects, but the setInstance(LiquibaseConfiguration) method can be used to replace the singleton with an alternate implementation that uses ThreadLocal objects or any other way of managing configurations.


Constructor Summary
protected LiquibaseConfiguration()
          Constructor protected to prevent construction outside getInstance()
 
Method Summary
protected
<T extends ConfigurationContainer>
T
createConfiguration(Class<T> type)
           
 String describeValueLookupLogic(Class<? extends ConfigurationContainer> config, String property)
          Convenience method for describeValueLookupLogic(ConfigurationProperty)
 String describeValueLookupLogic(ConfigurationProperty property)
          Generates a human consumable description of how the configured ConfigurationValueProvider(s) will attempt to set a default value.
<T extends ConfigurationContainer>
T
getConfiguration(Class<T> type)
          Return an instance of the passed AbstractConfigurationContainer type.
static LiquibaseConfiguration getInstance()
          Returns the singleton instance, creating it if necessary.
 ConfigurationProperty getProperty(Class<? extends ConfigurationContainer> type, String property)
          Convenience method for liquibaseConfiguration.getConfiguration(type).getProperty(property)
 void init(ConfigurationValueProvider... configurationValueProviders)
          Re-initialize the configuration with the given ConfigurationProviders.
 void reset()
          Resets existing AbstractConfigurationContainer instances to their default values.
static void setInstance(LiquibaseConfiguration instance)
          Overrides the standard singleton instance created by getInstance().
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LiquibaseConfiguration

protected LiquibaseConfiguration()
Constructor protected to prevent construction outside getInstance()

Method Detail

getInstance

public static LiquibaseConfiguration getInstance()
Returns the singleton instance, creating it if necessary. On creation, the configuration is initialized with SystemPropertyProvider


setInstance

public static void setInstance(LiquibaseConfiguration instance)
Overrides the standard singleton instance created by getInstance(). Useful for alternate implementations with more complex AbstractConfigurationContainer lookup logic such as different configurations per thread.


init

public void init(ConfigurationValueProvider... configurationValueProviders)
Re-initialize the configuration with the given ConfigurationProviders. Any existing AbstractConfigurationContainer instances are reset to defaults.


reset

public void reset()
Resets existing AbstractConfigurationContainer instances to their default values.


getConfiguration

public <T extends ConfigurationContainer> T getConfiguration(Class<T> type)
Return an instance of the passed AbstractConfigurationContainer type. The same instance is returned from every call to getConfiguration()


getProperty

public ConfigurationProperty getProperty(Class<? extends ConfigurationContainer> type,
                                         String property)
Convenience method for liquibaseConfiguration.getConfiguration(type).getProperty(property)


createConfiguration

protected <T extends ConfigurationContainer> T createConfiguration(Class<T> type)

describeValueLookupLogic

public String describeValueLookupLogic(Class<? extends ConfigurationContainer> config,
                                       String property)
Convenience method for describeValueLookupLogic(ConfigurationProperty)


describeValueLookupLogic

public String describeValueLookupLogic(ConfigurationProperty property)
Generates a human consumable description of how the configured ConfigurationValueProvider(s) will attempt to set a default value.



Copyright © 2016 Liquibase.org. All rights reserved.