Apache HttpClient 5.3 · org.apache.hc.client5.http.protocol.HttpClientContext

Field Summary

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

Inherited from org.apache.hc.core5.http.protocol.HttpCoreContext:: CONNECTION_ENDPOINT HTTP_REQUEST HTTP_RESPONSE SSL_SESSION

Constructor Summary

Access	Constructor and Description
public	HttpClientContext(final HttpContext context)
public	HttpClientContext()

Method Summary

Modifier and Type	Method and Description
public static HttpClientContext	adapt(final HttpContext context) Hides org.apache.hc.core5.http.protocol.HttpCoreContext.adapt.
public static HttpClientContext	create() Hides org.apache.hc.core5.http.protocol.HttpCoreContext.create.
public AuthCache	getAuthCache()
public AuthExchange	getAuthExchange(final HttpHost host)
public Map<HttpHost, AuthExchange>	getAuthExchanges()
public Lookup<AuthSchemeFactory>	getAuthSchemeRegistry()
public CookieOrigin	getCookieOrigin()
public CookieSpec	getCookieSpec()
public Lookup<CookieSpecFactory>	getCookieSpecRegistry()
public CookieStore	getCookieStore()
public CredentialsProvider	getCredentialsProvider()
public String	getExchangeId()
public RouteInfo	getHttpRoute()
private <T> Lookup<T>	getLookup(final String name)
public RedirectLocations	getRedirectLocations()
public RequestConfig	getRequestConfig()
public <T> T	getUserToken(final Class<T> clazz)
public Object	getUserToken()
public void	resetAuthExchange(final HttpHost host, final AuthScheme authScheme)
public void	setAuthCache(final AuthCache authCache)
public void	setAuthExchange(final HttpHost host, final AuthExchange authExchange)
public void	setAuthSchemeRegistry(final Lookup<AuthSchemeFactory> lookup)
public void	setCookieSpecRegistry(final Lookup<CookieSpecFactory> lookup)
public void	setCookieStore(final CookieStore cookieStore)
public void	setCredentialsProvider(final CredentialsProvider credentialsProvider)
public void	setExchangeId(final String id)
public void	setRequestConfig(final RequestConfig config)
public void	setUserToken(final Object obj)

Inherited from org.apache.hc.core5.http.protocol.HttpCoreContext:: getAttribute getAttribute getEndpointDetails getProtocolVersion getRequest getResponse getSSLSession removeAttribute setAttribute setProtocolVersion toString

Field Detail

AUTH_CACHE	back to summary
public static final String AUTH_CACHE Attribute name of a `AuthCache` object that represents the auth scheme cache.

AUTH_EXCHANGE_MAP	back to summary
public static final String AUTH_EXCHANGE_MAP Attribute name of a map containing actual `AuthExchange`s keyed by their respective `org.apache.hc.core5.http.HttpHost`.

AUTHSCHEME_REGISTRY	back to summary
public static final String AUTHSCHEME_REGISTRY Attribute name of a `org.apache.hc.core5.http.config.Lookup` object that represents the actual `AuthSchemeFactory` registry.

COOKIE_ORIGIN	back to summary
public static final String COOKIE_ORIGIN Attribute name of a `org.apache.hc.client5.http.cookie.CookieOrigin` object that represents the actual details of the origin server.

COOKIE_SPEC	back to summary
public static final String COOKIE_SPEC Attribute name of a `org.apache.hc.client5.http.cookie.CookieSpec` object that represents the actual cookie specification.

COOKIE_STORE	back to summary
public static final String COOKIE_STORE Attribute name of a `CookieStore` object that represents the actual cookie store.

COOKIESPEC_REGISTRY	back to summary
public static final String COOKIESPEC_REGISTRY Attribute name of a `org.apache.hc.core5.http.config.Lookup` object that represents the actual `CookieSpecFactory` registry.

CREDS_PROVIDER	back to summary
public static final String CREDS_PROVIDER Attribute name of a `CredentialsProvider` object that represents the actual credentials provider.

EXCHANGE_ID	back to summary
public static final String EXCHANGE_ID Attribute name of a `java.lang.String` object that represents the ID of the current message exchange.

HTTP_ROUTE	back to summary
public static final String HTTP_ROUTE Attribute name of a `RouteInfo` object that represents the actual connection route.

REDIRECT_LOCATIONS	back to summary
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.

REQUEST_CONFIG	back to summary
public static final String REQUEST_CONFIG Attribute name of a `org.apache.hc.client5.http.config.RequestConfig` object that represents the actual request configuration.

USER_TOKEN	back to summary
public static final String USER_TOKEN Attribute name of a `java.lang.Object` object that represents the actual user identity such as user `java.security.Principal`.

Constructor Detail

HttpClientContext	back to summary
public HttpClientContext(final HttpContext context)

HttpClientContext	back to summary
public HttpClientContext()

Method Detail

adapt	back to summary
public static HttpClientContext adapt(final HttpContext context) Hides org.apache.hc.core5.http.protocol.HttpCoreContext.adapt.

create	back to summary
public static HttpClientContext create() Hides org.apache.hc.core5.http.protocol.HttpCoreContext.create.

getAuthCache	back to summary
public AuthCache getAuthCache()

getAuthExchange	back to summary
public AuthExchange getAuthExchange(final HttpHost host) Since 5.0

getAuthExchanges	back to summary
public Map<HttpHost, AuthExchange> getAuthExchanges() Annotations @SuppressWarnings:unchecked Since 5.0

getAuthSchemeRegistry	back to summary
public Lookup<AuthSchemeFactory> getAuthSchemeRegistry()

getCookieOrigin	back to summary
public CookieOrigin getCookieOrigin()

getCookieSpec	back to summary
public CookieSpec getCookieSpec()

getCookieSpecRegistry	back to summary
public Lookup<CookieSpecFactory> getCookieSpecRegistry()

getCookieStore	back to summary
public CookieStore getCookieStore()

getCredentialsProvider	back to summary
public CredentialsProvider getCredentialsProvider()

getExchangeId	back to summary
public String getExchangeId() Since 5.1

getHttpRoute	back to summary
public RouteInfo getHttpRoute()

getLookup	back to summary
private <T> Lookup<T> getLookup(final String name) Annotations @SuppressWarnings:unchecked

getRedirectLocations	back to summary
public RedirectLocations getRedirectLocations()

getRequestConfig	back to summary
public RequestConfig getRequestConfig()

getUserToken	back to summary
public <T> T getUserToken(final Class<T> clazz)

getUserToken	back to summary
public Object getUserToken()

resetAuthExchange	back to summary
public void resetAuthExchange(final HttpHost host, final AuthScheme authScheme) Since 5.0

setAuthCache	back to summary
public void setAuthCache(final AuthCache authCache)

setAuthExchange	back to summary
public void setAuthExchange(final HttpHost host, final AuthExchange authExchange) Since 5.0

setAuthSchemeRegistry	back to summary
public void setAuthSchemeRegistry(final Lookup<AuthSchemeFactory> lookup)

setCookieSpecRegistry	back to summary
public void setCookieSpecRegistry(final Lookup<CookieSpecFactory> lookup)

setCredentialsProvider	back to summary
public void setCredentialsProvider(final CredentialsProvider credentialsProvider)

setExchangeId	back to summary
public void setExchangeId(final String id) Since 5.1

setRequestConfig	back to summary
public void setRequestConfig(final RequestConfig config)

setUserToken	back to summary
public void setUserToken(final Object obj)

public Class HttpClientContext

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail