Index (MicroProfile Context Propagation 1.0 API)

A B C E F G I M N O P R S T U W

A

addDiscoveredContextManagerExtensions() - Method in interface org.eclipse.microprofile.context.spi.ContextManager.Builder: Load all discoverable ContextManagerExtension instances via the ServiceLoader mechanism on the current thread-context ClassLoader (unless overridden by forClassLoader(ClassLoader)).
addDiscoveredThreadContextProviders() - Method in interface org.eclipse.microprofile.context.spi.ContextManager.Builder: Load all discoverable ThreadContextProvider instances via the ServiceLoader mechanism on the current thread-context ClassLoader (unless overridden by forClassLoader(ClassLoader)).
ALL_REMAINING - Static variable in interface org.eclipse.microprofile.context.ThreadContext: Identifier for all available thread context types which are not specified individually under cleared, propagated, or unchanged.
APPLICATION - Static variable in interface org.eclipse.microprofile.context.ThreadContext: Identifier for application context.

B

begin() - Method in interface org.eclipse.microprofile.context.spi.ThreadContextSnapshot: Applies the captured thread context snapshot to the current thread and returns a distinct ThreadContextController instance.
build() - Method in interface org.eclipse.microprofile.context.ManagedExecutor.Builder: Builds a new ManagedExecutor with the configuration that this builder represents as of the point in time when this method is invoked.
build() - Method in interface org.eclipse.microprofile.context.spi.ContextManager.Builder: Creates a new ContextManager with the specified configuration.
build() - Method in interface org.eclipse.microprofile.context.ThreadContext.Builder: Builds a new ThreadContext instance with the configuration that this builder represents as of the point in time when this method is invoked.
builder() - Static method in interface org.eclipse.microprofile.context.ManagedExecutor: Creates a new ManagedExecutor.Builder instance.
builder() - Static method in interface org.eclipse.microprofile.context.ThreadContext: Creates a new ThreadContext.Builder instance.

C

CDI - Static variable in interface org.eclipse.microprofile.context.ThreadContext: Identifier for CDI context.
cleared(String...) - Method in interface org.eclipse.microprofile.context.ManagedExecutor.Builder: Defines the set of thread context types to clear from the thread where the action or task executes.
cleared(String...) - Method in interface org.eclipse.microprofile.context.ThreadContext.Builder: Defines the set of thread context types to clear from the thread where the action or task executes.
clearedContext(Map<String, String>) - Method in interface org.eclipse.microprofile.context.spi.ThreadContextProvider: Returns empty/cleared context of the provided type.
completedFuture(U) - Method in interface org.eclipse.microprofile.context.ManagedExecutor: Returns a new CompletableFuture that is already completed with the specified value.
completedStage(U) - Method in interface org.eclipse.microprofile.context.ManagedExecutor: Returns a new CompletionStage that is already completed with the specified value.
ContextManager - Interface in org.eclipse.microprofile.context.spi: ContextManager instances can be used to create ContextManager.newManagedExecutorBuilder() or ContextManager.newThreadContextBuilder().
ContextManager.Builder - Interface in org.eclipse.microprofile.context.spi: Use this class to configure instances of ContextManager.
ContextManagerExtension - Interface in org.eclipse.microprofile.context.spi: ContextManagerExtension instances receive notification upon creation of each ContextManager.
ContextManagerProvider - Interface in org.eclipse.microprofile.context.spi: A provider implementation supplied by the container, which creates and caches instances of ContextManager per class loader, which in turn create new instances of ManagedExecutor.Builder and ThreadContext.Builder.
ContextManagerProviderRegistration - Class in org.eclipse.microprofile.context.spi: This class gives the container that registered a ContextManagerProvider exclusive control over unregistering it.
contextualCallable(Callable<R>) - Method in interface org.eclipse.microprofile.context.ThreadContext: Wraps a Callable with context that is captured from the thread that invokes contextualCallable.
contextualConsumer(BiConsumer<T, U>) - Method in interface org.eclipse.microprofile.context.ThreadContext: Wraps a BiConsumer with context that is captured from the thread that invokes contextualConsumer.
contextualConsumer(Consumer<T>) - Method in interface org.eclipse.microprofile.context.ThreadContext: Wraps a Consumer with context that is captured from the thread that invokes contextualConsumer.
contextualFunction(BiFunction<T, U, R>) - Method in interface org.eclipse.microprofile.context.ThreadContext: Wraps a BiFunction with context that is captured from the thread that invokes contextualFunction.
contextualFunction(Function<T, R>) - Method in interface org.eclipse.microprofile.context.ThreadContext: Wraps a Function with context that is captured from the thread that invokes contextualFunction.
contextualRunnable(Runnable) - Method in interface org.eclipse.microprofile.context.ThreadContext: Wraps a Runnable with context that is captured from the thread that invokes ContextualRunnable.
contextualSupplier(Supplier<R>) - Method in interface org.eclipse.microprofile.context.ThreadContext: Wraps a Supplier with context captured from the thread that invokes contextualSupplier.
currentContext(Map<String, String>) - Method in interface org.eclipse.microprofile.context.spi.ThreadContextProvider: Captures from the current thread a snapshot of the provided thread context type.
currentContextExecutor() - Method in interface org.eclipse.microprofile.context.ThreadContext: Creates an Executorthat runs tasks on the same thread from which executeis invoked but with context that is captured from the thread that invokes currentContextExecutor.

E

endContext() - Method in interface org.eclipse.microprofile.context.spi.ThreadContextController: Invoked by the ManagedExecutor or ThreadContext to remove the thread context managed by this ThreadContextController instance and restore the previous context that was on the thread before the ThreadContextController applied the context to the thread.

F

failedFuture(Throwable) - Method in interface org.eclipse.microprofile.context.ManagedExecutor: Returns a new CompletableFuture that is already exceptionally completed with the specified Throwable.
failedStage(Throwable) - Method in interface org.eclipse.microprofile.context.ManagedExecutor: Returns a new CompletionStage that is already exceptionally completed with the specified Throwable.
forClassLoader(ClassLoader) - Method in interface org.eclipse.microprofile.context.spi.ContextManager.Builder: Use the given ClassLoader for addDiscoveredThreadContextProviders() instead of the current thread-context ClassLoader.

G

getContextManager() - Method in interface org.eclipse.microprofile.context.spi.ContextManagerProvider: Gets a ContextManager for the current thread-context ClassLoader.
getContextManager(ClassLoader) - Method in interface org.eclipse.microprofile.context.spi.ContextManagerProvider: Gets a ContextManager for the given ClassLoader.
getContextManagerBuilder() - Method in interface org.eclipse.microprofile.context.spi.ContextManagerProvider: Returns a new ContextManager.Builder to create new ContextManager instances.
getThreadContextType() - Method in interface org.eclipse.microprofile.context.spi.ThreadContextProvider: Returns a human readable identifier for the type of thread context that is captured by this ThreadContextProvider implementation.

I

INSTANCE - Static variable in interface org.eclipse.microprofile.context.spi.ContextManagerProvider
instance() - Static method in interface org.eclipse.microprofile.context.spi.ContextManagerProvider: Obtains the ContextManagerProvider instance that has been previously registered, or uses ServiceLoader to load and register a ContextManagerProvider from the current context class loader.

M

ManagedExecutor - Interface in org.eclipse.microprofile.context: A container-managed executor service that creates instances of CompletableFuture, which it backs as the default asynchronous execution facility, both for the CompletableFuture itself as well as all dependent stages created from it, as well as all dependent stages created from those, and so on.
ManagedExecutor.Builder - Interface in org.eclipse.microprofile.context: Builder for ManagedExecutor instances.
maxAsync(int) - Method in interface org.eclipse.microprofile.context.ManagedExecutor.Builder: Establishes an upper bound on the number of async completion stage actions and async executor tasks that can be running at any given point in time.
maxQueued(int) - Method in interface org.eclipse.microprofile.context.ManagedExecutor.Builder: Establishes an upper bound on the number of async actions and async tasks that can be queued up for execution.

N

newIncompleteFuture() - Method in interface org.eclipse.microprofile.context.ManagedExecutor: Returns a new incomplete CompletableFuture.
newManagedExecutorBuilder() - Method in interface org.eclipse.microprofile.context.spi.ContextManager: Creates a new ManagedExecutor.Builder instance.
newThreadContextBuilder() - Method in interface org.eclipse.microprofile.context.spi.ContextManager: Creates a new ThreadContext.Builder instance.
NONE - Static variable in interface org.eclipse.microprofile.context.ThreadContext: An empty array of thread context.

O

org.eclipse.microprofile.context - package org.eclipse.microprofile.context
org.eclipse.microprofile.context.spi - package org.eclipse.microprofile.context.spi

P

propagated(String...) - Method in interface org.eclipse.microprofile.context.ManagedExecutor.Builder: Defines the set of thread context types to capture from the thread that creates a dependent stage (or that submits a task) and which to propagate to the thread where the action or task executes.
propagated(String...) - Method in interface org.eclipse.microprofile.context.ThreadContext.Builder: Defines the set of thread context types to capture from the thread that contextualizes an action or task.

R

register(ContextManagerProvider) - Static method in interface org.eclipse.microprofile.context.spi.ContextManagerProvider: Allows the container to register the ContextManagerProvider implementation.
registerContextManager(ContextManager, ClassLoader) - Method in interface org.eclipse.microprofile.context.spi.ContextManagerProvider: Registers the given ContextManager for the given ClassLoader, so that further calls to ContextManagerProvider.getContextManager(ClassLoader) for the same ClassLoader will return this instance instead of creating a new one.
releaseContextManager(ContextManager) - Method in interface org.eclipse.microprofile.context.spi.ContextManagerProvider: Releases a ContextManager that was previously registered with ContextManagerProvider.registerContextManager(ContextManager, ClassLoader).
runAsync(Runnable) - Method in interface org.eclipse.microprofile.context.ManagedExecutor: Returns a new CompletableFuture that is completed by a task running in this executor after it runs the given action.

S

SECURITY - Static variable in interface org.eclipse.microprofile.context.ThreadContext: Identifier for security context.
setup(ContextManager) - Method in interface org.eclipse.microprofile.context.spi.ContextManagerExtension: This method is called after every ContextManager instance has been successfully created.
supplyAsync(Supplier<U>) - Method in interface org.eclipse.microprofile.context.ManagedExecutor: Returns a new CompletableFuture that is completed by a task running in this executor after it runs the given action.

T

ThreadContext - Interface in org.eclipse.microprofile.context: This interface offers various methods for capturing the context of the current thread and applying it to various interfaces that are commonly used with completion stages and executor services.
ThreadContext.Builder - Interface in org.eclipse.microprofile.context: Builder for ThreadContext instances.
ThreadContextController - Interface in org.eclipse.microprofile.context.spi: Represents context that is applied to a particular thread, along with any state that is associated with it or that is necessary for restoring the previous context afterward.
ThreadContextProvider - Interface in org.eclipse.microprofile.context.spi: Third party providers of thread context implement this interface to enable the provided type of context to participate in thread context capture and propagation when the ManagedExecutor and ThreadContext are used to create and contextualize dependent actions and tasks.
ThreadContextSnapshot - Interface in org.eclipse.microprofile.context.spi: An immutable snapshot of a particular type of thread context.
TRANSACTION - Static variable in interface org.eclipse.microprofile.context.ThreadContext: Identifier for transaction context.

U

unchanged(String...) - Method in interface org.eclipse.microprofile.context.ThreadContext.Builder: Defines a set of thread context types that are essentially ignored, in that they are neither captured nor are they propagated or cleared from thread(s) that execute the action or task.
unregister() - Method in class org.eclipse.microprofile.context.spi.ContextManagerProviderRegistration: Unregister the ContextManagerProvider that is represented by this ContextManagerProviderRegistration instance.

W

withContextCapture(CompletableFuture<T>) - Method in interface org.eclipse.microprofile.context.ThreadContext: Returns a new CompletableFuture that is completed by the completion of the specified stage.
withContextCapture(CompletionStage<T>) - Method in interface org.eclipse.microprofile.context.ThreadContext: Returns a new CompletionStage that is completed by the completion of the specified stage.
withContextManagerExtensions(ContextManagerExtension...) - Method in interface org.eclipse.microprofile.context.spi.ContextManager.Builder: Use the specified ContextManagerExtension instances.
withThreadContextProviders(ThreadContextProvider...) - Method in interface org.eclipse.microprofile.context.spi.ContextManager.Builder: Use the specified ThreadContextProvider instances.

A B C E F G I M N O P R S T U W