Package liquibase.logging.mdc
Interface MdcManager
-
- All Superinterfaces:
Plugin
- All Known Implementing Classes:
NoOpMdcManager
@Beta public interface MdcManager extends Plugin
-
-
Field Summary
-
Fields inherited from interface liquibase.plugin.Plugin
PRIORITY_DATABASE, PRIORITY_DEFAULT, PRIORITY_NOT_APPLICABLE, PRIORITY_SPECIALIZED
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
clear()
Clear the MDC.Map<String,Object>
getAll()
int
getPriority()
MdcObject
put(String key, String value)
Puts a context value (thevalue
parameter) as identified with thekey
parameter into the MDC.MdcObject
put(String key, String value, boolean removeWhenScopeExits)
Puts a context value (thevalue
parameter) as identified with thekey
parameter into the MDC.MdcObject
put(String key, List<? extends CustomMdcObject> values)
Puts a context value (thevalues
parameter) as identified with thekey
parameter into the MDC.MdcObject
put(String key, Map<String,Object> values)
Puts a context value (thevalues
parameter) as identified with thekey
parameter into the MDC.MdcObject
put(String key, Map<String,Object> values, boolean removeWhenScopeExits)
Puts a context value (thevalues
parameter) as identified with thekey
parameter into the MDC.MdcObject
put(String key, CustomMdcObject customMdcObject)
Puts a context value (thecustomMdcObject
parameter) as identified with thekey
parameter into the MDC.MdcObject
put(String key, CustomMdcObject customMdcObject, boolean removeWhenScopeExits)
Puts a context value (thecustomMdcObject
parameter) as identified with thekey
parameter into the MDC.void
remove(String key)
Removes the context value identified by thekey
parameter.
-
-
-
Method Detail
-
put
@Beta MdcObject put(String key, String value)
Puts a context value (thevalue
parameter) as identified with thekey
parameter into the MDC. The caller is responsible for cleaning up this entry at an appropriate time.
-
put
@Beta MdcObject put(String key, String value, boolean removeWhenScopeExits)
Puts a context value (thevalue
parameter) as identified with thekey
parameter into the MDC. The caller is responsible for cleaning up this entry at an appropriate time.- Parameters:
removeWhenScopeExits
- 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.
-
put
@Beta MdcObject put(String key, Map<String,Object> values)
Puts a context value (thevalues
parameter) as identified with thekey
parameter into the MDC. The caller is responsible for cleaning up this entry at an appropriate time.
-
put
@Beta MdcObject put(String key, Map<String,Object> values, boolean removeWhenScopeExits)
Puts a context value (thevalues
parameter) as identified with thekey
parameter into the MDC. The caller is responsible for cleaning up this entry at an appropriate time.- Parameters:
removeWhenScopeExits
- 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.
-
put
@Beta MdcObject put(String key, List<? extends CustomMdcObject> values)
Puts a context value (thevalues
parameter) as identified with thekey
parameter into the MDC. The caller is responsible for cleaning up this entry at an appropriate time.
-
put
@Beta MdcObject put(String key, CustomMdcObject customMdcObject)
Puts a context value (thecustomMdcObject
parameter) as identified with thekey
parameter into the MDC. The caller is responsible for cleaning up this entry at an appropriate time.
-
put
@Beta MdcObject put(String key, CustomMdcObject customMdcObject, boolean removeWhenScopeExits)
Puts a context value (thecustomMdcObject
parameter) as identified with thekey
parameter into the MDC. The caller is responsible for cleaning up this entry at an appropriate time.- Parameters:
removeWhenScopeExits
- 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.
-
clear
@Beta void clear()
Clear the MDC.
-
getPriority
@Beta int getPriority()
-
-