com.sap.cloud.sdk.cloudplatform.servlet

Interface RequestContext

All Known Implementing Classes:

DefaultRequestContext, HystrixDelegatingRequestContext

public interface RequestContext

This class represents the context of a request. It abstracts from the general assumption that a thread always corresponds to a request in a web container. This is necessary when request-specific information needs to be accessed from within threads that are not managed by the container. Instances of this class are normally initialized by RequestContextServletFilter. In case an instance is required outside the normal servlet lifecycle (e.g. within background tasks), refer to RequestContextExecutor.

See Also:

RequestContextListener

Method Summary

Modifier and Type	Method and Description
Optional<Property<?>>	getProperty(String name) Retrieves the property for the given name.
Optional<javax.servlet.http.HttpServletRequest>	getRequest()
long	getRequestThreadId()
Optional<Property<?>>	removeProperty(String name) Removes the property with the given name.
void	setPropertyIfAbsent(String name, Property<?> value) Sets a value for the property for the given name, if it has not been set before.

Method Detail

getRequest

@Nonnull
Optional<javax.servlet.http.HttpServletRequest> getRequest()

Returns:

The HttpServletRequest of this instance, if present. Can be absent if the RequestContext has been created by a RequestContextExecutor when running outside the normal servlet lifecycle (e.g. within background tasks).

getRequestThreadId

long getRequestThreadId()

Returns:

The identifier of the original thread serving the request.

getProperty

@Nonnull
Optional<Property<?>> getProperty(@Nonnull
                                           String name)
                                    throws RequestContextPropertyException

Retrieves the property for the given name. Implementations have to ensure that this method is thread-safe.

Throws:

RequestContextPropertyException - If there is an issue while accessing the property or if the property has a different type than the one that is provided.

setPropertyIfAbsent

void setPropertyIfAbsent(@Nonnull
                         String name,
                         @Nonnull
                         Property<?> value)
                  throws RequestContextPropertyException

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.

Throws:

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

removeProperty

@Nonnull
Optional<Property<?>> removeProperty(@Nonnull
                                              String name)
                                       throws RequestContextPropertyException

Removes the property with the given name.

Caution: Implementations may not be thread-safe!

Returns:

The removed value, if present.

Throws:

RequestContextPropertyException - If there is an issue while removing the property.