context-propagation 1.1.0 · io.micrometer.context.ContextRegistry

Modifier and Type	Field and Description
private final List<ContextAccessor<?, ?>>	contextAccessors
private static final ContextRegistry	instance
private final List<ContextAccessor<?, ?>>	readOnlyContextAccessors
private final List<ThreadLocalAccessor<?>>	readOnlyThreadLocalAccessors
private final List<ThreadLocalAccessor<?>>	threadLocalAccessors

Access	Constructor and Description
public	ContextRegistry()

Method Summary

Modifier and Type	Method and Description
public ContextAccessor<?, ?>	getContextAccessorForRead(Object the context to read from context) Find a `ContextAccessor` that can read the given context.
public ContextAccessor<?, ?>	getContextAccessorForWrite(Object the context to write to context) Return a `ContextAccessor` that can write the given context.
public List<ContextAccessor<?, ?>>	getContextAccessors() Return a read-only list of registered `ContextAccessor`'s.
public static ContextRegistry	getInstance() Return a global `ContextRegistry` instance.
public List<ThreadLocalAccessor<?>>	getThreadLocalAccessors() Return a read-only list of registered `ThreadLocalAccessor`'s.
public ContextRegistry	loadContextAccessors() Load `ContextAccessor` implementations through the `ServiceLoader` mechanism.
public ContextRegistry	loadThreadLocalAccessors() Load `ThreadLocalAccessor` implementations through the `ServiceLoader` mechanism.
public ContextRegistry	registerContextAccessor(ContextAccessor<?, ?> accessor) Register a `ContextAccessor`.
public < the type of value stored in the ThreadLocal V> ContextRegistry	Returns: the same registry instance registerThreadLocalAccessor(String the `key` to associate with the ThreadLocal value key, ThreadLocal<V> the underlying `ThreadLocal` threadLocal) Register a `ThreadLocalAccessor` for the given `ThreadLocal`.
public < the type of value stored in the ThreadLocal V> ContextRegistry	Returns: the same registry instance registerThreadLocalAccessor(String the `key` to associate with the ThreadLocal value key, Supplier<V> callback to use for getting the value getSupplier, Consumer<V> callback to use for setting the value setConsumer, Runnable callback to use for resetting the value resetTask) Register a `ThreadLocalAccessor` from callbacks.
public ContextRegistry	Returns: the same registry instance registerThreadLocalAccessor(ThreadLocalAccessor<?> the accessor to register accessor) Register a `ThreadLocalAccessor`.
public boolean	Returns: `true` when accessor got successfully removed removeContextAccessor(ContextAccessor<?, ?> accessor instance to remove accessorToRemove) Removes a registered `ContextAccessor`.
public boolean	Returns: `true` when accessor got successfully removed removeThreadLocalAccessor(String under which the accessor got registered key) Removes a `ThreadLocalAccessor`.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

contextAccessors	back to summary
private final List<ContextAccessor<?, ?>> contextAccessors

instance	back to summary
private static final ContextRegistry instance

readOnlyContextAccessors	back to summary
private final List<ContextAccessor<?, ?>> readOnlyContextAccessors

readOnlyThreadLocalAccessors	back to summary
private final List<ThreadLocalAccessor<?>> readOnlyThreadLocalAccessors

threadLocalAccessors	back to summary
private final List<ThreadLocalAccessor<?>> threadLocalAccessors

ContextRegistry	back to summary
public ContextRegistry()

Method Detail

getContextAccessorForRead back to summary

getContextAccessorForRead	back to summary
public ContextAccessor<?, ?> getContextAccessorForRead(Object context) Find a `ContextAccessor` that can read the given context. Parameters context:Object the context to read from Exceptions IllegalStateException: if no match is found

public ContextAccessor<?, ?> getContextAccessorForRead(Object context)

Find a ContextAccessor that can read the given context.

Parameters

context:Object: the context to read from

Exceptions

IllegalStateException:: if no match is found

getContextAccessorForWrite back to summary

getContextAccessorForWrite	back to summary
public ContextAccessor<?, ?> getContextAccessorForWrite(Object context) Return a `ContextAccessor` that can write the given context. Parameters context:Object the context to write to Exceptions IllegalStateException: if no match is found

public ContextAccessor<?, ?> getContextAccessorForWrite(Object context)

Return a ContextAccessor that can write the given context.

Parameters

context:Object: the context to write to

Exceptions

IllegalStateException:: if no match is found

getContextAccessors	back to summary
public List<ContextAccessor<?, ?>> getContextAccessors() Return a read-only list of registered `ContextAccessor`'s.

getInstance back to summary

getInstance	back to summary
public static ContextRegistry getInstance() Return a global `ContextRegistry` instance. Note The global instance should be initialized on startup to ensure it has the ability to propagate to and from different types of context throughout the application. The registry itself is not intended to as a mechanism to control what gets propagated. It is in `ContextSnapshot` where more fine-grained decisions can be made about which context values to propagate.

public static ContextRegistry getInstance()

Return a global ContextRegistry instance.

Note

The global instance should be initialized on startup to ensure it has the ability to propagate to and from different types of context throughout the application. The registry itself is not intended to as a mechanism to control what gets propagated. It is in ContextSnapshot where more fine-grained decisions can be made about which context values to propagate.

getThreadLocalAccessors	back to summary
public List<ThreadLocalAccessor<?>> getThreadLocalAccessors() Return a read-only list of registered `ThreadLocalAccessor`'s.

loadContextAccessors back to summary

loadContextAccessors	back to summary
public ContextRegistry loadContextAccessors() Load `ContextAccessor` implementations through the `ServiceLoader` mechanism. Note that existing registrations of the same `ContextAccessor` type, if any, are removed first.

public ContextRegistry loadContextAccessors()

Load ContextAccessor implementations through the ServiceLoader mechanism.

Note that existing registrations of the same ContextAccessor type, if any, are removed first.

loadThreadLocalAccessors back to summary

loadThreadLocalAccessors	back to summary
public ContextRegistry loadThreadLocalAccessors() Load `ThreadLocalAccessor` implementations through the `ServiceLoader` mechanism. Note that existing registrations with the same `key`, if any, are removed first.

public ContextRegistry loadThreadLocalAccessors()

Load ThreadLocalAccessor implementations through the ServiceLoader mechanism.

Note that existing registrations with the same key, if any, are removed first.

registerContextAccessor	back to summary
public ContextRegistry registerContextAccessor(ContextAccessor<?, ?> accessor) Register a `ContextAccessor`. If there is an existing registration of another `ContextAccessor` that can work with its declared types, an exception is thrown.

registerThreadLocalAccessor back to summary

registerThreadLocalAccessor	back to summary
public <V> ContextRegistry registerThreadLocalAccessor(String key, ThreadLocal<V> threadLocal) Register a `ThreadLocalAccessor` for the given `ThreadLocal`. Parameters <V> the type of value stored in the ThreadLocal key:String the `key` to associate with the ThreadLocal value threadLocal:ThreadLocal<V> the underlying `ThreadLocal` Returns:ContextRegistry the same registry instance

public <V> ContextRegistry registerThreadLocalAccessor(String key, ThreadLocal<V> threadLocal)

Parameters

<V>: the type of value stored in the ThreadLocal
key:String: the key to associate with the ThreadLocal value
threadLocal:ThreadLocal<V>: the underlying ThreadLocal

Returns:ContextRegistry

the same registry instance

registerThreadLocalAccessor back to summary

registerThreadLocalAccessor	back to summary
public <V> ContextRegistry registerThreadLocalAccessor(String key, Supplier<V> getSupplier, Consumer<V> setConsumer, Runnable resetTask) Register a `ThreadLocalAccessor` from callbacks. Parameters <V> the type of value stored in the ThreadLocal key:String the `key` to associate with the ThreadLocal value getSupplier:Supplier<V> callback to use for getting the value setConsumer:Consumer<V> callback to use for setting the value resetTask:Runnable callback to use for resetting the value Returns:ContextRegistry the same registry instance

public <V> ContextRegistry registerThreadLocalAccessor(String key, Supplier<V> getSupplier, Consumer<V> setConsumer, Runnable resetTask)

Parameters

<V>: the type of value stored in the ThreadLocal
key:String: the key to associate with the ThreadLocal value
getSupplier:Supplier<V>: callback to use for getting the value
setConsumer:Consumer<V>: callback to use for setting the value
resetTask:Runnable: callback to use for resetting the value

Returns:ContextRegistry

the same registry instance

registerThreadLocalAccessor back to summary

registerThreadLocalAccessor	back to summary
public ContextRegistry registerThreadLocalAccessor(ThreadLocalAccessor<?> accessor) Register a `ThreadLocalAccessor`. If there is an existing registration with the same `key`, it is removed first. Parameters accessor:ThreadLocalAccessor<?> the accessor to register Returns:ContextRegistry the same registry instance

public ContextRegistry registerThreadLocalAccessor(ThreadLocalAccessor<?> accessor)

Parameters

accessor:ThreadLocalAccessor<?>: the accessor to register

Returns:ContextRegistry

the same registry instance

removeContextAccessor back to summary

removeContextAccessor	back to summary
public boolean removeContextAccessor(ContextAccessor<?, ?> accessorToRemove) Removes a registered `ContextAccessor`. Parameters accessorToRemove:ContextAccessor<?, ?> accessor instance to remove Returns:boolean `true` when accessor got successfully removed

public boolean removeContextAccessor(ContextAccessor<?, ?> accessorToRemove)

Removes a registered ContextAccessor.

Parameters

accessorToRemove:ContextAccessor<?, ?>: accessor instance to remove

Returns:boolean

true when accessor got successfully removed

removeThreadLocalAccessor back to summary

removeThreadLocalAccessor	back to summary
public boolean removeThreadLocalAccessor(String key) Removes a `ThreadLocalAccessor`. Parameters key:String under which the accessor got registered Returns:boolean `true` when accessor got successfully removed

public boolean removeThreadLocalAccessor(String key)

Removes a ThreadLocalAccessor.

Parameters

key:String: under which the accessor got registered

Returns:boolean

true when accessor got successfully removed

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

public Class ContextRegistry

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail