com.sap.cloud.sdk.cloudplatform.security.principal

Class PrincipalThreadContextListener

java.lang.Object

com.sap.cloud.sdk.cloudplatform.security.principal.PrincipalThreadContextListener

All Implemented Interfaces:

ThreadContextListener, Comparable<ThreadContextListener>

public class PrincipalThreadContextListener
extends Object
implements ThreadContextListener

Implementation of ThreadContextListener that ensures the correct initialization of Principals when working with non-container managed threads on all supported Cloud platforms.

Nested Class Summary

Nested classes/interfaces inherited from interface com.sap.cloud.sdk.cloudplatform.thread.ThreadContextListener

ThreadContextListener.DefaultPriorities

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROPERTY_PRINCIPAL The ThreadContext key.

Constructor Summary

Constructors

Constructor and Description
PrincipalThreadContextListener() Default constructor.
PrincipalThreadContextListener(Principal principal) Constructor for providing a Principal to be returned by this listener.

Method Summary

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.sap.cloud.sdk.cloudplatform.thread.ThreadContextListener

afterDestroy, beforeInitialize, compareTo

Field Detail

PROPERTY_PRINCIPAL

public static final String PROPERTY_PRINCIPAL

The ThreadContext key.

Constructor Detail

PrincipalThreadContextListener

public PrincipalThreadContextListener()

Default constructor.

PrincipalThreadContextListener

public PrincipalThreadContextListener(@Nonnull
                                      Principal principal)

Constructor for providing a Principal to be returned by this listener.

Parameters:

principal - The Principal to be used by this listener.

Method Detail

getPriority

public 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.

Specified by:

getPriority in interface ThreadContextListener

Returns:

The priority of this listener implementation.

afterInitialize

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

Invoked after the current ThreadContext is initialized and set.

Specified by:

afterInitialize in interface ThreadContextListener

Parameters:

threadContext - The ThreadContext that was initialized is now set.

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

beforeDestroy

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

Invoked before the current ThreadContext is destroyed and reset.

Specified by:

beforeDestroy in interface ThreadContextListener

Parameters:

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

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