org.slf4j.helpers.BasicMDCAdapter Maven / Gradle / Ivy
/**
* Copyright (c) 2004-2011 QOS.ch
* All rights reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
* LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*
*/
package org.slf4j.helpers;
import org.slf4j.spi.MDCAdapter;
import java.util.*;
/**
* Basic MDC implementation, which can be used with logging systems that lack
* out-of-the-box MDC support.
*
* This code was initially inspired by logback's LogbackMDCAdapter. However,
* LogbackMDCAdapter has evolved and is now considerably more sophisticated.
*
* @author Ceki Gulcu
* @author Maarten Bosteels
* @author Lukasz Cwik
*
* @since 1.5.0
*/
public class BasicMDCAdapter implements MDCAdapter {
private final ThreadLocalMapOfStacks threadLocalMapOfDeques = new ThreadLocalMapOfStacks();
private final InheritableThreadLocal> inheritableThreadLocalMap = new InheritableThreadLocal>() {
@Override
protected Map childValue(Map parentValue) {
if (parentValue == null) {
return null;
}
return new HashMap<>(parentValue);
}
};
/**
* Put a context value (the val parameter) as identified with
* the key parameter into the current thread's context map.
* Note that contrary to log4j, the val parameter can be null.
*
*
* If the current thread does not have a context map it is created as a side
* effect of this call.
*
* @throws IllegalArgumentException
* in case the "key" parameter is null
*/
public void put(String key, String val) {
if (key == null) {
throw new IllegalArgumentException("key cannot be null");
}
Map map = inheritableThreadLocalMap.get();
if (map == null) {
map = new HashMap<>();
inheritableThreadLocalMap.set(map);
}
map.put(key, val);
}
/**
* Get the context identified by the key parameter.
*/
public String get(String key) {
Map map = inheritableThreadLocalMap.get();
if ((map != null) && (key != null)) {
return map.get(key);
} else {
return null;
}
}
/**
* Remove the the context identified by the key parameter.
*/
public void remove(String key) {
Map map = inheritableThreadLocalMap.get();
if (map != null) {
map.remove(key);
}
}
/**
* Clear all entries in the MDC.
*/
public void clear() {
Map map = inheritableThreadLocalMap.get();
if (map != null) {
map.clear();
inheritableThreadLocalMap.remove();
}
}
/**
* Returns the keys in the MDC as a {@link Set} of {@link String}s The
* returned value can be null.
*
* @return the keys in the MDC
*/
public Set getKeys() {
Map map = inheritableThreadLocalMap.get();
if (map != null) {
return map.keySet();
} else {
return null;
}
}
/**
* Return a copy of the current thread's context map.
* Returned value may be null.
*
*/
public Map getCopyOfContextMap() {
Map oldMap = inheritableThreadLocalMap.get();
if (oldMap != null) {
return new HashMap<>(oldMap);
} else {
return null;
}
}
public void setContextMap(Map contextMap) {
Map copy = null;
if (contextMap != null) {
copy = new HashMap<>(contextMap);
}
inheritableThreadLocalMap.set(copy);
}
@Override
public void pushByKey(String key, String value) {
threadLocalMapOfDeques.pushByKey(key, value);
}
@Override
public String popByKey(String key) {
return threadLocalMapOfDeques.popByKey(key);
}
@Override
public Deque getCopyOfDequeByKey(String key) {
return threadLocalMapOfDeques.getCopyOfDequeByKey(key);
}
@Override
public void clearDequeByKey(String key) {
threadLocalMapOfDeques.clearDequeByKey(key);
}
}