Class ThreadContextDataInjector.ForDefaultThreadContextMap

  • All Implemented Interfaces:
    ContextDataInjector
    Enclosing class:
    ThreadContextDataInjector

    public static class ThreadContextDataInjector.ForDefaultThreadContextMap
    extends Object
    implements ContextDataInjector
    Default ContextDataInjector for the legacy Map<String, String>-based ThreadContext (which is also the ThreadContext implementation used for web applications).

    This injector always puts key-value pairs into the specified reusable StringMap.

    • Constructor Detail

      • ForDefaultThreadContextMap

        public ForDefaultThreadContextMap()
    • Method Detail

      • rawContextData

        public ReadOnlyStringMap rawContextData()
        Description copied from interface: ContextDataInjector
        Returns a ReadOnlyStringMap object reflecting the current state of the context. Configuration properties are not included in the result.

        This method may be called multiple times for each log event by Filters and Lookups and implementors should take care to make this method as performant as possible while preserving at least the following thread-safety guarantee.

        Thread-safety note: The returned object can only be safely used in the current thread. Changes in the underlying context may or may not be reflected in the returned object, depending on the context data source and the implementation of this method. It is not safe to pass the returned object to another thread.

        Specified by:
        rawContextData in interface ContextDataInjector
        Returns:
        a ReadOnlyStringMap object reflecting the current state of the context, may not return null