HttpClientContext

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

```
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 java.lang.String`	`AUTH_CACHE` Attribute name of a `AuthCache` object that represents the auth scheme cache.
`static java.lang.String`	`AUTH_EXCHANGE_MAP` Attribute name of a map containing actual `AuthExchange`s keyed by their respective `org.apache.hc.core5.http.HttpHost`.
`static java.lang.String`	`AUTHSCHEME_REGISTRY` Attribute name of a `org.apache.hc.core5.http.config.Lookup` object that represents the actual `AuthSchemeFactory` registry.
`static java.lang.String`	`COOKIE_ORIGIN` Attribute name of a `CookieOrigin` object that represents the actual details of the origin server.
`static java.lang.String`	`COOKIE_SPEC` Attribute name of a `CookieSpec` object that represents the actual cookie specification.
`static java.lang.String`	`COOKIE_STORE` Attribute name of a `CookieStore` object that represents the actual cookie store.
`static java.lang.String`	`COOKIESPEC_REGISTRY` Attribute name of a `org.apache.hc.core5.http.config.Lookup` object that represents the actual `CookieSpecFactory` registry.
`static java.lang.String`	`CREDS_PROVIDER` Attribute name of a `CredentialsProvider` object that represents the actual credentials provider.
`static java.lang.String`	`EXCHANGE_ID` Attribute name of a `String` object that represents the ID of the current message exchange.
`static java.lang.String`	`HTTP_ROUTE` Attribute name of a `RouteInfo` object that represents the actual connection route.
`static java.lang.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 java.lang.String`	`REQUEST_CONFIG` Attribute name of a `RequestConfig` object that represents the actual request configuration.
`static java.lang.String`	`USER_TOKEN` Attribute name of a `Object` object that represents the actual user identity such as user `Principal`.

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)`
`java.util.Map<HttpHost,AuthExchange>`	`getAuthExchanges()`
`<any>`	`getAuthSchemeRegistry()`
`CookieOrigin`	`getCookieOrigin()`
`CookieSpec`	`getCookieSpec()`
`<any>`	`getCookieSpecRegistry()`
`CookieStore`	`getCookieStore()`
`CredentialsProvider`	`getCredentialsProvider()`
`java.lang.String`	`getExchangeId()`
`RouteInfo`	`getHttpRoute()`
`RedirectLocations`	`getRedirectLocations()`
`RequestConfig`	`getRequestConfig()`
`java.lang.Object`	`getUserToken()`
`<T> T`	`getUserToken(java.lang.Class<T> clazz)`
`void`	`resetAuthExchange(HttpHost host, AuthScheme authScheme)`
`void`	`setAuthCache(AuthCache authCache)`
`void`	`setAuthExchange(HttpHost host, AuthExchange authExchange)`
`void`	`setAuthSchemeRegistry(<any> lookup)`
`void`	`setCookieSpecRegistry(<any> lookup)`
`void`	`setCookieStore(CookieStore cookieStore)`
`void`	`setCredentialsProvider(CredentialsProvider credentialsProvider)`
`void`	`setExchangeId(java.lang.String id)`
`void`	`setRequestConfig(RequestConfig config)`
`void`	`setUserToken(java.lang.Object obj)`

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

- Field Detail
  - HTTP_ROUTE
```
public static final java.lang.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 java.lang.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
  - COOKIESPEC_REGISTRY
```
public static final java.lang.String COOKIESPEC_REGISTRY
```
    Attribute name of a org.apache.hc.core5.http.config.Lookup object that represents the actual CookieSpecFactory registry.
    
    See Also:
    
    Constant Field Values
  - COOKIE_SPEC
```
public static final java.lang.String COOKIE_SPEC
```
    Attribute name of a CookieSpec object that represents the actual cookie specification.
    
    See Also:
    
    Constant Field Values
  - COOKIE_ORIGIN
```
public static final java.lang.String COOKIE_ORIGIN
```
    Attribute name of a CookieOrigin object that represents the actual details of the origin server.
    
    See Also:
    
    Constant Field Values
  - COOKIE_STORE
```
public static final java.lang.String COOKIE_STORE
```
    Attribute name of a CookieStore object that represents the actual cookie store.
    
    See Also:
    
    Constant Field Values
  - CREDS_PROVIDER
```
public static final java.lang.String CREDS_PROVIDER
```
    Attribute name of a CredentialsProvider object that represents the actual credentials provider.
    
    See Also:
    
    Constant Field Values
  - AUTH_CACHE
```
public static final java.lang.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 java.lang.String AUTH_EXCHANGE_MAP
```
    Attribute name of a map containing actual AuthExchanges keyed by their respective org.apache.hc.core5.http.HttpHost.
    
    See Also:
    
    Constant Field Values
  - USER_TOKEN
```
public static final java.lang.String USER_TOKEN
```
    Attribute name of a Object object that represents the actual user identity such as user Principal.
    
    See Also:
    
    Constant Field Values
  - AUTHSCHEME_REGISTRY
```
public static final java.lang.String AUTHSCHEME_REGISTRY
```
    Attribute name of a org.apache.hc.core5.http.config.Lookup object that represents the actual AuthSchemeFactory registry.
    
    See Also:
    
    Constant Field Values
  - REQUEST_CONFIG
```
public static final java.lang.String REQUEST_CONFIG
```
    Attribute name of a RequestConfig object that represents the actual request configuration.
    
    See Also:
    
    Constant Field Values
  - EXCHANGE_ID
```
public static final java.lang.String EXCHANGE_ID
```
    Attribute name of a String object that represents the ID of the current message exchange.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - HttpClientContext
```
public HttpClientContext(HttpContext context)
```
  - HttpClientContext
```
public HttpClientContext()
```
- Method Detail
  - adapt
```
public static HttpClientContext adapt(HttpContext context)
```
  - create
```
public static HttpClientContext create()
```
  - getHttpRoute
```
public RouteInfo getHttpRoute()
```
  - getRedirectLocations
```
public RedirectLocations getRedirectLocations()
```
  - getCookieStore
```
public CookieStore getCookieStore()
```
  - setCookieStore
```
public void setCookieStore(CookieStore cookieStore)
```
  - getCookieSpec
```
public CookieSpec getCookieSpec()
```
  - getCookieOrigin
```
public CookieOrigin getCookieOrigin()
```
  - getCookieSpecRegistry
```
public <any> getCookieSpecRegistry()
```
  - setCookieSpecRegistry
```
public void setCookieSpecRegistry(<any> lookup)
```
  - getAuthSchemeRegistry
```
public <any> getAuthSchemeRegistry()
```
  - setAuthSchemeRegistry
```
public void setAuthSchemeRegistry(<any> lookup)
```
  - getCredentialsProvider
```
public CredentialsProvider getCredentialsProvider()
```
  - setCredentialsProvider
```
public void setCredentialsProvider(CredentialsProvider credentialsProvider)
```
  - getAuthCache
```
public AuthCache getAuthCache()
```
  - setAuthCache
```
public void setAuthCache(AuthCache authCache)
```
  - getAuthExchanges
```
public java.util.Map<HttpHost,AuthExchange> getAuthExchanges()
```
    Since:
    
    5.0
  - getAuthExchange
```
public AuthExchange getAuthExchange(HttpHost host)
```
    Since:
    
    5.0
  - setAuthExchange
```
public void setAuthExchange(HttpHost host,
                            AuthExchange authExchange)
```
    Since:
    
    5.0
  - resetAuthExchange
```
public void resetAuthExchange(HttpHost host,
                              AuthScheme authScheme)
```
    Since:
    
    5.0
  - getUserToken
```
public <T> T getUserToken(java.lang.Class<T> clazz)
```
  - getUserToken
```
public java.lang.Object getUserToken()
```
  - setUserToken
```
public void setUserToken(java.lang.Object obj)
```
  - getRequestConfig
```
public RequestConfig getRequestConfig()
```
  - setRequestConfig
```
public void setRequestConfig(RequestConfig config)
```
  - getExchangeId
```
public java.lang.String getExchangeId()
```
    Since:
    
    5.1
  - setExchangeId
```
public void setExchangeId(java.lang.String id)
```
    Since:
    
    5.1

Class HttpClientContext

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

HTTP_ROUTE

REDIRECT_LOCATIONS

COOKIESPEC_REGISTRY

COOKIE_SPEC

COOKIE_ORIGIN

COOKIE_STORE

CREDS_PROVIDER

AUTH_CACHE

AUTH_EXCHANGE_MAP

USER_TOKEN

AUTHSCHEME_REGISTRY

REQUEST_CONFIG

EXCHANGE_ID

Constructor Detail

HttpClientContext

HttpClientContext

Method Detail

adapt

create

getHttpRoute

getRedirectLocations

getCookieStore

setCookieStore

getCookieSpec

getCookieOrigin

getCookieSpecRegistry

setCookieSpecRegistry

getAuthSchemeRegistry

setAuthSchemeRegistry

getCredentialsProvider

setCredentialsProvider

getAuthCache

setAuthCache

getAuthExchanges

getAuthExchange

setAuthExchange

resetAuthExchange

getUserToken

getUserToken

setUserToken

getRequestConfig

setRequestConfig

getExchangeId

setExchangeId