Package org.eclipse.jetty.client
The core class is HttpClient
, which acts as a central configuration object (for example
for idle timeouts
, max connections per destination
, etc.) and as a factory for Request
objects.
The HTTP protocol is based on the request/response paradigm, a unit that in this implementation is called
exchange and is represented by HttpExchange
.
An initial request may trigger a sequence of exchanges with one or more servers, called a conversation
and represented by HttpConversation
. A typical example of a conversation is a redirect, where
upon a request for a resource URI, the server replies with a redirect (for example with the 303 status code)
to another URI. This conversation is made of a first exchange made of the original request and its 303 response,
and of a second exchange made of the request for the new URI and its 200 response.
HttpClient
holds a number of destinations
, which in turn hold a number of
pooled connections
.
When a request is sent, its exchange is associated to a connection, either taken from an idle queue or created
anew, and when both the request and response are completed, the exchange is disassociated from the connection.
Conversations may span multiple connections on different destinations, and therefore are maintained at the
HttpClient
level.
Applications may decide to send the request and wait for the response in a blocking way, using
Request.send()
.
Alternatively, application may ask to be notified of response events asynchronously, using
Request.send(org.eclipse.jetty.client.api.Response.CompleteListener)
.
-
ClassDescriptionA
ContentProvider
that notifies listeners that content is available.A listener that is notified of content availabilityClient-side connection pool abstraction.Factory for ConnectionPool instances.Marks a connection pool as supporting multiplexed connections.ContentDecoder
decodes content bytes of a response.Factory forContentDecoder
s; subclasses must implementContentDecoder.Factory.newContentDecoder()
.A protocol handler that handles the 100 response code.ContentDecoder
for the "gzip" encoding.SpecializedContentDecoder.Factory
for the "gzip" encoding.HttpClient
provides an efficient, asynchronous, non-blocking implementation to perform HTTP requests to a server through a simple API that offers also blocking semantic.HttpClientTransport
represents what transport implementations should provide in order to plug-in a different transport forHttpClient
.HttpContent
is a stateful, linear representation of the request content provided by aContentProvider
that can be traversed one-way to obtain content buffers to send to an HTTP server.Creates a tunnel using HTTP CONNECT.HttpReceiver
provides the abstract code to implement the various steps of the receive of HTTP responses.The request statesHttpReceiver
goes through when receiving a response.Utility class that handles HTTP redirects.HttpSender
abstracts the algorithm to send HTTP requests, so that subclasses only implement the transport-specific code to send requests over the wire, implementingHttpSender.sendHeaders(HttpExchange, HttpContent, Callback)
andHttpSender.sendContent(HttpExchange, HttpContent, Callback)
.The request statesHttpSender
goes through when sending a request.The sender statesHttpSender
goes through when sending a request.A protocol handler performs HTTP protocol operations on behalf of the application, typically like a browser would.A container forProtocolHandler
s accessible fromHttpClient.getProtocolHandlers()
.A protocol handler that handles the 401 response code in association with theProxy-Authenticate
header.The configuration of the forward proxy to use withHttpClient
.ClientConnectionFactory for the PROXY protocol.A ClientConnectionFactory for the PROXY protocol version 1.PROXY protocol version 1 metadata holder to be used in conjunction withRequest.tag(Object)
.A ClientConnectionFactory for the PROXY protocol version 2.PROXY protocol version 2 metadata holder to be used in conjunction withRequest.tag(Object)
.AConnectionPool
that provides connections randomly among the ones that are available.A protocol handler that handles redirect status codes 301, 302, 303, 307 and 308.AConnectionPool
that attempts to provide connections using a round-robin algorithm.Implementations of this interface expose a lock object viaSynchronizable.getLock()
so that callers can synchronize externally on that lock:A connection pool that validates connections before making them available for use.A protocol handler that handles the 401 response code in association with theWWW-Authenticate
header.