com.sap.cloud.sdk.cloudplatform.thread

Interface ThreadContext

All Known Implementing Classes:

DefaultThreadContext

public interface ThreadContext

This class represents the context of a thread, allowing to access and share information transparently across threads. A typical use case for a thread context is to store information about the current request in a servlet container.

Method Summary

Modifier and Type	Method and Description
<T> io.vavr.control.Try<Property<T>>	getProperty(String name) Retrieves a Try of the property for the given name.
Thread	getThread() Returns the original thread.
<T> io.vavr.control.Try<Property<T>>	removeProperty(String name) Removes the property with the given name.
void	setPropertyIfAbsent(String name, io.vavr.control.Try<Property<?>> value) Sets a value for the property for the given name, if it has not been set before.

Method Detail

getThread

@Nonnull
Thread getThread()

Returns the original thread.

Returns:

The original thread.

getProperty

@Nonnull
<T> io.vavr.control.Try<Property<T>> getProperty(@Nonnull
                                                          String name)
                                                   throws ClassCastException

Retrieves a Try of the property for the given name. The Try is considered to fail in case of exceptions or if the property does not exist. Implementations have to ensure that this method is thread-safe.

Parameters:

name - The name of the property.

Returns:

A Try of the property.

Throws:

ClassCastException - If the property cannot be cast to the desired type.

setPropertyIfAbsent

void setPropertyIfAbsent(@Nonnull
                         String name,
                         @Nonnull
                         io.vavr.control.Try<Property<?>> value)
                  throws ThreadContextPropertyException

Sets a value for the property for the given name, if it has not been set before. Implementations have to ensure that this method is thread-safe.

Parameters:

name - The name of the property.

value - A Try of the property.

Throws:

ThreadContextPropertyException - If there is an issue while setting the property.

removeProperty

@Nonnull
<T> io.vavr.control.Try<Property<T>> removeProperty(@Nonnull
                                                             String name)
                                                      throws ClassCastException

Removes the property with the given name.

Caution: Implementations may not be thread-safe!

Parameters:

name - The name of the property.

Returns:

A Try holding the removed value, or a failure if there was an exception or the property does not exist.

Throws:

ClassCastException - If the property cannot be cast to the desired type.