io.servicetalk.log4j2.mdc.utils

Class ServiceTalkThreadContextMap

Object

ServiceTalkThreadContextMap

All Implemented Interfaces:

CleanableThreadContextMap, ReadOnlyThreadContextMap, ThreadContextMap, ThreadContextMap2

public class ServiceTalkThreadContextMap
extends Object
implements ReadOnlyThreadContextMap, CleanableThreadContextMap

A ThreadContext that provides storage for MDC based upon AsyncContext.

Constructor Summary

Constructors

Constructor and Description
ServiceTalkThreadContextMap() Create a new ThreadContextMap Note: this is intended to be used via service loading and not instantiated directly.
ServiceTalkThreadContextMap(boolean useLocalStorage) Create a new ThreadContextMap Note: this is intended to be used via service loading and not instantiated directly.

Method Summary

Modifier and Type	Method and Description
void	clear()
boolean	containsKey(String key)
String	get(String key)
Map<String,String>	getCopy()
protected Map<String,String>	getCopyOrNull()
Map<String,String>	getImmutableMapOrNull()
StringMap	getReadOnlyContextData()
boolean	isEmpty()
void	put(String key, String value)
void	putAll(Map<String,String> map)
void	remove(String key)
void	removeAll(Iterable<String> keys)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ServiceTalkThreadContextMap

public ServiceTalkThreadContextMap()

Create a new ThreadContextMap Note: this is intended to be used via service loading and not instantiated directly.

ServiceTalkThreadContextMap

public ServiceTalkThreadContextMap(boolean useLocalStorage)

Create a new ThreadContextMap Note: this is intended to be used via service loading and not instantiated directly.

Parameters:

useLocalStorage - whether to use a thread-local storage model. If false, AsyncContext will be used. If using a thread-local storage model then the CapturedContextProvider mechanism is necessary to properly propagate context across the reactive stream boundaries. See the MdcCapturedContextProvider for an abstract implementation.

Method Detail

put

public final void put(String key,
                      String value)

Specified by:

put in interface ThreadContextMap

get

@Nullable
public String get(String key)

Specified by:

get in interface ReadOnlyThreadContextMap

Specified by:

get in interface ThreadContextMap

remove

public final void remove(String key)

Specified by:

remove in interface ThreadContextMap

clear

public final void clear()

Specified by:

clear in interface ReadOnlyThreadContextMap

Specified by:

clear in interface ThreadContextMap

containsKey

public boolean containsKey(String key)

Specified by:

containsKey in interface ReadOnlyThreadContextMap

Specified by:

containsKey in interface ThreadContextMap

getCopy

public Map<String,String> getCopy()

Specified by:

getCopy in interface ReadOnlyThreadContextMap

Specified by:

getCopy in interface ThreadContextMap

getImmutableMapOrNull

@Nullable
public Map<String,String> getImmutableMapOrNull()

Specified by:

getImmutableMapOrNull in interface ReadOnlyThreadContextMap

Specified by:

getImmutableMapOrNull in interface ThreadContextMap

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface ReadOnlyThreadContextMap

Specified by:

isEmpty in interface ThreadContextMap

removeAll

public final void removeAll(Iterable<String> keys)

Specified by:

removeAll in interface CleanableThreadContextMap

putAll

public final void putAll(Map<String,String> map)

Specified by:

putAll in interface ThreadContextMap2

getReadOnlyContextData

public StringMap getReadOnlyContextData()

Specified by:

getReadOnlyContextData in interface ReadOnlyThreadContextMap

Specified by:

getReadOnlyContextData in interface ThreadContextMap2

getCopyOrNull

@Nullable
protected Map<String,String> getCopyOrNull()