Package org.nuxeo.ecm.platform.web.common

Class RequestContext

java.lang.Object

java.util.AbstractMap<String,Object>

java.util.HashMap<String,Object>

org.nuxeo.ecm.platform.web.common.RequestContext

All Implemented Interfaces:

Serializable, Cloneable, Map<String,Object>

public class RequestContext
extends HashMap<String,Object>

An HTTP request context

Author:

Bogdan Stefanescu

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field	Description
protected List<RequestCleanupHandler>	cleanupHandlers
protected jakarta.servlet.http.HttpServletRequest	request
protected jakarta.servlet.http.HttpServletResponse	response

Constructor Summary

Constructors

Constructor	Description
RequestContext(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)

Method Summary

Modifier and Type	Method	Description
void	addRequestCleanupHandler(RequestCleanupHandler handler)
void	dispose()
<T> T	get(String key, Class<T> type)
static RequestContext	getActiveContext()
static RequestContext	getActiveContext(jakarta.servlet.ServletRequest request)
jakarta.servlet.http.HttpServletRequest	getRequest()
jakarta.servlet.http.HttpServletResponse	getResponse()
Principal	getUserPrincipal()
boolean	removeCleanupHandler(RequestCleanupHandler handler)

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, newHashMap, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

equals, hashCode

Field Details

request

protected jakarta.servlet.http.HttpServletRequest request

response

protected jakarta.servlet.http.HttpServletResponse response

cleanupHandlers

protected List<RequestCleanupHandler> cleanupHandlers

Constructor Details

RequestContext

public RequestContext(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response)

Method Details

getActiveContext

public static RequestContext getActiveContext()

getActiveContext

public static RequestContext getActiveContext(jakarta.servlet.ServletRequest request)

getRequest

public jakarta.servlet.http.HttpServletRequest getRequest()

getResponse

public jakarta.servlet.http.HttpServletResponse getResponse()

getUserPrincipal

public Principal getUserPrincipal()

get

public <T> T get(String key,
 Class<T> type)

addRequestCleanupHandler

public void addRequestCleanupHandler(RequestCleanupHandler handler)

removeCleanupHandler

public boolean removeCleanupHandler(RequestCleanupHandler handler)

dispose

public void dispose()