com.sap.cloud.sdk.cloudplatform.servlet

Class RequestAccessor

java.lang.Object

com.sap.cloud.sdk.cloudplatform.servlet.RequestAccessor

public final class RequestAccessor
extends Object

Accessor for retrieving the current HttpServletRequest.

Method Summary

Modifier and Type	Method and Description
static <T> T	executeWithFallbackRequest(Supplier<javax.servlet.http.HttpServletRequest> fallbackRequest, Callable<T> callable) Execute the given Callable, using the given request as fallback if there is no other request available.
static void	executeWithFallbackRequest(Supplier<javax.servlet.http.HttpServletRequest> fallbackRequest, Executable executable) Execute the given Executable, using the given request as fallback if there is no other request available.
static <T> T	executeWithRequest(javax.servlet.http.HttpServletRequest request, Callable<T> callable) Execute the given Callable with a given request.
static void	executeWithRequest(javax.servlet.http.HttpServletRequest request, Executable executable) Execute the given Executable with a given request.
static javax.servlet.http.HttpServletRequest	getCurrentRequest() Returns the current HttpServletRequest, delegating to tryGetCurrentRequest() and unwrapping the Try.
static Supplier<javax.servlet.http.HttpServletRequest>	getFallbackRequest() Global fallback HttpServletRequest.
static RequestFacade	getRequestFacade() The RequestFacade instance.
static void	setFallbackRequest(Supplier<javax.servlet.http.HttpServletRequest> fallbackRequest) Global fallback HttpServletRequest.
static void	setRequestFacade(RequestFacade requestFacade) Replaces the default RequestFacade instance.
static io.vavr.control.Try<javax.servlet.http.HttpServletRequest>	tryGetCurrentRequest() Returns a Try of the current HttpServletRequest, or, if the Try is a failure, the global fallback.

Methods inherited from class java.lang.Object

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

Method Detail

setRequestFacade

public static void setRequestFacade(@Nullable
                                    RequestFacade requestFacade)

Replaces the default RequestFacade instance.

Parameters:

requestFacade - An instance of RequestFacade. Use null to reset the facade.

getCurrentRequest

@Nonnull
public static javax.servlet.http.HttpServletRequest getCurrentRequest()
                                                                        throws RequestAccessException

Returns the current HttpServletRequest, delegating to tryGetCurrentRequest() and unwrapping the Try.

Returns:

The current HttpServletRequest.

Throws:

RequestAccessException - If there is an issue while accessing the HttpServletRequest.

tryGetCurrentRequest

@Nonnull
public static io.vavr.control.Try<javax.servlet.http.HttpServletRequest> tryGetCurrentRequest()

Returns a Try of the current HttpServletRequest, or, if the Try is a failure, the global fallback.

Returns:

A Try of the current HttpServletRequest.

executeWithRequest

@Nullable
public static <T> T executeWithRequest(@Nonnull
                                                 javax.servlet.http.HttpServletRequest request,
                                                 @Nonnull
                                                 Callable<T> callable)
                                          throws ThreadContextExecutionException

Execute the given Callable with a given request.

Type Parameters:

T - The type of the callable.

Parameters:

request - The request to execute with.

callable - The callable to execute.

Returns:

The value computed by the callable.

Throws:

ThreadContextExecutionException - If there is an issue while running the code with the request.

executeWithRequest

public static void executeWithRequest(@Nonnull
                                      javax.servlet.http.HttpServletRequest request,
                                      @Nonnull
                                      Executable executable)
                               throws ThreadContextExecutionException

Execute the given Executable with a given request.

Parameters:

request - The request to execute with.

Throws:

ThreadContextExecutionException - If there is an issue while running the code with the request.

executeWithFallbackRequest

@Nullable
public static <T> T executeWithFallbackRequest(@Nonnull
                                                         Supplier<javax.servlet.http.HttpServletRequest> fallbackRequest,
                                                         @Nonnull
                                                         Callable<T> callable)
                                                  throws ThreadContextExecutionException

Execute the given Callable, using the given request as fallback if there is no other request available.

Type Parameters:

T - The type of the callable.

Parameters:

fallbackRequest - The request to fall back to.

callable - The callable to execute.

Returns:

The value computed by the callable.

Throws:

ThreadContextExecutionException - If there is an issue while running the code with the request.

executeWithFallbackRequest

public static void executeWithFallbackRequest(@Nonnull
                                              Supplier<javax.servlet.http.HttpServletRequest> fallbackRequest,
                                              @Nonnull
                                              Executable executable)
                                       throws ThreadContextExecutionException

Execute the given Executable, using the given request as fallback if there is no other request available.

Parameters:

fallbackRequest - The request to fall back to.

Throws:

ThreadContextExecutionException - If there is an issue while running the code with the request.

getRequestFacade

@Nonnull
public static RequestFacade getRequestFacade()

The RequestFacade instance.

getFallbackRequest

@Nullable
public static Supplier<javax.servlet.http.HttpServletRequest> getFallbackRequest()

Global fallback HttpServletRequest. By default, no fallback is used, i.e., the fallback is null. A global fallback can be useful to ease testing with a mocked request.

setFallbackRequest

public static void setFallbackRequest(@Nullable
                                      Supplier<javax.servlet.http.HttpServletRequest> fallbackRequest)

Global fallback HttpServletRequest. By default, no fallback is used, i.e., the fallback is null. A global fallback can be useful to ease testing with a mocked request.