Index
All Classes and Interfaces|All Packages
A
- awaitTermination(long, TimeUnit) - Method in class io.micrometer.context.ContextExecutorService
B
- build() - Method in interface io.micrometer.context.ContextSnapshotFactory.Builder
-
Creates a new instance of
ContextSnapshotFactory
. - builder() - Static method in interface io.micrometer.context.ContextSnapshotFactory
-
Creates a builder for configuring the factory.
C
- capture() - Method in class io.micrometer.context.ContextExecutorService
- captureAll(ContextRegistry, Object...) - Static method in interface io.micrometer.context.ContextSnapshot
-
Deprecated.
- captureAll(Object...) - Static method in interface io.micrometer.context.ContextSnapshot
-
Deprecated.use
ContextSnapshotFactory.captureAll(Object...)
on a factory obtained via aContextSnapshotFactory.builder()
. - captureAll(Object...) - Method in interface io.micrometer.context.ContextSnapshotFactory
-
Capture values from
ThreadLocal
and from other context objects using all accessors from aContextRegistry
instance. - captureAllUsing(Predicate<Object>, ContextRegistry, Object...) - Static method in interface io.micrometer.context.ContextSnapshot
-
Deprecated.use
ContextSnapshotFactory.captureAll(Object...)
on a factory obtained via aContextSnapshotFactory.builder()
and configureContextSnapshotFactory.Builder.captureKeyPredicate(Predicate)
andContextSnapshotFactory.Builder.contextRegistry(ContextRegistry)
. - captureFrom(Object) - Static method in interface io.micrometer.context.ContextSnapshot
-
Deprecated.use
ContextSnapshotFactory.captureFrom(Object...)
on a factory obtained via aContextSnapshotFactory.builder()
. - captureFrom(Object...) - Method in interface io.micrometer.context.ContextSnapshotFactory
-
Create a
ContextSnapshot
by reading values from the given context objects. - captureFrom(Object, ContextRegistry) - Static method in interface io.micrometer.context.ContextSnapshot
-
Deprecated.use
ContextSnapshotFactory.captureFrom(Object...)
on a factory obtained via aContextSnapshotFactory.builder()
combined withContextSnapshotFactory.Builder.contextRegistry(ContextRegistry)
. - captureFrom(Object, Predicate<Object>, ContextRegistry) - Static method in interface io.micrometer.context.ContextSnapshot
-
Deprecated.use
ContextSnapshotFactory.captureFrom(Object...)
on a factory obtained via aContextSnapshotFactory.builder()
and configureContextSnapshotFactory.Builder.captureKeyPredicate(Predicate)
andContextSnapshotFactory.Builder.contextRegistry(ContextRegistry)
. - captureKeyPredicate(Predicate<Object>) - Method in interface io.micrometer.context.ContextSnapshotFactory.Builder
-
Instructs the factory to use the given predicate to select matching keys when capturing
ThreadLocal
values - clearMissing(boolean) - Method in interface io.micrometer.context.ContextSnapshotFactory.Builder
-
Determines whether to clear existing
ThreadLocal
values at the start of a scope, if there are no corresponding values in the sourceContextSnapshot
or context object. - close() - Method in interface io.micrometer.context.ContextSnapshot.Scope
-
Reset
ThreadLocal
values, either removing them or restoring their previous values, if any. - ContextAccessor<READ,
WRITE> - Interface in io.micrometer.context - ContextExecutorService<EXECUTOR extends ExecutorService> - Class in io.micrometer.context
-
Wraps an
ExecutorService
in order to capture context viaContextSnapshot
when a task is submitted, and propagate context to the task when it is executed. - ContextExecutorService(EXECUTOR, Supplier<ContextSnapshot>) - Constructor for class io.micrometer.context.ContextExecutorService
-
Create an instance of
ContextScheduledExecutorService
. - contextRegistry(ContextRegistry) - Method in interface io.micrometer.context.ContextSnapshotFactory.Builder
-
Configures the
ContextRegistry
to use by the created factory. - ContextRegistry - Class in io.micrometer.context
-
Registry that provides access to, instances of
ContextAccessor
andThreadLocalAccessor
. - ContextRegistry() - Constructor for class io.micrometer.context.ContextRegistry
- ContextScheduledExecutorService - Class in io.micrometer.context
-
Wraps a
ScheduledExecutorService
in order to capture context viaContextSnapshot
when a task is submitted, and propagate context to the task when it is executed. - ContextSnapshot - Interface in io.micrometer.context
-
Holds values extracted from
ThreadLocal
and other types of context and exposes methods to propagate those values. - ContextSnapshot.Scope - Interface in io.micrometer.context
-
An object to use to reset
ThreadLocal
values at the end of a context scope. - ContextSnapshotFactory - Interface in io.micrometer.context
-
Factory for creating
ContextSnapshot
objects and restoringThreadLocal
values using a context object for which aContextAccessor
exists in theContextRegistry
. - ContextSnapshotFactory.Builder - Interface in io.micrometer.context
-
Builder for
ContextSnapshotFactory
instances.
E
- execute(Runnable) - Method in class io.micrometer.context.ContextExecutorService
G
- getContextAccessorForRead(Object) - Method in class io.micrometer.context.ContextRegistry
-
Find a
ContextAccessor
that can read the given context. - getContextAccessorForWrite(Object) - Method in class io.micrometer.context.ContextRegistry
-
Return a
ContextAccessor
that can write the given context. - getContextAccessors() - Method in class io.micrometer.context.ContextRegistry
-
Return a read-only list of registered
ContextAccessor
's. - getExecutorService() - Method in class io.micrometer.context.ContextExecutorService
- getInstance() - Static method in class io.micrometer.context.ContextRegistry
-
Return a global
ContextRegistry
instance. - getThreadLocalAccessors() - Method in class io.micrometer.context.ContextRegistry
-
Return a read-only list of registered
ThreadLocalAccessor
's. - getValue() - Method in interface io.micrometer.context.ThreadLocalAccessor
-
Return the current
ThreadLocal
value.
I
- invokeAll(Collection<? extends Callable<T>>) - Method in class io.micrometer.context.ContextExecutorService
- invokeAll(Collection<? extends Callable<T>>, long, TimeUnit) - Method in class io.micrometer.context.ContextExecutorService
- invokeAny(Collection<? extends Callable<T>>) - Method in class io.micrometer.context.ContextExecutorService
- invokeAny(Collection<? extends Callable<T>>, long, TimeUnit) - Method in class io.micrometer.context.ContextExecutorService
- io.micrometer.context - package io.micrometer.context
-
This package contains abstractions and implementations for context propagation.
- isShutdown() - Method in class io.micrometer.context.ContextExecutorService
- isTerminated() - Method in class io.micrometer.context.ContextExecutorService
K
- key() - Method in interface io.micrometer.context.ThreadLocalAccessor
-
The key to associate with the ThreadLocal value when saved within a
ContextSnapshot
.
L
- loadContextAccessors() - Method in class io.micrometer.context.ContextRegistry
-
Load
ContextAccessor
implementations through theServiceLoader
mechanism. - loadThreadLocalAccessors() - Method in class io.micrometer.context.ContextRegistry
-
Load
ThreadLocalAccessor
implementations through theServiceLoader
mechanism.
R
- readableType() - Method in interface io.micrometer.context.ContextAccessor
-
Class
representing the type of context this accessor is capable of reading values from. - readValue(READ, Object) - Method in interface io.micrometer.context.ContextAccessor
-
Read a single value from the source context.
- readValues(READ, Predicate<Object>, Map<Object, Object>) - Method in interface io.micrometer.context.ContextAccessor
-
Read values from a source context into a
Map
. - registerContextAccessor(ContextAccessor<?, ?>) - Method in class io.micrometer.context.ContextRegistry
-
Register a
ContextAccessor
. - registerThreadLocalAccessor(ThreadLocalAccessor<?>) - Method in class io.micrometer.context.ContextRegistry
-
Register a
ThreadLocalAccessor
. - registerThreadLocalAccessor(String, ThreadLocal<V>) - Method in class io.micrometer.context.ContextRegistry
-
Register a
ThreadLocalAccessor
for the givenThreadLocal
. - registerThreadLocalAccessor(String, Supplier<V>, Consumer<V>, Runnable) - Method in class io.micrometer.context.ContextRegistry
-
Register a
ThreadLocalAccessor
from callbacks. - removeContextAccessor(ContextAccessor<?, ?>) - Method in class io.micrometer.context.ContextRegistry
-
Removes a registered
ContextAccessor
. - removeThreadLocalAccessor(String) - Method in class io.micrometer.context.ContextRegistry
-
Removes a
ThreadLocalAccessor
. - reset() - Method in interface io.micrometer.context.ThreadLocalAccessor
-
Deprecated.To be replaced by calls to
setValue()
(and/orrestore()
), which needs to be implemented when this implementation is removed. - restore() - Method in interface io.micrometer.context.ThreadLocalAccessor
-
Called instead of
restore(Object)
when there was noThreadLocal
value existing at the start of the scope. - restore(V) - Method in interface io.micrometer.context.ThreadLocalAccessor
-
Restore the
ThreadLocal
at the end of aContextSnapshot.Scope
to the previous value it had before the start of the scope.
S
- schedule(Runnable, long, TimeUnit) - Method in class io.micrometer.context.ContextScheduledExecutorService
- schedule(Callable<V>, long, TimeUnit) - Method in class io.micrometer.context.ContextScheduledExecutorService
- scheduleAtFixedRate(Runnable, long, long, TimeUnit) - Method in class io.micrometer.context.ContextScheduledExecutorService
- scheduleWithFixedDelay(Runnable, long, long, TimeUnit) - Method in class io.micrometer.context.ContextScheduledExecutorService
- setAllThreadLocalsFrom(Object) - Static method in interface io.micrometer.context.ContextSnapshot
-
Deprecated.use
ContextSnapshotFactory.setThreadLocalsFrom(Object, String...)
with no keys on a factory obtained via aContextSnapshotFactory.builder()
. - setAllThreadLocalsFrom(Object, ContextRegistry) - Static method in interface io.micrometer.context.ContextSnapshot
-
Deprecated.use
ContextSnapshotFactory.setThreadLocalsFrom(Object, String...)
with no keys on a factory obtained via aContextSnapshotFactory.builder()
combined withContextSnapshotFactory.Builder.contextRegistry(ContextRegistry)
. - setThreadLocals() - Method in interface io.micrometer.context.ContextSnapshot
-
Set
ThreadLocal
values from the snapshot. - setThreadLocals(Predicate<Object>) - Method in interface io.micrometer.context.ContextSnapshot
-
Variant of
ContextSnapshot.setThreadLocals()
with a predicate to select context values by key. - setThreadLocalsFrom(Object, ContextRegistry, String...) - Static method in interface io.micrometer.context.ContextSnapshot
-
Deprecated.use
ContextSnapshotFactory.setThreadLocalsFrom(Object, String...)
on a factory obtained via aContextSnapshotFactory.builder()
combined withContextSnapshotFactory.Builder.contextRegistry(ContextRegistry)
. - setThreadLocalsFrom(Object, String...) - Static method in interface io.micrometer.context.ContextSnapshot
-
Deprecated.use
ContextSnapshotFactory.setThreadLocalsFrom(Object, String...)
on a factory obtained via aContextSnapshotFactory.builder()
. - setThreadLocalsFrom(Object, String...) - Method in interface io.micrometer.context.ContextSnapshotFactory
-
Read the values specified by keys from the given source context, and if found, use them to set
ThreadLocal
values. - setValue() - Method in interface io.micrometer.context.ThreadLocalAccessor
-
Called instead of
setValue(Object)
in order to remove the currentThreadLocal
value at the start of aContextSnapshot.Scope
. - setValue(V) - Method in interface io.micrometer.context.ThreadLocalAccessor
-
Set the
ThreadLocal
at the start of aContextSnapshot.Scope
to a value obtained from aContextSnapshot
or from a different type of context (through aContextAccessor
). - shutdown() - Method in class io.micrometer.context.ContextExecutorService
- shutdownNow() - Method in class io.micrometer.context.ContextExecutorService
- submit(Runnable) - Method in class io.micrometer.context.ContextExecutorService
- submit(Runnable, T) - Method in class io.micrometer.context.ContextExecutorService
- submit(Callable<T>) - Method in class io.micrometer.context.ContextExecutorService
T
- ThreadLocalAccessor<V> - Interface in io.micrometer.context
-
Contract to assist with setting and clearing a
ThreadLocal
. - toString() - Method in class io.micrometer.context.ContextRegistry
U
- updateContext(C) - Method in interface io.micrometer.context.ContextSnapshot
-
Update the given context with all snapshot values.
- updateContext(C, Predicate<Object>) - Method in interface io.micrometer.context.ContextSnapshot
-
Variant of
ContextSnapshot.updateContext(Object)
to update the given context with a subset of snapshot values.
W
- wrap(Runnable) - Method in interface io.micrometer.context.ContextSnapshot
-
Return a new
Runnable
that setsThreadLocal
values from the snapshot around the invocation of the givenRunnable
. - wrap(Callable<T>) - Method in interface io.micrometer.context.ContextSnapshot
-
Return a new
Callable
that setsThreadLocal
values from the snapshot around the invocation of the givenCallable
. - wrap(ExecutorService) - Static method in class io.micrometer.context.ContextExecutorService
-
Deprecated.
- wrap(ExecutorService, Supplier<ContextSnapshot>) - Static method in class io.micrometer.context.ContextExecutorService
-
Wrap the given
ExecutorService
in order to propagate context to any executed task through the givenContextSnapshot
supplier. - wrap(ScheduledExecutorService) - Static method in class io.micrometer.context.ContextScheduledExecutorService
- wrap(ScheduledExecutorService, Supplier<ContextSnapshot>) - Static method in class io.micrometer.context.ContextScheduledExecutorService
-
Wrap the given
ScheduledExecutorService
in order to propagate context to any executed task through the givenContextSnapshot
supplier. - wrap(Consumer<T>) - Method in interface io.micrometer.context.ContextSnapshot
-
Return a new
Consumer
that setsThreadLocal
values from the snapshot around the invocation of the givenConsumer
. - wrapExecutor(Executor) - Method in interface io.micrometer.context.ContextSnapshot
-
Return a new
Executor
that setsThreadLocal
values from the snapshot around the invocation of any executed,Runnable
. - writeableType() - Method in interface io.micrometer.context.ContextAccessor
-
Class
representing the type of context this accessor can restore values to. - writeValues(Map<Object, Object>, WRITE) - Method in interface io.micrometer.context.ContextAccessor
-
Write values from a
Map
to a target context.
All Classes and Interfaces|All Packages
ContextSnapshotFactory.captureAll(Object...)
on a factory obtained via aContextSnapshotFactory.builder()
combined withContextSnapshotFactory.Builder.contextRegistry(ContextRegistry)
.