Class HttpClientContext

  • All Implemented Interfaces:
    org.apache.hc.core5.http.protocol.HttpContext
    Direct Known Subclasses:
    HttpCacheContext

    public class HttpClientContext
    extends org.apache.hc.core5.http.protocol.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 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 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
      • 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 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 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​(org.apache.hc.core5.http.protocol.HttpContext context)
      • HttpClientContext

        public HttpClientContext()
    • Method Detail

      • adapt

        public static HttpClientContext adapt​(org.apache.hc.core5.http.protocol.HttpContext context)
      • getHttpRoute

        public RouteInfo getHttpRoute()
      • setCookieStore

        public void setCookieStore​(CookieStore cookieStore)
      • getCookieSpec

        public CookieSpec getCookieSpec()
      • getLookup

        private <T> org.apache.hc.core5.http.config.Lookup<T> getLookup​(java.lang.String name)
      • getCookieSpecRegistry

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

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

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

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

        public void setCredentialsProvider​(CredentialsProvider credentialsProvider)
      • getAuthCache

        public AuthCache getAuthCache()
      • setAuthCache

        public void setAuthCache​(AuthCache authCache)
      • getAuthExchanges

        public java.util.Map<org.apache.hc.core5.http.HttpHost,​AuthExchange> getAuthExchanges()
        Since:
        5.0
      • getAuthExchange

        public AuthExchange getAuthExchange​(org.apache.hc.core5.http.HttpHost host)
        Since:
        5.0
      • setAuthExchange

        public void setAuthExchange​(org.apache.hc.core5.http.HttpHost host,
                                    AuthExchange authExchange)
        Since:
        5.0
      • resetAuthExchange

        public void resetAuthExchange​(org.apache.hc.core5.http.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)
      • 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