Modifier and Type	Class and Description
public static enum	Scope.Attr Enumeration containing standard attributes.
public static interface	Scope.ScopedRunner<T>
public static interface	Scope.ScopedRunnerWithReturn<T>

Modifier and Type	Field and Description
private static final Map<String, List<MdcObject>>	addedMdcEntries
public static final String	JAVA_PROPERTIES
private LiquibaseListener	listener
private final Scope	parent
private final String	scopeId
private static ScopeManager	scopeManager
private final SmartMap	values

Access	Constructor and Description
private	Scope() Creates a new "root" scope.
protected	Scope(Scope The new Scopes parent in the hierarchy of Scopes, not null. parent, Map<String, Object> The values for the new Scope. scopeValues)

Method Summary

Modifier and Type	Method and Description
public MdcObject	addMdcValue(String key, String value) Add a key value pair to the MDC using the MDC manager.
public MdcObject	addMdcValue(String key, String value, boolean if true, this key value pair will be automatically removed from the MDC when this scope exits. If there is not a demonstrable reason for setting this parameter to false then it should be set to true. removeWhenScopeExits) Add a key value pair to the MDC using the MDC manager.
public MdcObject	addMdcValue(String key, Map<String, Object> value) Add a key value pair to the MDC using the MDC manager.
public MdcObject	addMdcValue(String key, Map<String, Object> value, boolean if true, this key value pair will be automatically removed from the MDC when this scope exits. If there is not a demonstrable reason for setting this parameter to false then it should be set to true. removeWhenScopeExits) Add a key value pair to the MDC using the MDC manager.
public MdcObject	addMdcValue(String key, CustomMdcObject customMdcObject) Add a key value pair to the MDC using the MDC manager.
public MdcObject	addMdcValue(String key, CustomMdcObject customMdcObject, boolean if true, this key value pair will be automatically removed from the MDC when this scope exits. If there is not a demonstrable reason for setting this parameter to false then it should be set to true. removeWhenScopeExits) Add a key value pair to the MDC using the MDC manager.
public static void	child(Map<String, Object> scopeValues, Scope.ScopedRunner<T> runner) Creates a new scope that is a child of this scope.
public static <ReturnType> ReturnType	child(Map<String, Object> scopeValues, Scope.ScopedRunnerWithReturn<ReturnType> runner) Creates a new scope that is a child of this scope.
public static void	child(LiquibaseListener listener, Scope.ScopedRunner<T> runner) Creates a new child scope that includes the given `LiquibaseListener`.
public static void	child(LiquibaseListener listener, Map<String, Object> scopeValues, Scope.ScopedRunner<T> runner)
public static <T> T	child(LiquibaseListener listener, Map<String, Object> scopeValues, Scope.ScopedRunnerWithReturn<T> runner)
public static void	child(String newValueKey, Object newValue, Scope.ScopedRunner<T> runner) Creates a new scope that is a child of this scope.
public static void	child(Enum<E extends Enum<E>> newValueKey, Object newValue, Scope.ScopedRunner<T> runner)
public String	describe()
public static String	enter(Map<String, Object> scopeValues) Convenience version of `enter(LiquibaseListener, Map)` with no `LiquibaseListener`
public static String	Returns: Returns the scopeId to pass to to `exit(String)` enter(LiquibaseListener listener, Map<String, Object> scopeValues) Creates a new scope without passing a ScopedRunner.
public static void	exit(String The id of the scope to exit. Throws an exception if the name does not match the current scope. scopeId) Exits the scope started with `enter(LiquibaseListener, Map)`
private String	generateScopeId()
public synchronized <T> T	get(Enum<E extends Enum<E>> key, Class<T> type)
public <T> T	get(Enum<E extends Enum<E>> key, T defaultValue)
public <T> T	get(String key, Class<T> type) Return the value associated with the given key in this scope or any parent scope.
public synchronized <T> T	get(String key, T defaultValue) Return the value associated with the given key in this scope or any parent scope.
public ChecksumVersion	getChecksumVersion()
public ClassLoader	getClassLoader()
public ClassLoader	getClassLoader(boolean fallbackToContextClassLoader)
public static Scope	getCurrentScope()
public Database	getDatabase()
public Charset	getFileEncoding() Deprecated use `GlobalConfiguration#FILE_ENCODING`
public String	getLineSeparator()
public <T extends LiquibaseListener> Collection<T>	getListeners(Class<T> type) Returns `LiquibaseListener`s defined in this scope and/or all its parents that are of the given type.
public Logger	getLog(Class<T> clazz)
public MdcManager	getMdcManager() Get the current MDC manager.
public Scope	getParent() Returns the parent scope to this scope.
public ResourceAccessor	getResourceAccessor()
public ServiceLocator	getServiceLocator()
public synchronized <T extends SingletonObject> T	getSingleton(Class<T> type) Looks up the singleton object of the given type.
public UIService	getUI()
public boolean	has(String key) Return true if the given key is defined.
public boolean	has(Enum<E extends Enum<E>> key) Return true if the given key is defined.
public boolean	Returns: true if there is an existing key, false otherwise isMdcKeyPresent(String key) Check if the provided mdc key is present
private void	removeMdcObjectWhenScopeExits(boolean removeWhenScopeExits, MdcObject mdcObject)
public static void	setScopeManager(ScopeManager scopeManager)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

addedMdcEntries	back to summary
private static final Map<String, List<MdcObject>> addedMdcEntries

JAVA_PROPERTIES	back to summary
public static final String JAVA_PROPERTIES

listener	back to summary
private LiquibaseListener listener

parent	back to summary
private final Scope parent

scopeId	back to summary
private final String scopeId Annotations @lombok.Getter

scopeManager	back to summary
private static ScopeManager scopeManager

values	back to summary
private final SmartMap values

Constructor Detail

Scope	back to summary
private Scope() Creates a new "root" scope. Defaults resourceAccessor to `ClassLoaderResourceAccessor`. Defaults serviceLocator to `StandardServiceLocator`

Scope	back to summary
protected Scope(Scope parent, Map<String, Object> scopeValues) Parameters parent:Scope The new Scopes parent in the hierarchy of Scopes, not null. scopeValues:Map<String, Object> The values for the new Scope.

Method Detail

addMdcValue	back to summary
public MdcObject addMdcValue(String key, String value) Add a key value pair to the MDC using the MDC manager. This key value pair will be automatically removed from the MDC when this scope exits.

addMdcValue	back to summary
public MdcObject addMdcValue(String key, String value, boolean removeWhenScopeExits) Add a key value pair to the MDC using the MDC manager. Parameters removeWhenScopeExits:boolean if true, this key value pair will be automatically removed from the MDC when this scope exits. If there is not a demonstrable reason for setting this parameter to false then it should be set to true.

addMdcValue

back to summary

public MdcObject addMdcValue(String key, String value, boolean removeWhenScopeExits)

Add a key value pair to the MDC using the MDC manager.

Parameters

removeWhenScopeExits:boolean: if true, this key value pair will be automatically removed from the MDC when this scope exits. If there is not a demonstrable reason for setting this parameter to false then it should be set to true.

addMdcValue	back to summary
public MdcObject addMdcValue(String key, Map<String, Object> value) Add a key value pair to the MDC using the MDC manager. This key value pair will be automatically removed from the MDC when this scope exits.

addMdcValue	back to summary
public MdcObject addMdcValue(String key, Map<String, Object> value, boolean removeWhenScopeExits) Add a key value pair to the MDC using the MDC manager. Parameters removeWhenScopeExits:boolean if true, this key value pair will be automatically removed from the MDC when this scope exits. If there is not a demonstrable reason for setting this parameter to false then it should be set to true.

addMdcValue

back to summary

public MdcObject addMdcValue(String key, Map<String, Object> value, boolean removeWhenScopeExits)

Add a key value pair to the MDC using the MDC manager.

Parameters

removeWhenScopeExits:boolean: if true, this key value pair will be automatically removed from the MDC when this scope exits. If there is not a demonstrable reason for setting this parameter to false then it should be set to true.

addMdcValue	back to summary
public MdcObject addMdcValue(String key, CustomMdcObject customMdcObject) Add a key value pair to the MDC using the MDC manager. This key value pair will be automatically removed from the MDC when this scope exits.

addMdcValue	back to summary
public MdcObject addMdcValue(String key, CustomMdcObject customMdcObject, boolean removeWhenScopeExits) Add a key value pair to the MDC using the MDC manager. Parameters removeWhenScopeExits:boolean if true, this key value pair will be automatically removed from the MDC when this scope exits. If there is not a demonstrable reason for setting this parameter to false then it should be set to true.

addMdcValue

back to summary

public MdcObject addMdcValue(String key, CustomMdcObject customMdcObject, boolean removeWhenScopeExits)

Add a key value pair to the MDC using the MDC manager.

Parameters

removeWhenScopeExits:boolean: if true, this key value pair will be automatically removed from the MDC when this scope exits. If there is not a demonstrable reason for setting this parameter to false then it should be set to true.

child	back to summary
public static void child(Map<String, Object> scopeValues, Scope.ScopedRunner<T> runner) throws Exception Creates a new scope that is a child of this scope.

child	back to summary
public static <ReturnType> ReturnType child(Map<String, Object> scopeValues, Scope.ScopedRunnerWithReturn<ReturnType> runner) throws Exception Creates a new scope that is a child of this scope.

child back to summary

child	back to summary
public static void child(LiquibaseListener listener, Scope.ScopedRunner<T> runner) throws Exception Creates a new child scope that includes the given `LiquibaseListener`. You cannot unassign a listener, they simply fall out of scope when the Scope does. See Also `getListeners(Class)`

public static void child(LiquibaseListener listener, Scope.ScopedRunner<T> runner) throws Exception

Creates a new child scope that includes the given LiquibaseListener. You cannot unassign a listener, they simply fall out of scope when the Scope does.

See Also: getListeners(Class)

child	back to summary
public static void child(LiquibaseListener listener, Map<String, Object> scopeValues, Scope.ScopedRunner<T> runner) throws Exception

child	back to summary
public static <T> T child(LiquibaseListener listener, Map<String, Object> scopeValues, Scope.ScopedRunnerWithReturn<T> runner) throws Exception

child	back to summary
public static void child(String newValueKey, Object newValue, Scope.ScopedRunner<T> runner) throws Exception Creates a new scope that is a child of this scope.

child	back to summary
public static void child(Enum<E extends Enum<E>> newValueKey, Object newValue, Scope.ScopedRunner<T> runner) throws Exception

describe	back to summary
public String describe()

enter	back to summary
public static String enter(Map<String, Object> scopeValues) throws Exception Convenience version of `enter(LiquibaseListener, Map)` with no `LiquibaseListener`

enter back to summary

enter	back to summary
public static String enter(LiquibaseListener listener, Map<String, Object> scopeValues) throws Exception Creates a new scope without passing a ScopedRunner. This mainly exists for tests where you have a setup/cleanup method pattern. The recommended way to create Scopes is the "child" methods. When done with the scope, call `exit(String)` Returns:String Returns the scopeId to pass to to `exit(String)`

public static String enter(LiquibaseListener listener, Map<String, Object> scopeValues) throws Exception

Creates a new scope without passing a ScopedRunner. This mainly exists for tests where you have a setup/cleanup method pattern. The recommended way to create Scopes is the "child" methods. When done with the scope, call exit(String)

Returns:String: Returns the scopeId to pass to to exit(String)

exit back to summary

exit	back to summary
public static void exit(String scopeId) throws Exception Exits the scope started with `enter(LiquibaseListener, Map)` Parameters scopeId:String The id of the scope to exit. Throws an exception if the name does not match the current scope.

public static void exit(String scopeId) throws Exception

Exits the scope started with enter(LiquibaseListener, Map)

Parameters

scopeId:String: The id of the scope to exit. Throws an exception if the name does not match the current scope.

generateScopeId	back to summary
private String generateScopeId()

get	back to summary
public synchronized <T> T get(Enum<E extends Enum<E>> key, Class<T> type)

get	back to summary
public <T> T get(Enum<E extends Enum<E>> key, T defaultValue)

get	back to summary
public <T> T get(String key, Class<T> type) Return the value associated with the given key in this scope or any parent scope. The value is converted to the given type if necessary using `liquibase.util.ObjectUtil#convert(Object, Class)`. Returns null if key is not defined in this or any parent scopes.

get	back to summary
public synchronized <T> T get(String key, T defaultValue) Return the value associated with the given key in this scope or any parent scope. If the value is not defined, the passed defaultValue is returned. The value is converted to the given type if necessary using `liquibase.util.ObjectUtil#convert(Object, Class)`.

getChecksumVersion	back to summary
public ChecksumVersion getChecksumVersion()

getClassLoader	back to summary
public ClassLoader getClassLoader()

getClassLoader	back to summary
public ClassLoader getClassLoader(boolean fallbackToContextClassLoader)

getCurrentScope	back to summary
public static Scope getCurrentScope()

getDatabase	back to summary
public Database getDatabase()

getFileEncoding	back to summary
public Charset getFileEncoding() Deprecated use `GlobalConfiguration#FILE_ENCODING`

getLineSeparator	back to summary
public String getLineSeparator()

getListeners	back to summary
public <T extends LiquibaseListener> Collection<T> getListeners(Class<T> type) Returns `LiquibaseListener`s defined in this scope and/or all its parents that are of the given type.

getLog	back to summary
public Logger getLog(Class<T> clazz)

getMdcManager	back to summary
public MdcManager getMdcManager() Get the current MDC manager.

getParent	back to summary
public Scope getParent() Returns the parent scope to this scope. Returns null if this is a root scope.

getResourceAccessor	back to summary
public ResourceAccessor getResourceAccessor()

getServiceLocator	back to summary
public ServiceLocator getServiceLocator()

getSingleton	back to summary
public synchronized <T extends SingletonObject> T getSingleton(Class<T> type) Looks up the singleton object of the given type. If the singleton has not been created yet, it will be instantiated. The singleton is a singleton based on the root scope and the same object will be returned for all child scopes of the root.

getUI	back to summary
public UIService getUI()

has	back to summary
public boolean has(String key) Return true if the given key is defined.

has	back to summary
public boolean has(Enum<E extends Enum<E>> key) Return true if the given key is defined.

isMdcKeyPresent

back to summary

public boolean isMdcKeyPresent(String key)

Check if the provided mdc key is present

Returns:boolean

true if there is an existing key, false otherwise

Annotations

@Beta

removeMdcObjectWhenScopeExits	back to summary
private void removeMdcObjectWhenScopeExits(boolean removeWhenScopeExits, MdcObject mdcObject)

setScopeManager	back to summary
public static void setScopeManager(ScopeManager scopeManager)

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

liquibase back to summary

public final Enum Scope.Attr

Class Inheritance

extends Enum<Scope.Attr>

java.lang.Object
java.lang.Enum
liquibase.Scope.Attr

Enumeration containing standard attributes. Normally use methods like convenience getResourceAccessor() or getDatabase()

Field Summary

Modifier and Type	Field and Description
public static final Scope.Attr	changeLogHistoryService
public static final Scope.Attr	changeSet
public static final Scope.Attr	checksumVersion
public static final Scope.Attr	classLoader
public static final Scope.Attr	database
public static final Scope.Attr	databaseChangeLog
public static final Scope.Attr	executeMode
public static final Scope.Attr	fileEncoding Deprecated use `GlobalConfiguration#FILE_ENCODING`
public static final Scope.Attr	latestChecksumVersion
public static final Scope.Attr	lineSeparator
public static final Scope.Attr	lockService
public static final Scope.Attr	logService
public static final Scope.Attr	osgiPlatform
public static final Scope.Attr	quotingStrategy
public static final Scope.Attr	resourceAccessor
public static final Scope.Attr	serviceLocator
public static final Scope.Attr	ui

Constructor Summary

Access	Constructor and Description
private	Attr()

Method Summary

Modifier and Type	Method and Description
public static Scope.Attr	valueOf(String name)
public static Scope.Attr[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

changeLogHistoryService	back to summary
public static final Scope.Attr changeLogHistoryService

changeSet	back to summary
public static final Scope.Attr changeSet

checksumVersion	back to summary
public static final Scope.Attr checksumVersion

classLoader	back to summary
public static final Scope.Attr classLoader

database	back to summary
public static final Scope.Attr database

databaseChangeLog	back to summary
public static final Scope.Attr databaseChangeLog

executeMode	back to summary
public static final Scope.Attr executeMode

fileEncoding	back to summary
public static final Scope.Attr fileEncoding Deprecated use `GlobalConfiguration#FILE_ENCODING`

latestChecksumVersion	back to summary
public static final Scope.Attr latestChecksumVersion

lineSeparator	back to summary
public static final Scope.Attr lineSeparator

lockService	back to summary
public static final Scope.Attr lockService

logService	back to summary
public static final Scope.Attr logService

osgiPlatform	back to summary
public static final Scope.Attr osgiPlatform

quotingStrategy	back to summary
public static final Scope.Attr quotingStrategy

resourceAccessor	back to summary
public static final Scope.Attr resourceAccessor

serviceLocator	back to summary
public static final Scope.Attr serviceLocator

ui	back to summary
public static final Scope.Attr ui

Constructor Detail

Attr	back to summary
private Attr()

Method Detail

valueOf	back to summary
public static Scope.Attr valueOf(String name)

values	back to summary
public static Scope.Attr[] values()

public Class Scope

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum Scope.Attr

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface Scope.ScopedRunner<T>

Method Summary

Method Detail

public Interface Scope.ScopedRunnerWithReturn<T>

Method Summary

Method Detail