Jetty 12.0.6 · org.eclipse.jetty.client.HttpClient · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private long	addressResolutionTimeout
private HttpField	agentField
private AuthenticationStore	authenticationStore
private final ClientConnector	connector
private static final SetCookieParser	COOKIE_PARSER
private HttpCookieStore	cookieStore
private final ContentDecoder.Factories	decoderFactories
private String	defaultRequestContentType
private long	destinationIdleTimeout
private final ConcurrentMap<Origin, HttpDestination>	destinations
private Sweeper	destinationSweeper
private boolean	followRedirects
private final ProtocolHandlers	handlers
private HttpCompliance	httpCompliance
private static final Logger	LOG Hides org.eclipse.jetty.util.component.ContainerLifeCycle.LOG.
private int	maxConnectionsPerDestination
private int	maxRedirects
private int	maxRequestsQueuedPerDestination
private int	maxResponseHeadersSize
private String	name
private final ProxyConfiguration	proxyConfig
private int	requestBufferSize
private final RequestListeners	requestListeners
private SocketAddressResolver	resolver
private int	responseBufferSize
private boolean	strictEventOrdering
private final HttpClientTransport	transport
private boolean	useInputDirectByteBuffers
private boolean	useOutputDirectByteBuffers
public static final String	USER_AGENT

Access	Constructor and Description
public	HttpClient() Creates a HttpClient instance that can perform HTTP/1.1 requests to non-TLS and TLS destinations.
public	HttpClient(HttpClientTransport transport)

Method Summary

Modifier and Type	Method and Description
protected Request	copyRequest(Request oldRequest, URI newURI)
public Origin	createOrigin(Request request, Origin.Protocol protocol)
protected void	doStart() Overrides org.eclipse.jetty.util.component.ContainerLifeCycle.doStart. Starts the managed lifecycle beans in the order they were added.
protected void	doStop() Overrides org.eclipse.jetty.util.component.ContainerLifeCycle.doStop. Stops the managed lifecycle beans in the reverse order they were added.
public ProtocolHandler	findProtocolHandler(Request request, Response response)
public ContentResponse	Returns: the `ContentResponse` for the request FORM(String the URI to POST uri, Fields the fields composing the form name/value pairs fields) Performs a POST request to the specified URI with the given form parameters.
public ContentResponse	Returns: the `ContentResponse` for the request FORM(URI the URI to POST uri, Fields the fields composing the form name/value pairs fields) Performs a POST request to the specified URI with the given form parameters.
public ContentResponse	Returns: the `ContentResponse` for the request GET(String the URI to GET uri) Performs a GET request to the specified URI.
public ContentResponse	Returns: the `ContentResponse` for the request GET(URI the URI to GET uri) Performs a GET request to the specified URI.
public long	getAddressResolutionTimeout() Returns: the timeout, in milliseconds, for the default `SocketAddressResolver` created at startup
public AuthenticationStore	Returns: the authentication store associated with this instance getAuthenticationStore() Get the authentication store associated with this instance.
public SocketAddress	getBindAddress() Returns: the address to bind socket channels to
public ByteBufferPool	Returns: the `ByteBufferPool` of this HttpClient getByteBufferPool() Get the `ByteBufferPool` of this HttpClient.
public long	getConnectTimeout() Returns: the max time, in milliseconds, a connection can take to connect to destinations.
public ContentDecoder.Factories	Returns: a set of `ContentDecoder.Factory` that can be used to add and remove content decoder factories getContentDecoderFactories() Returns a non thread-safe set of `ContentDecoder.Factory`s that can be modified before performing requests.
public String	getDefaultRequestContentType() Returns: the default content type for request content
public long	Returns: the time in ms after which idle destinations are removed getDestinationIdleTimeout() The default value is 0
public List<Destination>	getDestinations() Returns: the list of destinations known to this HttpClient.
public Executor	Returns: the `Executor` of this HttpClient getExecutor() Get the `Executor` of this HttpClient.
public HttpCompliance	Returns: the HttpCompliance instance getHttpCompliance() Gets the http compliance mode for parsing http responses.
public HttpCookieStore	Returns: the cookie store associated with this instance getHttpCookieStore() Get the cookie store associated with this instance.
public long	getIdleTimeout() Returns: the max time, in milliseconds, a connection can be idle (that is, without traffic of bytes in either direction)
public int	getMaxConnectionsPerDestination() Returns: the max number of connections that this HttpClient opens to `Destination`s
public int	getMaxRedirects() Returns: the max number of HTTP redirects that are followed in a conversation
public int	getMaxRequestsQueuedPerDestination() Returns: the max number of requests that may be queued to a `Destination`.
public int	getMaxResponseHeadersSize() Returns: the max size in bytes of the response headers
public String	getName() Returns: the name of this HttpClient
public ProtocolHandlers	getProtocolHandlers()
public ProxyConfiguration	Returns: the forward proxy configuration getProxyConfiguration() Get the forward proxy configuration.
public int	getRequestBufferSize() Returns: the size of the buffer (in bytes) used to write requests
public RequestListeners	Returns: a `RequestListeners` instance that can be used to add request listeners getRequestListeners() Returns a non thread-safe container of `Request.Listener`s that allows to add request listeners before performing requests.
public int	getResponseBufferSize() Returns: the size of the buffer (in bytes) used to read responses
public Scheduler	Returns: the `Scheduler` of this HttpClient getScheduler() Get the `Scheduler` of this HttpClient.
public SocketAddressResolver	Returns: the `SocketAddressResolver` of this HttpClient getSocketAddressResolver() Get the `SocketAddressResolver` of this HttpClient.
public SslContextFactory.Client	getSslContextFactory() Returns: the `SslContextFactory.Client` that manages TLS encryption
public HttpClientTransport	getTransport()
public HttpField	Returns: the "User-Agent" HTTP field of this HttpClient getUserAgentField() Get the "User-Agent" HTTP field of this HttpClient.
public boolean	isConnectBlocking() Returns: whether `connect()` operations are performed in blocking mode
public boolean	isFollowRedirects() Returns: whether this HttpClient follows HTTP redirects
public boolean	isStrictEventOrdering() Returns: whether request events must be strictly ordered
public boolean	isUseInputDirectByteBuffers() Returns: whether to use direct ByteBuffers for reading
public boolean	isUseOutputDirectByteBuffers() Returns: whether to use direct ByteBuffers for writing
public void	newConnection(Destination destination, Promise<Connection> promise)
private HttpConversation	newConversation()
private HttpRequest	newHttpRequest(HttpConversation conversation, URI uri)
public Request	Returns: the request just created newRequest(String the request host host, int the request port port) Creates a new request with the "http" scheme and the specified host and port
public Request	Returns: the request just created newRequest(String the request absolute URI uri) Creates a new request with the specified absolute URI in string format.
public Request	Returns: the request just created newRequest(URI the request absolute URI uri) Creates a new request with the specified absolute URI.
public ClientConnectionFactory	newSslClientConnectionFactory(SslContextFactory.Client sslContextFactory, ClientConnectionFactory connectionFactory)
public static int	normalizePort(String scheme, int port)
public Request	Returns: the POST request POST(String the URI to POST to uri) Creates a POST request to the specified URI.
public Request	Returns: the POST request POST(URI the URI to POST to uri) Creates a POST request to the specified URI.
public void	putCookie(URI uri, HttpField field)
public boolean	removeDestination(Destination destination)
public Destination	resolveDestination(Request request)
public Destination	Returns: the destination for the given origin resolveDestination(Origin the origin that identifies the destination origin) Returns, creating it if absent, the destination with the given origin.
public void	setAddressResolutionTimeout(long the timeout, in milliseconds, for the default `SocketAddressResolver` created at startup addressResolutionTimeout) Sets the socket address resolution timeout used by the default `SocketAddressResolver` created by this HttpClient at startup.
public void	setAuthenticationStore(AuthenticationStore the authentication store associated with this instance authenticationStore) Set the authentication store associated with this instance.
public void	setBindAddress(SocketAddress the address to bind socket channels to bindAddress)
public void	setByteBufferPool(ByteBufferPool the `ByteBufferPool` of this HttpClient byteBufferPool) Set the `ByteBufferPool` of this HttpClient.
public void	setConnectBlocking(boolean whether `connect()` operations are performed in blocking mode connectBlocking) Whether `connect()` operations are performed in blocking mode.
public void	setConnectTimeout(long the max time, in milliseconds, a connection can take to connect to destinations. Zero value means infinite timeout. connectTimeout)
public void	setDefaultRequestContentType(String the default content type for request content contentType) Set the default content type for request content.
public void	setDestinationIdleTimeout(long the time in ms after which idle destinations are removed destinationIdleTimeout) Whether destinations that have no connections (nor active nor idle) and no exchanges should be removed after the specified timeout.
public void	setExecutor(Executor the `Executor` of this HttpClient executor) Set the `Executor` of this HttpClient.
public void	setFollowRedirects(boolean whether this HttpClient follows HTTP redirects follow)
public void	setHttpCompliance(HttpCompliance The compliance level which is used to actually parse http responses httpCompliance) Sets the http compliance mode for parsing http responses.
public void	setHttpCookieStore(HttpCookieStore the cookie store associated with this instance cookieStore) Set the cookie store associated with this instance.
public void	setIdleTimeout(long the max time, in milliseconds, a connection can be idle (that is, without traffic of bytes in either direction) idleTimeout) Set the max time, in milliseconds, a connection can be idle (that is, without traffic of bytes in either direction).
public void	setMaxConnectionsPerDestination(int the max number of connections that this HttpClient opens to `Destination`s maxConnectionsPerDestination) Sets the max number of connections to open to each destinations.
public void	setMaxRedirects(int the max number of HTTP redirects that are followed in a conversation, or -1 for unlimited redirects maxRedirects)
public void	setMaxRequestsQueuedPerDestination(int the max number of requests that may be queued to a `Destination`. maxRequestsQueuedPerDestination) Sets the max number of requests that may be queued to a destination.
public void	setMaxResponseHeadersSize(int the max size in bytes of the response headers maxResponseHeadersSize) Set the max size in bytes of the response headers.
public void	setName(String the name of this HttpClient name) Sets the name of this HttpClient.
public void	setRequestBufferSize(int the size of the buffer (in bytes) used to write requests requestBufferSize) Set the size of the buffer (in bytes) used to write requests.
public void	setResponseBufferSize(int the size of the buffer used to read responses responseBufferSize) Set the size of the buffer used to read responses.
public void	setScheduler(Scheduler the `Scheduler` of this HttpClient scheduler) Set the `Scheduler` of this HttpClient.
public void	setSocketAddressResolver(SocketAddressResolver the `SocketAddressResolver` of this HttpClient resolver) Set the `SocketAddressResolver` of this HttpClient.
public void	setSslContextFactory(SslContextFactory.Client the `SslContextFactory.Client` that manages TLS encryption sslContextFactory) Set the `SslContextFactory.Client` that manages TLS encryption.
public void	setStrictEventOrdering(boolean whether request/response events must be strictly ordered strictEventOrdering) Whether request/response events must be strictly ordered with respect to connection usage.
public void	setUseInputDirectByteBuffers(boolean whether to use direct ByteBuffers for reading useInputDirectByteBuffers) Set whether to use direct ByteBuffers for reading.
public void	setUseOutputDirectByteBuffers(boolean whether to use direct ByteBuffers for writing useOutputDirectByteBuffers) Set whether to use direct ByteBuffers for writing.
public void	setUserAgentField(HttpField the "User-Agent" HTTP header string of this HttpClient agent) Set the "User-Agent" HTTP header string of this HttpClient.

public Class HttpClient

Field Summary

Constructor Summary

Method Summary