com.sap.cloud.sdk.cloudplatform.servlet

Class DefaultRequestContext

java.lang.Object

com.sap.cloud.sdk.cloudplatform.servlet.DefaultRequestContext

All Implemented Interfaces:

RequestContext

public class DefaultRequestContext
extends Object
implements RequestContext

This class represents the default implementation of RequestContext. It represents the context of a request that can be accessed from within other threads outside the thread that is spawned for the incoming servlet request.

Constructor Summary

Constructors

Constructor and Description
DefaultRequestContext(javax.servlet.http.HttpServletRequest request) Default constructor initializing this RequestContext with the given HttpServletRequest.

Method Summary

Modifier and Type	Method and Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
ConcurrentMap<String,Property<?>>	getProperties()
Optional<Property<?>>	getProperty(String name) Retrieves the property for the given name.
Optional<javax.servlet.http.HttpServletRequest>	getRequest()
long	getRequestThreadId()
int	hashCode()
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.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DefaultRequestContext

public DefaultRequestContext(@Nullable
                             javax.servlet.http.HttpServletRequest request)

Default constructor initializing this RequestContext with the given HttpServletRequest.

Parameters:

request - The HttpServletRequest for this RequestContext. May be null to initialize a RequestContext that may be needed by background tasks that are not triggered by a request.

Method Detail

getRequest

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

Specified by:

getRequest in interface RequestContext

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

getProperty

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

Specified by:

getProperty in interface RequestContext

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

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

Specified by:

setPropertyIfAbsent in interface RequestContext

Throws:

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

removeProperty

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

Removes the property with the given name.

Caution: Implementations may not be thread-safe!

Specified by:

removeProperty in interface RequestContext

Returns:

The removed value, if present.

Throws:

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

toString

public String toString()

Overrides:

toString in class Object

getProperties

public ConcurrentMap<String,Property<?>> getProperties()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getRequestThreadId

public long getRequestThreadId()

Specified by:

getRequestThreadId in interface RequestContext

Returns:

The identifier of the original thread serving the request.