Top Fields Methods
liquibase.logging.mdc

public Interface MdcManager

extends Plugin
Known Direct Implementers
liquibase.logging.mdc.NoOpMdcManager
Annotations
@Beta
Imports
liquibase.Beta, liquibase.plugin.Plugin, java.util.Map

Field Summary

Inherited from liquibase.plugin.Plugin:
PRIORITY_DATABASEPRIORITY_DEFAULTPRIORITY_NOT_APPLICABLEPRIORITY_SPECIALIZED

Method Summary

Modifier and TypeMethod and Description
public void
clear()

Clear the MDC.

public Map<String, Object>
public int
public MdcObject
put(String key, String value)

Puts a context value (the value parameter) as identified with the key parameter into the MDC.

public MdcObject
put(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
)

Puts a context value (the value parameter) as identified with the key parameter into the MDC.

public MdcObject
put(String key, Map<String, Object> values)

Puts a context value (the values parameter) as identified with the key parameter into the MDC.

public MdcObject
put(String key, Map<String, Object> values, 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
)

Puts a context value (the values parameter) as identified with the key parameter into the MDC.

public MdcObject
put(String key, CustomMdcObject customMdcObject)

Puts a context value (the customMdcObject parameter) as identified with the key parameter into the MDC.

public MdcObject
put(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
)

Puts a context value (the customMdcObject parameter) as identified with the key parameter into the MDC.

public void
remove(String key)

Removes the context value identified by the key parameter.

Method Detail

clearback to summary
public void clear()

Clear the MDC.

Annotations
@Beta
getAllback to summary
public Map<String, Object> getAll()
Annotations
@Beta
getPriorityback to summary
public int getPriority()
Annotations
@Beta
putback to summary
public MdcObject put(String key, String value)

Puts a context value (the value parameter) as identified with the key parameter into the MDC. The caller is responsible for cleaning up this entry at an appropriate time.

Annotations
@Beta
putback to summary
public MdcObject put(String key, String value, boolean removeWhenScopeExits)

Puts a context value (the value parameter) as identified with the key parameter into the MDC. The caller is responsible for cleaning up this entry at an appropriate time.

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.

Annotations
@Beta
putback to summary
public MdcObject put(String key, Map<String, Object> values)

Puts a context value (the values parameter) as identified with the key parameter into the MDC. The caller is responsible for cleaning up this entry at an appropriate time.

Annotations
@Beta
putback to summary
public MdcObject put(String key, Map<String, Object> values, boolean removeWhenScopeExits)

Puts a context value (the values parameter) as identified with the key parameter into the MDC. The caller is responsible for cleaning up this entry at an appropriate time.

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.

Annotations
@Beta
putback to summary
public MdcObject put(String key, CustomMdcObject customMdcObject)

Puts a context value (the customMdcObject parameter) as identified with the key parameter into the MDC. The caller is responsible for cleaning up this entry at an appropriate time.

Annotations
@Beta
putback to summary
public MdcObject put(String key, CustomMdcObject customMdcObject, boolean removeWhenScopeExits)

Puts a context value (the customMdcObject parameter) as identified with the key parameter into the MDC. The caller is responsible for cleaning up this entry at an appropriate time.

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.

Annotations
@Beta
removeback to summary
public void remove(String key)

Removes the context value identified by the key parameter.

Annotations
@Beta