com.sap.cloud.sdk.cloudplatform.thread

Interface ThreadContextListener

All Superinterfaces:

Comparable<ThreadContextListener>

All Known Implementing Classes:

AuthTokenThreadContextListener, BasicAuthenticationThreadContextListener, HttpClientsThreadContextListener, PrincipalThreadContextListener, RequestThreadContextListener, ScpNeoAuditLogThreadContextListener, ScpNeoDestinationsThreadContextListener, ScpNeoSecretStoreThreadContextListener, TenantThreadContextListener

public interface ThreadContextListener
extends Comparable<ThreadContextListener>

Enables listening to lifecycle events of a ThreadContext. ThreadContextListeners are invoked by a ThreadContextExecutor.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ThreadContextListener.DefaultPriorities The priorities used to order the default listeners provided by the SDK.

Method Summary

Modifier and Type	Method and Description
default void	afterDestroy(ThreadContext threadContext, ThreadContext parentThreadContext) Invoked after the current ThreadContext is destroyed and reset.
default void	afterInitialize(ThreadContext threadContext, ThreadContext parentThreadContext) Invoked after the current ThreadContext is initialized and set.
default void	beforeDestroy(ThreadContext threadContext, ThreadContext parentThreadContext) Invoked before the current ThreadContext is destroyed and reset.
default void	beforeInitialize(ThreadContext threadContext, ThreadContext parentThreadContext) Invoked before the current ThreadContext is initialized and set.
default int	compareTo(ThreadContextListener other)
int	getPriority() Returns the priority that defines the order in which listeners are invoked.

Method Detail

getPriority

int getPriority()

Returns the priority that defines the order in which listeners are invoked. Smaller priorities are invoked earlier during context initialization and invoked later (reversed initialization order) during context destruction. Negative number must not be used as they are reserved for internal use.

Returns:

The priority of this listener implementation.

beforeInitialize

default void beforeInitialize(@Nonnull
                              ThreadContext threadContext,
                              @Nullable
                              ThreadContext parentThreadContext)

Invoked before the current ThreadContext is initialized and set. This method can be used, for example, to inherit properties from the parent context.

Parameters:

threadContext - The ThreadContext that is initialized and will be set.

parentThreadContext - The existing parent ThreadContext, or null if there is currently no ThreadContext.

afterInitialize

default void afterInitialize(@Nonnull
                             ThreadContext threadContext,
                             @Nullable
                             ThreadContext parentThreadContext)

Invoked after the current ThreadContext is initialized and set.

Parameters:

threadContext - The ThreadContext that was initialized is now set.

parentThreadContext - The parent ThreadContext, or null if there is no parent ThreadContext.

beforeDestroy

default void beforeDestroy(@Nonnull
                           ThreadContext threadContext,
                           @Nullable
                           ThreadContext parentThreadContext)

Invoked before the current ThreadContext is destroyed and reset.

Parameters:

threadContext - The ThreadContext that is destroyed and will be removed.

parentThreadContext - The parent ThreadContext, or null if there is no parent ThreadContext.

afterDestroy

default void afterDestroy(@Nonnull
                          ThreadContext threadContext,
                          @Nullable
                          ThreadContext parentThreadContext)

Invoked after the current ThreadContext is destroyed and reset.

Parameters:

threadContext - The ThreadContext that was destroyed and removed.

parentThreadContext - The parent ThreadContext, or null if there is no parent ThreadContext.

compareTo

default int compareTo(@Nonnull
                      ThreadContextListener other)

Specified by:

compareTo in interface Comparable<ThreadContextListener>