All Classes and Interfaces
Class
Description
AbstractBackoff is an abstract class that provides a common implementation for managing
backoff behavior in HttpClient connection pool.
Abstract cache backend for serialized binary objects capable of CAS (compare-and-swap) updates.
Abstract cache backend for serialized binary objects capable of CAS (compare-and-swap) updates.
Abstract push response consumer that processes response body data as an octet stream.
Abstract response consumer that processes response body data as an octet stream.
Abstract push response consumer that processes response body data as a character stream.
Abstract response consumer that processes response body data as a character stream.
Abstract cookie specification which can delegate the job of parsing,
validation or matching cookie attributes to a number of arbitrary
CookieAttributeHandlers.A generic
HttpClientResponseHandler that works with the response entity
for successful (2xx) responses.HttpMultipart represents a collection of MIME multipart encoded content bodies.
Abstract cache backend for serialized objects capable of CAS (compare-and-swap) updates.
Abstract cache backend for serialized objects capable of CAS (compare-and-swap) updates.
The
AIMDBackoffManager applies an additive increase,
multiplicative decrease (AIMD) to managing a dynamic limit to
the number of connections allowed to a given host.Asynchronous executor for
Requests.Request executor in the request execution chain that is responsible for
transparent client-side caching.
Represents a manager of persistent non-blocking client connections.
Connection operator that performs connection connect and upgrade operations.
Request execution handler in the asynchronous request execution chain
that is responsible for establishing connection to the target
origin server as specified by the current connection route.
Client connection endpoint that can be used to execute message exchanges.
A handler that echos the incoming request entity.
AsyncExecCallback methods represent response processing events
in the client side request execution chain.
Represents a single element in the client side asynchronous request execution chain.
Request execution scheduler
Request execution scope that includes the unique message exchange ID,
the connection route, the original request message, the execution
context and the internal execution runtime.
Abstract request execution handler in an asynchronous client side request execution
chain.
Execution runtime that provides access to the underlying connection endpoint and helps
manager its life cycle.
Request executor in the asynchronous request execution chain that is
responsible for making a decision whether a request that failed due to
an I/O exception or received a specific response from the target server should
be re-executed.
Request execution handler in the asynchronous request execution chain
that is responsible for implementation of HTTP specification requirements.
A handler that generates random data.
An entity that generates random data.
Request execution handler in the asynchronous request execution chain
responsible for handling of request redirects.
This interface represents an cache of
AuthScheme state information
that can be re-used for preemptive authentication by subsequent requests.Utility class that implements commons aspects of the client side authentication cache keeping.
This class represents an authentication challenge consisting of a auth scheme
and either a single parameter or a list of name / value pairs.
Authentication challenge parser.
Signals a failure in authentication process
Strategy to select auth schemes in order of preference based on auth challenges
presented by the opposite endpoint (target server or a proxy).
This class represents the actual state of authentication handshake including the current
AuthScheme
used for request authorization as well as a collection of backup authentication options if available.This interface represents an abstract challenge-response oriented authentication scheme.
Factory for
AuthScheme implementations.AuthScope represents an authentication scope consisting of
an application protocol, a host name, a port number, a realm name
and an authentication scheme name.Indicates that the state of an
AuthScheme can be cached
and re-used for preemptive authentication by subsequent requests.Represents a controller that dynamically adjusts the size
of an available connection pool based on feedback from
using the connections.
Request execution handler in the classic request execution chain
that is responsible for execution of an
ConnectionBackoffStrategy.Provide implementations of the Base64 conversion methods from Commons Codec, delegating to the Java Base64
implementation.
Default implementation of
AuthCache.Deprecated.
Default implementation of
SetCookie.Default implementation of
CookieStoreDefault implementation of
CredentialsStore.Cookie
domain attribute handler.Cookie
expires attribute handler.Basic
HttpCacheStorage implementation backed by an instance of
LinkedHashMap.A connection manager for a single connection.
A
HttpClientResponseHandler that returns
the response body as a String for successful (2xx) responses.Cookie
HttpOnly attribute handler.Deprecated.
Use
BasicRequestBuilder.Should produce reasonably unique tokens.
Cookie
max-age attribute handler.Cookie
path attribute handler.Basic
HttpRouteDirector implementation.Basic authentication scheme.
AuthSchemeFactory implementation that creates and initializes
BasicScheme instances.Cookie
secure attribute handler.Basic username based principal representation.
Bearer authentication scheme.
AuthSchemeFactory implementation that creates and initializes
BearerScheme instances.Opaque token
Credentials usually representing a set of claims, often encrypted
or signed.HttpEntityWrapper responsible for
handling br Content Coded responses.InputStreamFactory for handling Brotli Content Coded responses.Binary body part backed by a byte array.
Builder class for sequences of bytes.
HttpCacheEntrySerializer implementation that uses the default (native)
serialization.Determines if an HttpRequest is allowed to be served from the cache.
Java Beans-style configuration for caching
HttpClient.Rebuilds an
HttpResponse from a HttpCacheEntryDetermines whether a given
HttpCacheEntry is suitable to be
used as a response for a given HttpRequest.This enumeration represents the various ways a response can be generated
by the caching
HttpClient;
if a request is executed with an HttpCacheContext
then a parameter with one of these values will be registered in the
context under the key HttpCacheContext.CACHE_RESPONSE_STATUS.Abstract cache re-validation class.
Creates new
HttpCacheEntrys and updates existing ones with new or updated information
based on the response from the origin server.
Request executor in the request execution chain that is responsible for
transparent client-side caching.
Builder for HTTP/2
CloseableHttpAsyncClient
instances capable of client-side caching.Builder for
CloseableHttpAsyncClient
instances capable of client-side caching.Factory methods for
CloseableHttpAsyncClient instances
capable of client-side caching.Builder for
CloseableHttpClient
instances capable of client-side caching.Factory methods for
CloseableHttpClient instances
capable of client-side caching.Supported elements of request execution pipeline.
Challenge type (TARGET or PROXY)
Signals a circular redirect
Deprecated.
Use
ClassicRequestBuilderDeprecated.
Use
ClassicRequestBuilderSignals an error in the HTTP protocol.
Builder for client
TlsStrategy instances.Base implementation of
HttpAsyncClient that also implements ModalCloseable.Base implementation of
HttpClient that also implements ModalCloseable.Provided for backward compatibility with HttpClient 4.x.
Extension of
CookieAttributeHandler intended
to handle one specific common attribute whose name is returned with
CommonCookieAttributeHandler.getAttributeName() method.Concurrent map of integer counts.
Configuration interface for HTTP requests.
HTTP request message with a custom configuration.
Connect exception support methods.
Request execution handler in the classic request execution chain
that is responsible for establishing connection to the target
origin server as specified by the current connection route.
When managing a dynamic number of connections for a given route, this
strategy assesses whether a given request execution outcome should
result in a backoff signal or not, based on either examining the
Throwable that resulted or by examining the resulting
response (e.g.Immutable class encapsulating connection initialization and management settings.
Client endpoint leased from a connection manager.
Interface for deciding how long a connection can remain
idle before being reused.
Signals that the connection has been shut down or released back to the
the connection pool
A factory for creating and connecting connection sockets.
A timeout while connecting to an HTTP server or waiting for an available connection from a connection manager.
Connection pooling support methods.
This class represents arbitrary content of a specific type that can be consumed
multiple times and requires no explicit deallocation used by the fluent facade.
Request execution handler in the classic request execution chain
that is responsible for automatic response content decompression.
Represents common content properties.
HttpClientContext builder.Cookie interface represents a token or short packet of state information
(also referred to as "magic-cookie") that the HTTP agent and the target
server can exchange to maintain a session.
This interface represents a cookie attribute handler responsible
for parsing, validating, and matching a specific cookie attribute,
such as path, domain, port, etc.
This cookie comparator can be used to compare identity of cookies.
CookieOrigin class encapsulates details of an origin server that
are relevant when parsing, validating or matching HTTP cookies.
This cookie comparator ensures that multiple cookies satisfying
a common criteria are ordered in the
Cookie header such
that those with more specific Path attributes precede those with
less specific.This cookie comparator ensures that cookies with longer paths take precedence over
cookies with shorter path.
Signals that a cookie violates a restriction imposed by the cookie
specification.
Defines the cookie management specification.
Cookie management functions shared by all specification.
Factory for
CookieSpec implementations.Cookie support methods.
This interface represents an abstract store for
Cookie
objects.This interface represents a set of credentials consisting of a security
principal and a secret (password) that can be used to establish user
identity
Provider of authentication credentials.
CredentialsProvider builder.Abstract store of authentication credentials.
HTTP cache date support utilities.
A utility class for parsing and formatting HTTP dates as used in cookies and
other headers.
Common base class for decompressing
HttpEntity implementations.Given a particular HTTP request / response pair, flush any cache entries
that this exchange would invalidate.
Class used for asynchronous revalidations to be used when the
stale-while-revalidate
directive is presentDefault implementation of
AuthenticationStrategyThis
ConnectionBackoffStrategy backs off either for a raw
network socket or connection timeout or if the server explicitly
sends a 429 (Too Many Requests) or a 503 (Service Unavailable) response.Given a particular HTTP request / response pair, flush any cache entries
that this exchange would invalidate.
Class used for asynchronous revalidations to be used when
the
stale-while-revalidate directive is presentExtension of core
DefaultConnectionReuseStrategy that treats
CONNECT method exchanges involved in proxy tunnelling as a special case.TLS upgrade strategy for non-blocking client connections.
Default implementation of a strategy deciding duration
that a connection can remain idle.
Default
HostnameVerifier implementation.Default implementation of
HttpClientConnectionOperator used as default in Http client,
when no instance provided by user to BasicHttpClientConnectionManager or PoolingHttpClientConnectionManager constructor.Default implementation of the
HttpRequestRetryStrategy interface.Default factory for response message parsers.
Implementation of an
HttpRoutePlanner
that routes requests through a default proxy.Default implementation of
RedirectStrategy.Default implementation of an
HttpRoutePlanner.Default
SchemePortResolver.Default implementation of
UserTokenHandler.HttpEntityWrapper responsible for
handling deflate Content Coded responses.Deflate input stream.
InputStreamFactory for handling Deflate Content Coded responses.Digest authentication scheme.
Represent the possible values of quality of protection.
AuthSchemeFactory implementation that creates and initializes
DigestScheme instances.A DistributedProxySelector is a custom
ProxySelector implementation that
delegates proxy selection to a list of underlying ProxySelectors in a
distributed manner.Users may implement this interface to override the normal DNS lookup offered
by the OS.
A collection of utilities relating to Domain Name System.
Domain types differentiated by Mozilla Public Suffix List.
A handler that echos the incoming request entity.
Builder for
HttpEntity instances.Represents a single element in the client side classic request execution chain.
Abstract request execution handler in a classic client side request execution chain.
Execution runtime that provides access to the underlying connection endpoint and helps
manager its life cycle.
Request execution support methods.
Executor for
Requests.A backoff manager implementation that uses an exponential backoff algorithm to adjust the maximum
number of connections per HTTP route.
An implementation that backs off exponentially based on the number of
consecutive failed attempts.
Binary body part backed by a file.
Cache resource backed by a file.
Generates
Resource instances whose body is stored in a temporary file.HTTP form used by the fluent facade.
FormBodyPart class represents a content body that can be used as a part of multipart encoded
entities.
Builder for individual
FormBodyParts.Collection of different counters used to gather metrics for
FutureRequestExecutionService.A counter that can measure duration and number of events.
This class schedules message execution execution and processing
as
FutureTasks with the provided ExecutorService.Deprecated.
Do not use.
Wrapping entity that compresses content when
writing.HttpEntityWrapper for handling
gzip Content Coded responses.InputStreamFactory for handling GZIPContent Coded responses.Builder for HTTP/2 only
CloseableHttpAsyncClient instances.Usually the last HTTP/2 request execution handler in the asynchronous
request execution chain that is responsible for execution of
request / response exchanges with the opposite endpoint.
The header of a MIME entity.
Records static constants for various HTTP header names.
Cache resource backed by a byte array on the heap.
Generates
Resource instances stored entirely in heap.Given a particular HTTP request / response pair, flush any cache entries
that this exchange would invalidate.
HttpAsyncCacheStorage represents an abstract HTTP cache
storage backend that can then be plugged into the asynchronous
(non-blocking ) request execution
pipeline.
HttpAsyncCacheStorage implementation that emulates asynchronous
behavior using an instance of classic HttpCacheStorage.This interface represents only the most basic contract for HTTP request
execution.
Builder for
CloseableHttpAsyncClient instances that can negotiate
the most optimal HTTP protocol version during the TLS handshake
with ALPN extension if supported by the Java runtime.Factory methods for
CloseableHttpAsyncClient instances.Usually the last HTTP/1.1 request execution handler in the asynchronous
request execution chain that is responsible for execution of
request/response exchanges with the opposite endpoint.
Utility class that implements commons aspects of the client side HTTP authentication.
Cache serializer and deserializer that uses an HTTP-like format.
Cache validity policy that always returns an age of
TimeValue.ZERO_MILLISECONDS.Writer for SimpleHttpResponse.
Atomic Compare-And-Swap (CAS) cache operation.
Adaptor class that provides convenience type safe setters and getters
for caching
HttpContext attributes.Structure used to store an
HttpResponse in a cache.Serializer / deserializer for
HttpCacheStorageEntry entries.Given a particular HTTP request / response pair, flush any cache entries
that this exchange would invalidate.
HttpCacheStorage represents an abstract HTTP cache
storage backend that can then be plugged into the classic
(blocking) request execution pipeline.
This class contains a
HttpCacheEntry along with its key.HTTP cache support utilities.
Signals that
HttpCacheStorage encountered an error performing
an update operation.This interface represents only the most basic contract for HTTP request
execution.
Builder for
CloseableHttpClient instances.Represents a manager of persistent client connections.
Connection operator that performs connection connect and upgrade operations.
Adaptor class that provides convenience type safe setters and getters
for common
HttpContext attributes used in the course
of HTTP request execution.Extended
HostnameVerifier interface.Factory methods for
CloseableHttpClient instances.HTTP DELETE method.
HTTP GET method.
HTTP HEAD method.
A
ConnectException that specifies the NamedEndpoint that was being connected to.MIME compliance mode.
HTTP OPTIONS method.
HTTP PATCH method.
HTTP POST method.
HTTP PUT method.
Request executor in the request execution chain that is responsible for
making a decision whether a request that failed due to an I/O exception
or received a specific response from the target server should
be re-executed.
Strategy interface that allows API users to plug in their own logic to
control whether or not a retry should automatically be done, how many times
it should be done and so on.
Signals a non 2xx HTTP response.
Connection route definition for HTTP requests.
Provides directions on establishing a route.
Encapsulates logic to compute a
HttpRoute to a target host.HTTPS configuration support methods.
HTTP TRACE method.
Extended version of the
ClassicHttpRequest interface that provides
convenience methods to access request properties such as request URI
and method type.This class maintains a background thread to enforce an eviction policy for expired / idle
persistent connections kept alive in the connection pool.
Deprecated.
CookieSpecFactory implementation that ignores all cookies.CookieSpec that ignores all cookies
Immediately schedules any operation.
In-memory
DnsResolver implementation.Binary body part backed by an input stream.
Factory for decorated
InputStreams.Internal implementation of HTTP/2 only
CloseableHttpAsyncClient.Internal implementation of
CloseableHttpAsyncClient that can negotiate
the most optimal HTTP protocol version during during the TLS handshake
with ALPN extension if supported by the Java runtime.Internal implementation of
CloseableHttpClient.Authentication credentials required to respond to a authentication
challenge are invalid
Deprecated.
Do not use.
Deprecated.
Do not use.
Deprecated.
Do not use.
Deprecated.
Do not use.
Cookie
expires attribute handler conformant to the more relaxed interpretation
of HTTP state management.Cookie
max-age attribute handler conformant to the more relaxed interpretation
of HTTP state management.Extended
ConnectionSocketFactory interface for layered sockets such as SSL/TLS.Lazy init InputStream wrapper.
Represents a request for a
ConnectionEndpoint whose life cycle
is managed by a connection manager.HttpBrowserCompatibleMultipart represents a collection of MIME multipart encoded
content bodies.
Lenient HTTP response parser implementation that can skip malformed data until
a valid HTTP response message head is encountered.
An implementation of
BackoffManager that uses a linear backoff strategy to adjust the maximum number
of connections per route in an PoolingHttpClientConnectionManager.Usually the last request execution handler in the classic request execution
chain that is responsible for execution of request / response exchanges with
the opposite endpoint.
Signals that authentication challenge is in some way invalid or
illegal in the given context
Signals that a cookie is in some way invalid or illegal in a given
context
Represents a managed asynchronous connection whose state and life cycle
is managed by a connection manager.
HttpCacheStorage implementation capable of deallocating resources associated with
the cache entries.Represents a managed connection whose state and life cycle is managed by
a connection manager.
Factory for
ManagedHttpClientConnection instances.Builder for
ManagedHttpClientConnectionFactory.Deprecated.
Use message builders.
Minimal MIME field.
Minimal implementation of HTTP/2 only
CloseableHttpAsyncClient.Minimal implementation of
CloseableHttpAsyncClient.Minimal implementation of
CloseableHttpClient.Multi-home DNS aware implementation of
ConnectionInitiator.Builder for multipart
HttpEntitys.MultipartPart class represents a content body that can be used as a part of multipart encoded
entities.
Builder for individual
MultipartParts.HttpCacheEntrySerializer that uses HttpCacheStorageEntry
as its cache content representation.The NO_OP HostnameVerifier essentially turns hostname verification
off.
Noop implementation of
UserTokenHandler that always returns null.Deprecated.
Do not use.
Deprecated.
Do not use.
Deprecated.
Do not use.
Deprecated.
Do not use.
Cryptography support - HMACMD5 - algorithmically based on various web
resources by Karl Wright
Cryptography support - MD4.
NTLM message generation, base class
Type 1 message assembly class
Type 2 message class
Type 3 message assembly class
Deprecated.
Do not use.
Deprecated.
Do not use.
Microsoft Windows specific user principal implementation.
This is a
ConnectionBackoffStrategy that never backs off,
for compatibility with existing behavior.Common cancellable operations.
This class represents a
Future in the completed state with a fixed result.The default class for creating plain (unencrypted) sockets.
PoolingAsyncClientConnectionManager maintains a pool of non-blocking
HttpConnections and is able to service
connection requests from multiple execution threads.Builder for
PoolingAsyncClientConnectionManager instances.ClientConnectionPoolManager maintains a pool of
ManagedHttpClientConnections and is able to service connection requests
from multiple execution threads.Builder for
PoolingHttpClientConnectionManager instances.A thread safe incrementing identifier.
Request execution handler in the classic request execution chain
that is responsible for implementation of HTTP specification requirements.
ProxyClient can be used to establish a tunnel via an HTTP/1.1 proxy.
Wraps a
CookieAttributeHandler and leverages
its match method to never match a suffix from a black list.Public suffix is a set of DNS names or wildcards concatenated with dots.
Parses the list from publicsuffix.org
and configures a PublicSuffixFilter.
Utility class that can test if DNS names match the content of the Public Suffix List.
PublicSuffixMatcher loader.A handler that generates random data.
An entity that generates random data.
Signals violation of HTTP specification caused by an invalid redirect
Request execution handler in the classic request execution chain
responsible for handling of request redirects.
This class represents a collection of
URIs used
as redirect locations.A strategy for determining if an HTTP request should be redirected to
a new location in response to an HTTP response received from the target
server.
HTTP request used by the fluent facade.
Signals that the request has been aborted.
Request interceptor that matches cookies available in the current
CookieStore to the request being executed and generates
corresponding Cookie request headers.Deprecated.
Do not use.
This protocol interceptor is responsible for adding the
Connection
header to the outgoing requests, which is essential for managing persistence
of HTTP/1.0 connections.Immutable class encapsulating request configuration items.
Deprecated.
Use
BasicRequestBuilderRequest interceptor that adds default request headers.
RequestExpectContinue is responsible for enabling the 'expect-continue'
handshake by adding
Expect header.Signals that the request has been aborted or failed due to an expected condition.
Protocol support methods.
Represents a disposable system resource used for handling
cached response bodies.
Generates
Resource instances for handling cached
HTTP response bodies.Signals a generic resource I/O error.
HTTP response used by the fluent facade.
Response interceptor that populates the current
CookieStore with data
contained in response cookies received in the given the HTTP response.Cookie management functions shared by RFC 6265 compliant specification.
CookieSpecFactory implementation that provides an instance of
RFC 6265 conformant cookie policy.Standard
CookieSpec implementation that enforces
a more relaxed interpretation of the HTTP state management specification (RFC 6265, section 5)
for interoperability with existing servers that do not conform to the well behaved profile
(RFC 6265, section 4).Standard
CookieSpec implementation
that enforces syntax and semantics of the well-behaved profile of the HTTP
state management specification (RFC 6265, section 4).Connection route information.
The layering type of a route.
The tunnelling type of a route.
Helps tracking the steps in establishing a route.
Strategy to determine an execution time (schedule) for an operation.
Strategy for default port resolution for protocol schemes.
This interface represents a
Set-Cookie response header sent by the
origin server to the HTTP agent in order to maintain a conversational state.Message body representation as a simple text string or an array of bytes.
HTTP request that can enclose a body represented as a simple text string or an array of bytes.
Deprecated.
Use
SimpleRequestBuilder.HTTP response that can enclose a body represented as a simple text string or an array of bytes.
Builder for
SimpleHttpRequest instances.HTTP request producer that generates message data stream events based
on content of a
SimpleHttpRequest instance.Builder for
SimpleHttpResponse instances.HTTP response consumer that generates a
SimpleHttpResponse instance based on events
of an incoming data stream.Deprecated.
Do not use.
Deprecated.
Do not use.
Layered socket factory for TLS/SSL connections.
Builder for
SSLConnectionSocketFactory instances.Authentication schemes by their names supported by the HttpClient.
Cookie specifications by their names supported by the HttpClient.
Text body part backed by a byte array.
Implementation of
CredentialsStore backed by standard
JRE Authenticator.DNS resolver that uses the default OS implementation for resolving host names.
HttpRoutePlanner implementation
based on ProxySelector.Immutable class encapsulating TLS protocol settings.
A trust strategy that accepts all certificates as trusted.
Deprecated.
For self-signed certificates prefer specifying a keystore containing the certificate when
calling the
SSLContextBuilder loadTrustMaterial
methods.Signals that the tunnel request was rejected by the proxy host.
Authentication credentials required to respond to a authentication
challenge are invalid
Signals failure to establish connection using an unknown protocol scheme.
A collection of utilities for
URIs, to workaround
bugs within the class or for ease-of-use features.An entity composed of a list of url-encoded pairs.
Simple
Credentials representation based on a user name / password
pair.A handler for determining if the given execution context is user specific
or not.
Records a set of information describing a cached variant.
This class provides for parsing and understanding Warning headers.
BasicAuthenticationHandler.