MdcCapturedContextProvider

java.lang.Object

io.servicetalk.log4j2.mdc.utils.MdcCapturedContextProvider

All Implemented Interfaces:: CapturedContextProvider

Direct Known Subclasses:: DefaultMdcCapturedContextProvider

public abstract class MdcCapturedContextProvider extends Object implements CapturedContextProvider

A CapturedContextProvider implementation to correctly propagate MDC context.

Constructor Summary

Constructors

Modifier

Constructor

Description

protected

MdcCapturedContextProvider(Class<? extends ServiceTalkThreadContextMap> expectedThreadContextMapClass)

Create a new CapturedContextProvider for MDC.
Method Summary

Modifier and Type

Method

Description

final CapturedContext

captureContext(CapturedContext underlying)

Capture a reference to existing context in preparation for an asynchronous boundary jump.

final CapturedContext

captureContextCopy(CapturedContext underlying)

Capture a copy of existing context in preparation for an asynchronous boundary jump.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- MdcCapturedContextProvider
  
  protected MdcCapturedContextProvider(Class<? extends ServiceTalkThreadContextMap> expectedThreadContextMapClass)
  
  Create a new CapturedContextProvider for MDC.
  
  Parameters:
  
  expectedThreadContextMapClass - the expected type of the MDC ThreadContext.
Method Details
- captureContext
  
  public final CapturedContext captureContext(CapturedContext underlying)
  
  Description copied from interface: CapturedContextProvider
  
  Capture a reference to existing context in preparation for an asynchronous boundary jump.
  
  Specified by:
  
  captureContext in interface CapturedContextProvider
  
  Parameters:
  
  underlying - additional context that must be utilized as part of the returned CapturedContext, usually wrapped as described above.
  
  Returns:
  
  the wrapped CapturedContext.
- captureContextCopy
  
  public final CapturedContext captureContextCopy(CapturedContext underlying)
  
  Description copied from interface: CapturedContextProvider
  
  Capture a copy of existing context in preparation for an asynchronous boundary jump.
  
  Specified by:
  
  captureContextCopy in interface CapturedContextProvider
  
  Parameters:
  
  underlying - additional context that must be utilized as part of the returned CapturedContext, usually wrapped as described above.
  
  Returns:
  
  the wrapped CapturedContext.