Package com.sap.cloud.sdk.cloudplatform.requestheader

Class RequestHeaderAccessor

java.lang.Object

com.sap.cloud.sdk.cloudplatform.requestheader.RequestHeaderAccessor

public final class RequestHeaderAccessor
extends Object

Accessor for retrieving the RequestHeaderContainer of the current context.

Method Summary

Modifier and Type	Method	Description
static void	executeWithFallbackHeaderContainer(Supplier<RequestHeaderContainer> headers, Executable executable)	Runs the given executable with the given headers as a fallback option that should be used in case there is no current RequestHeaderContainer.
static <T> T	executeWithFallbackHeaderContainer(Supplier<RequestHeaderContainer> headers, Callable<T> callable)	Runs the given callable with the given headers as a fallback option that should be used in case there is no current RequestHeaderContainer.
static void	executeWithHeaderContainer(RequestHeaderContainer headers, Executable executable)	Runs the given executable with the given headers available.
static <T> T	executeWithHeaderContainer(RequestHeaderContainer headers, Callable<T> callable)	Runs the given callable with the given headers available and returns the result.
static void	executeWithHeaderContainer(Map<String,String> headers, Executable executable)	Runs the given executable with the given headers available.
static <T> T	executeWithHeaderContainer(Map<String,String> headers, Callable<T> callable)	Runs the given callable with the given headers available and returns the result.
static Supplier<RequestHeaderContainer>	getFallbackHeaderContainer()
static RequestHeaderContainer	getHeaderContainer()	Returns the current RequestHeaderContainer.
static RequestHeaderFacade	getHeaderFacade()
static void	setFallbackHeaderContainer(Supplier<RequestHeaderContainer> fallbackHeaderContainer)
static void	setHeaderFacade(RequestHeaderFacade requestHeaderFacade)	Sets the RequestHeaderFacade to use.
static io.vavr.control.Try<RequestHeaderContainer>	tryGetHeaderContainer()	Tries to get the current RequestHeaderContainer.

Methods inherited from class java.lang.Object

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

Method Details

setHeaderFacade

@Beta
public static void setHeaderFacade(@Nullable
 RequestHeaderFacade requestHeaderFacade)

Sets the RequestHeaderFacade to use.

Parameters:

requestHeaderFacade - The RequestHeaderFacade to use, or null if the default RequestHeaderFacade should be used.

getHeaderContainer

@Nonnull
public static RequestHeaderContainer getHeaderContainer()
                                                 throws RequestHeadersAccessException

Returns the current RequestHeaderContainer.

Returns:

The RequestHeaderContainer for the current context.

Throws:

RequestHeadersAccessException - If the current RequestHeaderContainer cannot be accessed.

tryGetHeaderContainer

@Nonnull
public static io.vavr.control.Try<RequestHeaderContainer> tryGetHeaderContainer()

Tries to get the current RequestHeaderContainer.

Returns:

A Try that might contain the current RequestHeaderContainer.

executeWithHeaderContainer

public static void executeWithHeaderContainer(@Nonnull
 Map<String,String> headers,
 @Nonnull
 Executable executable)
                                       throws ThreadContextExecutionException

Runs the given executable with the given headers available.

Parameters:

headers - The HTTP headers (name-value pairs) that should be available within the executable.

executable - The Executable to execute.

Throws:

ThreadContextExecutionException - If there is an issue when running the executable.

executeWithHeaderContainer

public static void executeWithHeaderContainer(@Nonnull
 RequestHeaderContainer headers,
 @Nonnull
 Executable executable)
                                       throws ThreadContextExecutionException

Runs the given executable with the given headers available.

Parameters:

headers - The RequestHeaderContainer that should be available within the executable.

executable - The Runnable to execute.

Throws:

ThreadContextExecutionException - If there is an issue when running the executable.

executeWithHeaderContainer

@Nullable
public static <T> T executeWithHeaderContainer(@Nonnull
 Map<String,String> headers,
 @Nonnull
 Callable<T> callable)
                                        throws ThreadContextExecutionException

Runs the given callable with the given headers available and returns the result.

Type Parameters:

T - The result type of the given callable.

Parameters:

headers - The HTTP headers (name-value pairs) that should be available within the callable.

callable - The Callable to run.

Returns:

The result of the callable.

Throws:

ThreadContextExecutionException - If there is an issue while running the given callable.

executeWithHeaderContainer

@Nullable
public static <T> T executeWithHeaderContainer(@Nonnull
 RequestHeaderContainer headers,
 @Nonnull
 Callable<T> callable)
                                        throws ThreadContextExecutionException

Runs the given callable with the given headers available and returns the result.

Type Parameters:

T - The result type of the given callable.

Parameters:

headers - The RequestHeaderContainer that should be available within the callable.

callable - The Callable to run.

Returns:

The result of the callable.

Throws:

ThreadContextExecutionException - If there is an issue while running the given callable.

executeWithFallbackHeaderContainer

public static void executeWithFallbackHeaderContainer(@Nonnull
 Supplier<RequestHeaderContainer> headers,
 @Nonnull
 Executable executable)
                                               throws ThreadContextExecutionException

Runs the given executable with the given headers as a fallback option that should be used in case there is no current RequestHeaderContainer.

Parameters:

headers - The fallback RequestHeaderContainer.

executable - The Executable to run.

Throws:

ThreadContextExecutionException - If there is an issue while running the given executable.

executeWithFallbackHeaderContainer

@Nullable
public static <T> T executeWithFallbackHeaderContainer(@Nonnull
 Supplier<RequestHeaderContainer> headers,
 @Nonnull
 Callable<T> callable)
                                                throws ThreadContextExecutionException

Runs the given callable with the given headers as a fallback option that should be used in case there is no current RequestHeaderContainer.

Type Parameters:

T - The return type of the given callable.

Parameters:

headers - The fallback RequestHeaderContainer.

callable - The Callable to run.

Returns:

The result of the given callable.

Throws:

ThreadContextExecutionException - If there is an issue while running the given callable.

getHeaderFacade

@Nonnull
public static RequestHeaderFacade getHeaderFacade()

getFallbackHeaderContainer

@Nullable
public static Supplier<RequestHeaderContainer> getFallbackHeaderContainer()

setFallbackHeaderContainer

public static void setFallbackHeaderContainer(@Nullable
 Supplier<RequestHeaderContainer> fallbackHeaderContainer)