Package org.apache.hc.client5.http.cache

Class HttpCacheContext.Delegate

java.lang.Object

org.apache.hc.core5.http.protocol.HttpCoreContext

org.apache.hc.client5.http.protocol.HttpClientContext

org.apache.hc.client5.http.cache.HttpCacheContext

org.apache.hc.client5.http.cache.HttpCacheContext.Delegate

All Implemented Interfaces:

org.apache.hc.core5.http.protocol.HttpContext

Enclosing class:

HttpCacheContext

@Internal
static class HttpCacheContext.Delegate
extends HttpCacheContext

Internal adaptor class that delegates all its method calls to HttpClientContext. To be removed in the future.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hc.client5.http.cache.HttpCacheContext

HttpCacheContext.Delegate

Field Summary

Fields

Modifier and Type	Field	Description
private HttpClientContext	clientContext

Fields inherited from class org.apache.hc.client5.http.cache.HttpCacheContext

CACHE_ENTRY, CACHE_RESPONSE_STATUS, REQUEST_CACHE_CONTROL, RESPONSE_CACHE_CONTROL

Fields inherited from class org.apache.hc.client5.http.protocol.HttpClientContext

AUTH_CACHE, AUTH_EXCHANGE_MAP, AUTHSCHEME_REGISTRY, COOKIE_ORIGIN, COOKIE_SPEC, COOKIE_STORE, COOKIESPEC_REGISTRY, CREDS_PROVIDER, EXCHANGE_ID, HTTP_ROUTE, REDIRECT_LOCATIONS, REQUEST_CONFIG, USER_TOKEN

Fields inherited from class org.apache.hc.core5.http.protocol.HttpCoreContext

CONNECTION_ENDPOINT, HTTP_REQUEST, HTTP_RESPONSE, SSL_SESSION

Fields inherited from interface org.apache.hc.core5.http.protocol.HttpContext

RESERVED_PREFIX

Constructor Summary

Constructors

Constructor	Description
Delegate(HttpClientContext clientContext)

Method Summary

Modifier and Type	Method	Description
java.lang.Object	getAttribute(java.lang.String id)
<T> T	getAttribute(java.lang.String id, java.lang.Class<T> clazz)
AuthCache	getAuthCache()	Represents a AuthCache used in the context of the request execution.
AuthExchange	getAuthExchange(org.apache.hc.core5.http.HttpHost host)
java.util.Map<org.apache.hc.core5.http.HttpHost,AuthExchange>	getAuthExchanges()	Represents a map of AuthExchanges performed in the context of the request execution.
org.apache.hc.core5.http.config.Lookup<AuthSchemeFactory>	getAuthSchemeRegistry()	Represents a AuthSchemeFactory registry used in the context of the request execution.
HttpCacheEntry	getCacheEntry()	Represents the cache entry the resource of which has been used to generate the response.
CacheResponseStatus	getCacheResponseStatus()	Represents an outcome of the cache operation and the way the response has been generated.
CookieOrigin	getCookieOrigin()	Represents a CookieOrigin produced in the context of request execution.
CookieSpec	getCookieSpec()	Represents a CookieSpec chosen in the context of request execution.
org.apache.hc.core5.http.config.Lookup<CookieSpecFactory>	getCookieSpecRegistry()	Represents a CookieSpecFactory registry used in the context of the request execution.
CookieStore	getCookieStore()	Represents a CookieStore used in the context of the request execution.
CredentialsProvider	getCredentialsProvider()	Represents a CredentialsProvider registry used in the context of the request execution.
org.apache.hc.core5.http.EndpointDetails	getEndpointDetails()
java.lang.String	getExchangeId()	Represents an identifier generated for the current message exchange executed in the given context.
RouteInfo	getHttpRoute()	Represents current route used to execute message exchanges.
org.apache.hc.core5.http.ProtocolVersion	getProtocolVersion()
RedirectLocations	getRedirectLocations()	Represents a collection of all redirects executed in the context of request execution.
org.apache.hc.core5.http.HttpRequest	getRequest()
RequestCacheControl	getRequestCacheControl()	Represents cache control requested by the client.
RequestConfig	getRequestConfig()	Represents an used in the context of the request execution.
org.apache.hc.core5.http.HttpResponse	getResponse()
ResponseCacheControl	getResponseCacheControl()	Represents cache control enforced by the server.
javax.net.ssl.SSLSession	getSSLSession()
java.lang.Object	getUserToken()	Represents an arbitrary user token that identifies the user in the context of the request execution.
java.lang.Object	removeAttribute(java.lang.String id)
void	resetAuthExchange(org.apache.hc.core5.http.HttpHost host, AuthScheme authScheme)
java.lang.Object	setAttribute(java.lang.String id, java.lang.Object obj)
void	setAuthCache(AuthCache authCache)
void	setAuthExchange(org.apache.hc.core5.http.HttpHost host, AuthExchange authExchange)
void	setAuthSchemeRegistry(org.apache.hc.core5.http.config.Lookup<AuthSchemeFactory> lookup)
void	setCacheEntry(HttpCacheEntry cacheEntry)
void	setCacheResponseStatus(CacheResponseStatus responseStatus)
void	setCookieOrigin(CookieOrigin cookieOrigin)
void	setCookieSpec(CookieSpec cookieSpec)
void	setCookieSpecRegistry(org.apache.hc.core5.http.config.Lookup<CookieSpecFactory> lookup)
void	setCookieStore(CookieStore cookieStore)
void	setCredentialsProvider(CredentialsProvider credentialsProvider)
void	setEndpointDetails(org.apache.hc.core5.http.EndpointDetails endpointDetails)
void	setExchangeId(java.lang.String exchangeId)
void	setProtocolVersion(org.apache.hc.core5.http.ProtocolVersion version)
void	setRedirectLocations(RedirectLocations redirectLocations)
void	setRequest(org.apache.hc.core5.http.HttpRequest request)
void	setRequestCacheControl(RequestCacheControl requestCacheControl)
void	setRequestConfig(RequestConfig requestConfig)
void	setResponse(org.apache.hc.core5.http.HttpResponse response)
void	setResponseCacheControl(ResponseCacheControl responseCacheControl)
void	setRoute(HttpRoute route)
void	setSSLSession(javax.net.ssl.SSLSession sslSession)
void	setUserToken(java.lang.Object userToken)
java.lang.String	toString()

Methods inherited from class org.apache.hc.client5.http.cache.HttpCacheContext

adapt, cast, castOrCreate, create, getRequestCacheControlOrDefault, getResponseCacheControlOrDefault

Methods inherited from class org.apache.hc.client5.http.protocol.HttpClientContext

getNextNonce, getRequestConfigOrDefault, getUserToken, setNextNonce

Methods inherited from class java.lang.Object

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

Field Detail

clientContext

private final HttpClientContext clientContext

Constructor Detail

Delegate

Delegate(HttpClientContext clientContext)

Method Detail

getCacheResponseStatus

public CacheResponseStatus getCacheResponseStatus()

Description copied from class: HttpCacheContext

Represents an outcome of the cache operation and the way the response has been generated.

This context attribute is expected to be populated by the protocol handler.

Overrides:

getCacheResponseStatus in class HttpCacheContext

setCacheResponseStatus

public void setCacheResponseStatus(CacheResponseStatus responseStatus)

Overrides:

setCacheResponseStatus in class HttpCacheContext

getRequestCacheControl

public RequestCacheControl getRequestCacheControl()

Description copied from class: HttpCacheContext

Represents cache control requested by the client.

This context attribute is expected to be set by the caller.

Overrides:

getRequestCacheControl in class HttpCacheContext

setRequestCacheControl

public void setRequestCacheControl(RequestCacheControl requestCacheControl)

Overrides:

setRequestCacheControl in class HttpCacheContext

getResponseCacheControl

public ResponseCacheControl getResponseCacheControl()

Description copied from class: HttpCacheContext

Represents cache control enforced by the server.

This context attribute is expected to be populated by the protocol handler.

Overrides:

getResponseCacheControl in class HttpCacheContext

setResponseCacheControl

public void setResponseCacheControl(ResponseCacheControl responseCacheControl)

Overrides:

setResponseCacheControl in class HttpCacheContext

getCacheEntry

public HttpCacheEntry getCacheEntry()

Description copied from class: HttpCacheContext

Represents the cache entry the resource of which has been used to generate the response.

This context attribute is expected to be populated by the protocol handler.

Overrides:

getCacheEntry in class HttpCacheContext

setCacheEntry

public void setCacheEntry(HttpCacheEntry cacheEntry)

Overrides:

setCacheEntry in class HttpCacheContext

getHttpRoute

public RouteInfo getHttpRoute()

Description copied from class: HttpClientContext

Represents current route used to execute message exchanges.

This context attribute is expected to be populated by the protocol handler.

Overrides:

getHttpRoute in class HttpClientContext

setRoute

@Internal
public void setRoute(HttpRoute route)

Overrides:

setRoute in class HttpClientContext

getRedirectLocations

public RedirectLocations getRedirectLocations()

Description copied from class: HttpClientContext

Represents a collection of all redirects executed in the context of request execution.

This context attribute is expected to be populated by the protocol handler.

Overrides:

getRedirectLocations in class HttpClientContext

setRedirectLocations

@Internal
public void setRedirectLocations(RedirectLocations redirectLocations)

Overrides:

setRedirectLocations in class HttpClientContext

getCookieStore

public CookieStore getCookieStore()

Description copied from class: HttpClientContext

Represents a CookieStore used in the context of the request execution.

This context attribute can be set by the caller.

Overrides:

getCookieStore in class HttpClientContext

setCookieStore

public void setCookieStore(CookieStore cookieStore)

Overrides:

setCookieStore in class HttpClientContext

getCookieSpec

public CookieSpec getCookieSpec()

Description copied from class: HttpClientContext

Represents a CookieSpec chosen in the context of request execution.

This context attribute is expected to be populated by the protocol handler.

Overrides:

getCookieSpec in class HttpClientContext

setCookieSpec

@Internal
public void setCookieSpec(CookieSpec cookieSpec)

Overrides:

setCookieSpec in class HttpClientContext

getCookieOrigin

public CookieOrigin getCookieOrigin()

Description copied from class: HttpClientContext

Represents a CookieOrigin produced in the context of request execution.

This context attribute is expected to be populated by the protocol handler.

Overrides:

getCookieOrigin in class HttpClientContext

setCookieOrigin

@Internal
public void setCookieOrigin(CookieOrigin cookieOrigin)

Overrides:

setCookieOrigin in class HttpClientContext

getCookieSpecRegistry

public org.apache.hc.core5.http.config.Lookup<CookieSpecFactory> getCookieSpecRegistry()

Description copied from class: HttpClientContext

Represents a CookieSpecFactory registry used in the context of the request execution.

This context attribute can be set by the caller.

Overrides:

getCookieSpecRegistry in class HttpClientContext

setCookieSpecRegistry

public void setCookieSpecRegistry(org.apache.hc.core5.http.config.Lookup<CookieSpecFactory> lookup)

Overrides:

setCookieSpecRegistry in class HttpClientContext

getAuthSchemeRegistry

public org.apache.hc.core5.http.config.Lookup<AuthSchemeFactory> getAuthSchemeRegistry()

Description copied from class: HttpClientContext

Represents a AuthSchemeFactory registry used in the context of the request execution.

This context attribute can be set by the caller.

Overrides:

getAuthSchemeRegistry in class HttpClientContext

setAuthSchemeRegistry

public void setAuthSchemeRegistry(org.apache.hc.core5.http.config.Lookup<AuthSchemeFactory> lookup)

Overrides:

setAuthSchemeRegistry in class HttpClientContext

getCredentialsProvider

public CredentialsProvider getCredentialsProvider()

Description copied from class: HttpClientContext

Represents a CredentialsProvider registry used in the context of the request execution.

This context attribute can be set by the caller.

Overrides:

getCredentialsProvider in class HttpClientContext

setCredentialsProvider

public void setCredentialsProvider(CredentialsProvider credentialsProvider)

Overrides:

setCredentialsProvider in class HttpClientContext

getAuthCache

public AuthCache getAuthCache()

Description copied from class: HttpClientContext

Represents a AuthCache used in the context of the request execution.

This context attribute can be set by the caller.

Overrides:

getAuthCache in class HttpClientContext

setAuthCache

public void setAuthCache(AuthCache authCache)

Overrides:

setAuthCache in class HttpClientContext

getAuthExchanges

public java.util.Map<org.apache.hc.core5.http.HttpHost,AuthExchange> getAuthExchanges()

Description copied from class: HttpClientContext

Represents a map of AuthExchanges performed in the context of the request execution.

This context attribute is expected to be populated by the protocol handler.

Overrides:

getAuthExchanges in class HttpClientContext

getAuthExchange

public AuthExchange getAuthExchange(org.apache.hc.core5.http.HttpHost host)

Overrides:

getAuthExchange in class HttpClientContext

setAuthExchange

public void setAuthExchange(org.apache.hc.core5.http.HttpHost host,
                            AuthExchange authExchange)

Overrides:

setAuthExchange in class HttpClientContext

resetAuthExchange

public void resetAuthExchange(org.apache.hc.core5.http.HttpHost host,
                              AuthScheme authScheme)

Overrides:

resetAuthExchange in class HttpClientContext

getUserToken

public java.lang.Object getUserToken()

Description copied from class: HttpClientContext

Represents an arbitrary user token that identifies the user in the context of the request execution.

This context attribute can be set by the caller.

Overrides:

getUserToken in class HttpClientContext

setUserToken

public void setUserToken(java.lang.Object userToken)

Overrides:

setUserToken in class HttpClientContext

getRequestConfig

public RequestConfig getRequestConfig()

Description copied from class: HttpClientContext

Represents an used in the context of the request execution.

This context attribute can be set by the caller.

Overrides:

getRequestConfig in class HttpClientContext

setRequestConfig

public void setRequestConfig(RequestConfig requestConfig)

Overrides:

setRequestConfig in class HttpClientContext

getExchangeId

public java.lang.String getExchangeId()

Description copied from class: HttpClientContext

Represents an identifier generated for the current message exchange executed in the given context.

This context attribute is expected to be populated by the protocol handler.

Overrides:

getExchangeId in class HttpClientContext

setExchangeId

public void setExchangeId(java.lang.String exchangeId)

Overrides:

setExchangeId in class HttpClientContext

getRequest

public org.apache.hc.core5.http.HttpRequest getRequest()

Overrides:

getRequest in class org.apache.hc.core5.http.protocol.HttpCoreContext

setRequest

public void setRequest(org.apache.hc.core5.http.HttpRequest request)

Overrides:

setRequest in class org.apache.hc.core5.http.protocol.HttpCoreContext

getResponse

public org.apache.hc.core5.http.HttpResponse getResponse()

Overrides:

getResponse in class org.apache.hc.core5.http.protocol.HttpCoreContext

setResponse

public void setResponse(org.apache.hc.core5.http.HttpResponse response)

Overrides:

setResponse in class org.apache.hc.core5.http.protocol.HttpCoreContext

getEndpointDetails

public org.apache.hc.core5.http.EndpointDetails getEndpointDetails()

Overrides:

getEndpointDetails in class org.apache.hc.core5.http.protocol.HttpCoreContext

setEndpointDetails

public void setEndpointDetails(org.apache.hc.core5.http.EndpointDetails endpointDetails)

Overrides:

setEndpointDetails in class org.apache.hc.core5.http.protocol.HttpCoreContext

getSSLSession

public javax.net.ssl.SSLSession getSSLSession()

Overrides:

getSSLSession in class org.apache.hc.core5.http.protocol.HttpCoreContext

setSSLSession

public void setSSLSession(javax.net.ssl.SSLSession sslSession)

Overrides:

setSSLSession in class org.apache.hc.core5.http.protocol.HttpCoreContext

getProtocolVersion

public org.apache.hc.core5.http.ProtocolVersion getProtocolVersion()

Specified by:

getProtocolVersion in interface org.apache.hc.core5.http.protocol.HttpContext

Overrides:

getProtocolVersion in class org.apache.hc.core5.http.protocol.HttpCoreContext

setProtocolVersion

public void setProtocolVersion(org.apache.hc.core5.http.ProtocolVersion version)

Specified by:

setProtocolVersion in interface org.apache.hc.core5.http.protocol.HttpContext

Overrides:

setProtocolVersion in class org.apache.hc.core5.http.protocol.HttpCoreContext

getAttribute

public java.lang.Object getAttribute(java.lang.String id)

Specified by:

getAttribute in interface org.apache.hc.core5.http.protocol.HttpContext

Overrides:

getAttribute in class org.apache.hc.core5.http.protocol.HttpCoreContext

setAttribute

public java.lang.Object setAttribute(java.lang.String id,
                                     java.lang.Object obj)

Specified by:

setAttribute in interface org.apache.hc.core5.http.protocol.HttpContext

Overrides:

setAttribute in class org.apache.hc.core5.http.protocol.HttpCoreContext

removeAttribute

public java.lang.Object removeAttribute(java.lang.String id)

Specified by:

removeAttribute in interface org.apache.hc.core5.http.protocol.HttpContext

Overrides:

removeAttribute in class org.apache.hc.core5.http.protocol.HttpCoreContext

getAttribute

public <T> T getAttribute(java.lang.String id,
                          java.lang.Class<T> clazz)

Overrides:

getAttribute in class org.apache.hc.core5.http.protocol.HttpCoreContext

toString

public java.lang.String toString()

Overrides:

toString in class org.apache.hc.core5.http.protocol.HttpCoreContext