HttpClientContext

java.lang.Object
- org.apache.hc.core5.http.protocol.HttpCoreContext
- - org.apache.hc.client5.http.protocol.HttpClientContext

All Implemented Interfaces:

HttpContext
```
public class HttpClientContext
extends HttpCoreContext
```
Adaptor class that provides convenience type safe setters and getters for common HttpContext attributes used in the course of HTTP request execution.

Since:

4.3

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`AUTH_CACHE` Attribute name of a `AuthCache` object that represents the auth scheme cache.
`static String`	`AUTH_EXCHANGE_MAP` Attribute name of a map containing actual `AuthExchange`s keyed by their respective `HttpHost`.
`static String`	`AUTHSCHEME_REGISTRY` Attribute name of a `Lookup` object that represents the actual `AuthSchemeFactory` registry.
`static String`	`COOKIE_ORIGIN` Attribute name of a `CookieOrigin` object that represents the actual details of the origin server.
`static String`	`COOKIE_SPEC` Attribute name of a `CookieSpec` object that represents the actual cookie specification.
`static String`	`COOKIE_STORE` Attribute name of a `CookieStore` object that represents the actual cookie store.
`static String`	`COOKIESPEC_REGISTRY` Attribute name of a `Lookup` object that represents the actual `CookieSpecFactory` registry.
`static String`	`CREDS_PROVIDER` Attribute name of a `CredentialsProvider` object that represents the actual credentials provider.
`static String`	`HTTP_ROUTE` Attribute name of a `RouteInfo` object that represents the actual connection route.
`static String`	`REDIRECT_LOCATIONS` Attribute name of a `RedirectLocations` object that represents a collection of all redirect locations received in the process of request execution.
`static String`	`REQUEST_CONFIG` Attribute name of a `RequestConfig` object that represents the actual request configuration.
`static String`	`USER_TOKEN` Attribute name of a `Object` object that represents the actual user identity such as user `Principal`.

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 and Description

HttpClientContext()

HttpClientContext(HttpContext context)

Constructors
Constructor and Description
`HttpClientContext()`
`HttpClientContext(HttpContext context)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static HttpClientContext`	`adapt(HttpContext context)`
`static HttpClientContext`	`create()`
`AuthCache`	`getAuthCache()`
`AuthExchange`	`getAuthExchange(HttpHost host)`
`Map<HttpHost,AuthExchange>`	`getAuthExchanges()`
`Lookup<AuthSchemeFactory>`	`getAuthSchemeRegistry()`
`CookieOrigin`	`getCookieOrigin()`
`CookieSpec`	`getCookieSpec()`
`Lookup<CookieSpecFactory>`	`getCookieSpecRegistry()`
`CookieStore`	`getCookieStore()`
`CredentialsProvider`	`getCredentialsProvider()`
`RouteInfo`	`getHttpRoute()`
`RedirectLocations`	`getRedirectLocations()`
`RequestConfig`	`getRequestConfig()`
`Object`	`getUserToken()`
`<T> T`	`getUserToken(Class<T> clazz)`
`void`	`resetAuthExchange(HttpHost host, AuthScheme authScheme)`
`void`	`setAuthCache(AuthCache authCache)`
`void`	`setAuthExchange(HttpHost host, AuthExchange authExchange)`
`void`	`setAuthSchemeRegistry(Lookup<AuthSchemeFactory> lookup)`
`void`	`setCookieSpecRegistry(Lookup<CookieSpecFactory> lookup)`
`void`	`setCookieStore(CookieStore cookieStore)`
`void`	`setCredentialsProvider(CredentialsProvider credentialsProvider)`
`void`	`setRequestConfig(RequestConfig config)`
`void`	`setUserToken(Object obj)`

Methods inherited from class org.apache.hc.core5.http.protocol.HttpCoreContext
getAttribute, getAttribute, getEndpointDetails, getProtocolVersion, getRequest, getResponse, getSSLSession, removeAttribute, setAttribute, setProtocolVersion

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - AUTH_CACHE
```
public static final String AUTH_CACHE
```
    Attribute name of a AuthCache object that represents the auth scheme cache.
    
    See Also:
    
    Constant Field Values
  - AUTH_EXCHANGE_MAP
```
public static final String AUTH_EXCHANGE_MAP
```
    Attribute name of a map containing actual AuthExchanges keyed by their respective HttpHost.
    
    See Also:
    
    Constant Field Values
  - AUTHSCHEME_REGISTRY
```
public static final String AUTHSCHEME_REGISTRY
```
    Attribute name of a Lookup object that represents the actual AuthSchemeFactory registry.
    
    See Also:
    
    Constant Field Values
  - COOKIE_ORIGIN
```
public static final String COOKIE_ORIGIN
```
    Attribute name of a CookieOrigin object that represents the actual details of the origin server.
    
    See Also:
    
    Constant Field Values
  - COOKIE_SPEC
```
public static final String COOKIE_SPEC
```
    Attribute name of a CookieSpec object that represents the actual cookie specification.
    
    See Also:
    
    Constant Field Values
  - COOKIE_STORE
```
public static final String COOKIE_STORE
```
    Attribute name of a CookieStore object that represents the actual cookie store.
    
    See Also:
    
    Constant Field Values
  - COOKIESPEC_REGISTRY
```
public static final String COOKIESPEC_REGISTRY
```
    Attribute name of a Lookup object that represents the actual CookieSpecFactory registry.
    
    See Also:
    
    Constant Field Values
  - CREDS_PROVIDER
```
public static final String CREDS_PROVIDER
```
    Attribute name of a CredentialsProvider object that represents the actual credentials provider.
    
    See Also:
    
    Constant Field Values
  - HTTP_ROUTE
```
public static final String HTTP_ROUTE
```
    Attribute name of a RouteInfo object that represents the actual connection route.
    
    See Also:
    
    Constant Field Values
  - REDIRECT_LOCATIONS
```
public static final String REDIRECT_LOCATIONS
```
    Attribute name of a RedirectLocations object that represents a collection of all redirect locations received in the process of request execution.
    
    See Also:
    
    Constant Field Values
  - REQUEST_CONFIG
```
public static final String REQUEST_CONFIG
```
    Attribute name of a RequestConfig object that represents the actual request configuration.
    
    See Also:
    
    Constant Field Values
  - USER_TOKEN
```
public static final String USER_TOKEN
```
    Attribute name of a Object object that represents the actual user identity such as user Principal.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - HttpClientContext
```
public HttpClientContext()
```
  - HttpClientContext
```
public HttpClientContext(HttpContext context)
```
- Method Detail
  - adapt
```
public static HttpClientContext adapt(HttpContext context)
```
  - create
```
public static HttpClientContext create()
```
  - getAuthCache
```
public AuthCache getAuthCache()
```
  - getAuthExchange
```
public AuthExchange getAuthExchange(HttpHost host)
```
    Since:
    
    5.0
  - getAuthExchanges
```
public Map<HttpHost,AuthExchange> getAuthExchanges()
```
    Since:
    
    5.0
  - getAuthSchemeRegistry
```
public Lookup<AuthSchemeFactory> getAuthSchemeRegistry()
```
  - getCookieOrigin
```
public CookieOrigin getCookieOrigin()
```
  - getCookieSpec
```
public CookieSpec getCookieSpec()
```
  - getCookieSpecRegistry
```
public Lookup<CookieSpecFactory> getCookieSpecRegistry()
```
  - getCookieStore
```
public CookieStore getCookieStore()
```
  - getCredentialsProvider
```
public CredentialsProvider getCredentialsProvider()
```
  - getHttpRoute
```
public RouteInfo getHttpRoute()
```
  - getRedirectLocations
```
public RedirectLocations getRedirectLocations()
```
  - getRequestConfig
```
public RequestConfig getRequestConfig()
```
  - getUserToken
```
public Object getUserToken()
```
  - getUserToken
```
public <T> T getUserToken(Class<T> clazz)
```
  - resetAuthExchange
```
public void resetAuthExchange(HttpHost host,
                              AuthScheme authScheme)
```
    Since:
    
    5.0
  - setAuthCache
```
public void setAuthCache(AuthCache authCache)
```
  - setAuthExchange
```
public void setAuthExchange(HttpHost host,
                            AuthExchange authExchange)
```
    Since:
    
    5.0
  - setAuthSchemeRegistry
```
public void setAuthSchemeRegistry(Lookup<AuthSchemeFactory> lookup)
```
  - setCookieSpecRegistry
```
public void setCookieSpecRegistry(Lookup<CookieSpecFactory> lookup)
```
  - setCookieStore
```
public void setCookieStore(CookieStore cookieStore)
```
  - setCredentialsProvider
```
public void setCredentialsProvider(CredentialsProvider credentialsProvider)
```
  - setRequestConfig
```
public void setRequestConfig(RequestConfig config)
```
  - setUserToken
```
public void setUserToken(Object obj)
```

Class HttpClientContext

Field Summary

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

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

AUTH_CACHE

AUTH_EXCHANGE_MAP

AUTHSCHEME_REGISTRY

COOKIE_ORIGIN

COOKIE_SPEC

COOKIE_STORE

COOKIESPEC_REGISTRY

CREDS_PROVIDER

HTTP_ROUTE

REDIRECT_LOCATIONS

REQUEST_CONFIG

USER_TOKEN

Constructor Detail

HttpClientContext

HttpClientContext

Method Detail

adapt

create

getAuthCache

getAuthExchange

getAuthExchanges

getAuthSchemeRegistry

getCookieOrigin

getCookieSpec

getCookieSpecRegistry

getCookieStore

getCredentialsProvider

getHttpRoute

getRedirectLocations

getRequestConfig

getUserToken

getUserToken

resetAuthExchange

setAuthCache

setAuthExchange

setAuthSchemeRegistry

setCookieSpecRegistry

setCookieStore

setCredentialsProvider

setRequestConfig

setUserToken