public interface HttpClient extends Measured
It allows you to make requests to HTTP servers, and a single client can make requests to any server.
It also allows you to open WebSockets to servers.
The client can also pool HTTP connections.
For pooling to occur, keep-alive must be true on the HttpClientOptions (default is true).
In this case connections will be pooled and re-used if there are pending HTTP requests waiting to get a connection,
otherwise they will be closed.
This gives the benefits of keep alive when the client is loaded but means we don't keep connections hanging around unnecessarily when there would be no benefits anyway.
The client also supports pipe-lining of requests. Pipe-lining means another request is sent on the same connection before the response from the preceding one has returned. Pipe-lining is not appropriate for all requests.
To enable pipe-lining, it must be enabled on the HttpClientOptions (default is false).
When pipe-lining is enabled the connection will be automatically closed when all in-flight responses have returned and there are no outstanding pending requests to write.
The client is designed to be reused between requests.
| Modifier and Type | Method and Description |
|---|---|
void |
close()
Close the client.
|
HttpClient |
connectionHandler(Handler<HttpConnection> handler)
Set a connection handler for the client.
|
HttpClientRequest |
delete(int port,
String host,
String requestURI)
Create an HTTP DELETE request to send to the server at the specified host and port.
|
HttpClientRequest |
delete(int port,
String host,
String requestURI,
Handler<AsyncResult<HttpClientResponse>> responseHandler)
Create an HTTP DELETE request to send to the server at the specified host and port, specifying a response handler to receive
the response
|
HttpClientRequest |
delete(RequestOptions options)
Create an HTTP DELETE request to send to the server with the specified options.
|
HttpClientRequest |
delete(RequestOptions options,
Handler<AsyncResult<HttpClientResponse>> responseHandler)
Create an HTTP DELETE request to send to the server with the specified options, specifying a response handler to receive
the response
|
HttpClientRequest |
delete(String requestURI)
Create an HTTP DELETE request to send to the server at the default host and port.
|
HttpClientRequest |
delete(String requestURI,
Handler<AsyncResult<HttpClientResponse>> responseHandler)
Create an HTTP DELETE request to send to the server at the default host and port, specifying a response handler to receive
the response
|
HttpClientRequest |
delete(String host,
String requestURI)
Create an HTTP DELETE request to send to the server at the specified host and default port.
|
HttpClientRequest |
delete(String host,
String requestURI,
Handler<AsyncResult<HttpClientResponse>> responseHandler)
Create an HTTP DELETE request to send to the server at the specified host and default port, specifying a response handler to receive
the response
|
HttpClientRequest |
deleteAbs(String absoluteURI)
Create an HTTP DELETE request to send to the server using an absolute URI
|
HttpClientRequest |
deleteAbs(String absoluteURI,
Handler<AsyncResult<HttpClientResponse>> responseHandler)
Create an HTTP DELETE request to send to the server using an absolute URI, specifying a response handler to receive
the response
|
HttpClientRequest |
get(int port,
String host,
String requestURI)
Create an HTTP GET request to send to the server at the specified host and port.
|
HttpClientRequest |
get(int port,
String host,
String requestURI,
Handler<AsyncResult<HttpClientResponse>> responseHandler)
Create an HTTP GET request to send to the server at the specified host and port, specifying a response handler to receive
the response
|
HttpClientRequest |
get(RequestOptions options)
Create an HTTP GET request to send to the server with the specified options.
|
HttpClientRequest |
get(RequestOptions options,
Handler<AsyncResult<HttpClientResponse>> responseHandler)
Create an HTTP GET request to send to the server with the specified options, specifying a response handler to receive
the response
|
HttpClientRequest |
get(String requestURI)
Create an HTTP GET request to send to the server at the default host and port.
|
HttpClientRequest |
get(String requestURI,
Handler<AsyncResult<HttpClientResponse>> responseHandler)
Create an HTTP GET request to send to the server at the default host and port, specifying a response handler to receive
the response
|
HttpClientRequest |
get(String host,
String requestURI)
Create an HTTP GET request to send to the server at the specified host and default port.
|
HttpClientRequest |
get(String host,
String requestURI,
Handler<AsyncResult<HttpClientResponse>> responseHandler)
Create an HTTP GET request to send to the server at the specified host and default port, specifying a response handler to receive
the response
|
HttpClientRequest |
getAbs(String absoluteURI)
Create an HTTP GET request to send to the server using an absolute URI
|
HttpClientRequest |
getAbs(String absoluteURI,
Handler<AsyncResult<HttpClientResponse>> responseHandler)
Create an HTTP GET request to send to the server using an absolute URI, specifying a response handler to receive
the response
|
default Future<HttpClientResponse> |
getNow(int port,
String host,
String requestURI)
Like
getNow(int, String, String, Handler) but returns a Future of the asynchronous result |
HttpClient |
getNow(int port,
String host,
String requestURI,
Handler<AsyncResult<HttpClientResponse>> responseHandler)
Sends an HTTP GET request to the server at the specified host and port, specifying a response handler to receive
the response
|
default Future<HttpClientResponse> |
getNow(RequestOptions options)
Like
getNow(RequestOptions, Handler) but returns a Future of the asynchronous result |
HttpClient |
getNow(RequestOptions options,
Handler<AsyncResult<HttpClientResponse>> responseHandler)
Sends an HTTP GET request to the server with the specified options, specifying a response handler to receive
the response
|
default Future<HttpClientResponse> |
getNow(String requestURI)
Like
getNow(String, Handler) but returns a Future of the asynchronous result |
HttpClient |
getNow(String requestURI,
Handler<AsyncResult<HttpClientResponse>> responseHandler)
Sends an HTTP GET request to the server at the default host and port, specifying a response handler to receive
the response
|
default Future<HttpClientResponse> |
getNow(String host,
String requestURI)
Like
getNow(String, String, Handler) but returns a Future of the asynchronous result |
HttpClient |
getNow(String host,
String requestURI,
Handler<AsyncResult<HttpClientResponse>> responseHandler)
Sends an HTTP GET request to the server at the specified host and default port, specifying a response handler to receive
the response
|
HttpClientRequest |
head(int port,
String host,
String requestURI)
Create an HTTP HEAD request to send to the server at the specified host and port.
|
HttpClientRequest |
head(int port,
String host,
String requestURI,
Handler<AsyncResult<HttpClientResponse>> responseHandler)
Create an HTTP HEAD request to send to the server at the specified host and port, specifying a response handler to receive
the response
|
HttpClientRequest |
head(RequestOptions options)
Create an HTTP HEAD request to send to the server with the specified options.
|
HttpClientRequest |
head(RequestOptions options,
Handler<AsyncResult<HttpClientResponse>> responseHandler)
Create an HTTP HEAD request to send to the server with the specified options, specifying a response handler to receive
the response
|
HttpClientRequest |
head(String requestURI)
Create an HTTP HEAD request to send to the server at the default host and port.
|
HttpClientRequest |
head(String requestURI,
Handler<AsyncResult<HttpClientResponse>> responseHandler)
Create an HTTP HEAD request to send to the server at the default host and port, specifying a response handler to receive
the response
|
HttpClientRequest |
head(String host,
String requestURI)
Create an HTTP HEAD request to send to the server at the specified host and default port.
|
HttpClientRequest |
head(String host,
String requestURI,
Handler<AsyncResult<HttpClientResponse>> responseHandler)
Create an HTTP HEAD request to send to the server at the specified host and default port, specifying a response handler to receive
the response
|
HttpClientRequest |
headAbs(String absoluteURI)
Create an HTTP HEAD request to send to the server using an absolute URI
|
HttpClientRequest |
headAbs(String absoluteURI,
Handler<AsyncResult<HttpClientResponse>> responseHandler)
Create an HTTP HEAD request to send to the server using an absolute URI, specifying a response handler to receive
the response
|
default Future<HttpClientResponse> |
headNow(int port,
String host,
String requestURI)
Like
headNow(int, String, String, Handler) but returns a Future of the asynchronous result |
HttpClient |
headNow(int port,
String host,
String requestURI,
Handler<AsyncResult<HttpClientResponse>> responseHandler)
Sends an HTTP HEAD request to the server at the specified host and port, specifying a response handler to receive
the response
|
default Future<HttpClientResponse> |
headNow(RequestOptions options)
Like
headNow(RequestOptions, Handler) but returns a Future of the asynchronous result |
HttpClient |
headNow(RequestOptions options,
Handler<AsyncResult<HttpClientResponse>> responseHandler)
Sends an HTTP HEAD request to the server with the specified options, specifying a response handler to receive
the response
|
default Future<HttpClientResponse> |
headNow(String requestURI)
Like
headNow(String, Handler) but returns a Future of the asynchronous result |
HttpClient |
headNow(String requestURI,
Handler<AsyncResult<HttpClientResponse>> responseHandler)
Sends an HTTP HEAD request to the server at the default host and port, specifying a response handler to receive
the response
|
default Future<HttpClientResponse> |
headNow(String host,
String requestURI)
Like
headNow(String, String, Handler) but returns a Future of the asynchronous result |
HttpClient |
headNow(String host,
String requestURI,
Handler<AsyncResult<HttpClientResponse>> responseHandler)
Sends an HTTP HEAD request to the server at the specified host and default port, specifying a response handler to receive
the response
|
HttpClientRequest |
options(int port,
String host,
String requestURI)
Create an HTTP OPTIONS request to send to the server at the specified host and port.
|
HttpClientRequest |
options(int port,
String host,
String requestURI,
Handler<AsyncResult<HttpClientResponse>> responseHandler)
Create an HTTP OPTIONS request to send to the server at the specified host and port, specifying a response handler to receive
the response
|
HttpClientRequest |
options(RequestOptions options)
Create an HTTP OPTIONS request to send to the server with the specified options.
|
HttpClientRequest |
options(RequestOptions options,
Handler<AsyncResult<HttpClientResponse>> responseHandler)
Create an HTTP OPTIONS request to send to the server with the specified options, specifying a response handler to receive
the response
|
HttpClientRequest |
options(String requestURI)
Create an HTTP OPTIONS request to send to the server at the default host and port.
|
HttpClientRequest |
options(String requestURI,
Handler<AsyncResult<HttpClientResponse>> responseHandler)
Create an HTTP OPTIONS request to send to the server at the default host and port, specifying a response handler to receive
the response
|
HttpClientRequest |
options(String host,
String requestURI)
Create an HTTP OPTIONS request to send to the server at the specified host and default port.
|
HttpClientRequest |
options(String host,
String requestURI,
Handler<AsyncResult<HttpClientResponse>> responseHandler)
Create an HTTP OPTIONS request to send to the server at the specified host and default port, specifying a response handler to receive
the response
|
HttpClientRequest |
optionsAbs(String absoluteURI)
Create an HTTP OPTIONS request to send to the server using an absolute URI
|
HttpClientRequest |
optionsAbs(String absoluteURI,
Handler<AsyncResult<HttpClientResponse>> responseHandler)
Create an HTTP OPTIONS request to send to the server using an absolute URI, specifying a response handler to receive
the response
|
default Future<HttpClientResponse> |
optionsNow(int port,
String host,
String requestURI)
Like
optionsNow(int, String, String, Handler) but returns a Future of the asynchronous result |
HttpClient |
optionsNow(int port,
String host,
String requestURI,
Handler<AsyncResult<HttpClientResponse>> responseHandler)
Sends an HTTP OPTIONS request to the server at the specified host and port, specifying a response handler to receive
the response
|
default Future<HttpClientResponse> |
optionsNow(RequestOptions options)
Like
optionsNow(RequestOptions, Handler) but returns a Future of the asynchronous result |
HttpClient |
optionsNow(RequestOptions options,
Handler<AsyncResult<HttpClientResponse>> responseHandler)
Sends an HTTP OPTIONS request to the server with the specified options, specifying a response handler to receive
the response
|
default Future<HttpClientResponse> |
optionsNow(String requestURI)
Like
optionsNow(String, Handler) but returns a Future of the asynchronous result |
HttpClient |
optionsNow(String requestURI,
Handler<AsyncResult<HttpClientResponse>> responseHandler)
Sends an HTTP OPTIONS request to the server at the default host and port, specifying a response handler to receive
the response
|
default Future<HttpClientResponse> |
optionsNow(String host,
String requestURI)
Like
optionsNow(String, String, Handler) but returns a Future of the asynchronous result |
HttpClient |
optionsNow(String host,
String requestURI,
Handler<AsyncResult<HttpClientResponse>> responseHandler)
Sends an HTTP OPTIONS request to the server at the specified host and default port, specifying a response handler to receive
the response
|
HttpClientRequest |
post(int port,
String host,
String requestURI)
Create an HTTP POST request to send to the server at the specified host and port.
|
HttpClientRequest |
post(int port,
String host,
String requestURI,
Handler<AsyncResult<HttpClientResponse>> responseHandler)
Create an HTTP POST request to send to the server at the specified host and port, specifying a response handler to receive
the response
|
HttpClientRequest |
post(RequestOptions options)
Create an HTTP POST request to send to the server with the specified options.
|
HttpClientRequest |
post(RequestOptions options,
Handler<AsyncResult<HttpClientResponse>> responseHandler)
Create an HTTP POST request to send to the server with the specified options, specifying a response handler to receive
the response
|
HttpClientRequest |
post(String requestURI)
Create an HTTP POST request to send to the server at the default host and port.
|
HttpClientRequest |
post(String requestURI,
Handler<AsyncResult<HttpClientResponse>> responseHandler)
Create an HTTP POST request to send to the server at the default host and port, specifying a response handler to receive
the response
|
HttpClientRequest |
post(String host,
String requestURI)
Create an HTTP POST request to send to the server at the specified host and default port.
|
HttpClientRequest |
post(String host,
String requestURI,
Handler<AsyncResult<HttpClientResponse>> responseHandler)
Create an HTTP POST request to send to the server at the specified host and default port, specifying a response handler to receive
the response
|
HttpClientRequest |
postAbs(String absoluteURI)
Create an HTTP POST request to send to the server using an absolute URI
|
HttpClientRequest |
postAbs(String absoluteURI,
Handler<AsyncResult<HttpClientResponse>> responseHandler)
Create an HTTP POST request to send to the server using an absolute URI, specifying a response handler to receive
the response
|
HttpClientRequest |
put(int port,
String host,
String requestURI)
Create an HTTP PUT request to send to the server at the specified host and port.
|
HttpClientRequest |
put(int port,
String host,
String requestURI,
Handler<AsyncResult<HttpClientResponse>> responseHandler)
Create an HTTP PUT request to send to the server at the specified host and port, specifying a response handler to receive
the response
|
HttpClientRequest |
put(RequestOptions options)
Create an HTTP PUT request to send to the server with the specified options.
|
HttpClientRequest |
put(RequestOptions options,
Handler<AsyncResult<HttpClientResponse>> responseHandler)
Create an HTTP PUT request to send to the server with the specified options, specifying a response handler to receive
the response
|
HttpClientRequest |
put(String requestURI)
Create an HTTP PUT request to send to the server at the default host and port.
|
HttpClientRequest |
put(String requestURI,
Handler<AsyncResult<HttpClientResponse>> responseHandler)
Create an HTTP PUT request to send to the server at the default host and port, specifying a response handler to receive
the response
|
HttpClientRequest |
put(String host,
String requestURI)
Create an HTTP PUT request to send to the server at the specified host and default port.
|
HttpClientRequest |
put(String host,
String requestURI,
Handler<AsyncResult<HttpClientResponse>> responseHandler)
Create an HTTP PUT request to send to the server at the specified host and default port, specifying a response handler to receive
the response
|
HttpClientRequest |
putAbs(String absoluteURI)
Create an HTTP PUT request to send to the server using an absolute URI
|
HttpClientRequest |
putAbs(String absoluteURI,
Handler<AsyncResult<HttpClientResponse>> responseHandler)
Create an HTTP PUT request to send to the server using an absolute URI, specifying a response handler to receive
the response
|
java.util.function.Function<HttpClientResponse,Future<HttpClientRequest>> |
redirectHandler() |
HttpClient |
redirectHandler(java.util.function.Function<HttpClientResponse,Future<HttpClientRequest>> handler)
Set a redirect handler for the http client.
|
HttpClientRequest |
request(HttpMethod method,
int port,
String host,
String requestURI)
Create an HTTP request to send to the server at the specified host and port.
|
HttpClientRequest |
request(HttpMethod method,
int port,
String host,
String requestURI,
Handler<AsyncResult<HttpClientResponse>> responseHandler)
Create an HTTP request to send to the server at the specified host and port, specifying a response handler to receive
the response
|
HttpClientRequest |
request(HttpMethod method,
RequestOptions options)
Create an HTTP request to send to the server with the specified options.
|
HttpClientRequest |
request(HttpMethod method,
RequestOptions options,
Handler<AsyncResult<HttpClientResponse>> responseHandler)
Create an HTTP request to send to the server with the specified options, specifying a response handler to receive
|
HttpClientRequest |
request(HttpMethod method,
SocketAddress serverAddress,
int port,
String host,
String requestURI)
Like
request(HttpMethod, int, String, String) using the serverAddress parameter to connect to the
server instead of the absoluteURI parameter. |
HttpClientRequest |
request(HttpMethod method,
SocketAddress serverAddress,
int port,
String host,
String requestURI,
Handler<AsyncResult<HttpClientResponse>> responseHandler)
Like
request(HttpMethod, int, String, String, Handler) using the serverAddress parameter to connect to the
server instead of the absoluteURI parameter. |
HttpClientRequest |
request(HttpMethod method,
SocketAddress serverAddress,
RequestOptions options)
Like
request(HttpMethod, RequestOptions) using the serverAddress parameter to connect to the
server instead of the absoluteURI parameter. |
HttpClientRequest |
request(HttpMethod method,
SocketAddress serverAddress,
RequestOptions options,
Handler<AsyncResult<HttpClientResponse>> responseHandler)
Like
request(HttpMethod, RequestOptions, Handler) using the serverAddress parameter to connect to the
server instead of the absoluteURI parameter. |
HttpClientRequest |
request(HttpMethod method,
String requestURI)
Create an HTTP request to send to the server at the default host and port.
|
HttpClientRequest |
request(HttpMethod method,
String requestURI,
Handler<AsyncResult<HttpClientResponse>> responseHandler)
Create an HTTP request to send to the server at the default host and port, specifying a response handler to receive
the response
|
HttpClientRequest |
request(HttpMethod method,
String host,
String requestURI)
Create an HTTP request to send to the server at the specified host and default port.
|
HttpClientRequest |
request(HttpMethod method,
String host,
String requestURI,
Handler<AsyncResult<HttpClientResponse>> responseHandler)
Create an HTTP request to send to the server at the specified host and default port, specifying a response handler to receive
the response
|
HttpClientRequest |
requestAbs(HttpMethod method,
SocketAddress serverAddress,
String absoluteURI)
Like
requestAbs(HttpMethod, String) using the serverAddress parameter to connect to the
server instead of the absoluteURI parameter. |
HttpClientRequest |
requestAbs(HttpMethod method,
SocketAddress serverAddress,
String absoluteURI,
Handler<AsyncResult<HttpClientResponse>> responseHandler)
Like
requestAbs(HttpMethod, String, Handler) using the serverAddress parameter to connect to the
server instead of the absoluteURI parameter. |
HttpClientRequest |
requestAbs(HttpMethod method,
String absoluteURI)
Create an HTTP request to send to the server using an absolute URI
|
HttpClientRequest |
requestAbs(HttpMethod method,
String absoluteURI,
Handler<AsyncResult<HttpClientResponse>> responseHandler)
Create an HTTP request to send to the server using an absolute URI, specifying a response handler to receive
the response
|
Future<WebSocket> |
webSocket(int port,
String host,
String requestURI)
Like
webSocket(int, String, String, Handler) but returns a Future of the asynchronous result |
void |
webSocket(int port,
String host,
String requestURI,
Handler<AsyncResult<WebSocket>> handler)
Connect a WebSocket to the specified port, host and relative request URI
|
Future<WebSocket> |
webSocket(String requestURI)
Like
webSocket(String, Handler) but returns a Future of the asynchronous result |
void |
webSocket(String requestURI,
Handler<AsyncResult<WebSocket>> handler)
Connect a WebSocket at the relative request URI using the default host and port
|
Future<WebSocket> |
webSocket(String host,
String requestURI)
Like
webSocket(String, String, Handler) but returns a Future of the asynchronous result |
void |
webSocket(String host,
String requestURI,
Handler<AsyncResult<WebSocket>> handler)
Connect a WebSocket to the host and relative request URI and default port
|
Future<WebSocket> |
webSocket(WebSocketConnectOptions options)
Like
webSocket(WebSocketConnectOptions, Handler) but returns a Future of the asynchronous result |
void |
webSocket(WebSocketConnectOptions options,
Handler<AsyncResult<WebSocket>> handler)
Connect a WebSocket with the specified options.
|
Future<WebSocket> |
webSocketAbs(String url,
MultiMap headers,
WebsocketVersion version,
List<String> subProtocols)
Like
webSocketAbs(String, MultiMap, WebsocketVersion, List, Handler) but returns a Future of the asynchronous result |
void |
webSocketAbs(String url,
MultiMap headers,
WebsocketVersion version,
List<String> subProtocols,
Handler<AsyncResult<WebSocket>> handler)
Connect a WebSocket with the specified absolute url, with the specified headers, using
the specified version of WebSockets, and the specified websocket sub protocols.
|
isMetricsEnabledHttpClientRequest request(HttpMethod method, SocketAddress serverAddress, RequestOptions options)
request(HttpMethod, RequestOptions) using the serverAddress parameter to connect to the
server instead of the absoluteURI parameter.
The request host header will still be created from the options parameter.
Use SocketAddress.domainSocketAddress(String) to connect to a unix domain socket server.
HttpClientRequest request(HttpMethod method, RequestOptions options)
method - the HTTP methodoptions - the request optionsHttpClientRequest request(HttpMethod method, int port, String host, String requestURI)
method - the HTTP methodport - the porthost - the hostrequestURI - the relative URIHttpClientRequest request(HttpMethod method, SocketAddress serverAddress, int port, String host, String requestURI)
request(HttpMethod, int, String, String) using the serverAddress parameter to connect to the
server instead of the absoluteURI parameter.
The request host header will still be created from the host and port parameters.
Use SocketAddress.domainSocketAddress(String) to connect to a unix domain socket server.
HttpClientRequest request(HttpMethod method, String host, String requestURI)
method - the HTTP methodhost - the hostrequestURI - the relative URIHttpClientRequest request(HttpMethod method, RequestOptions options, Handler<AsyncResult<HttpClientResponse>> responseHandler)
method - the HTTP methodoptions - the request optionsHttpClientRequest request(HttpMethod method, SocketAddress serverAddress, RequestOptions options, Handler<AsyncResult<HttpClientResponse>> responseHandler)
request(HttpMethod, RequestOptions, Handler) using the serverAddress parameter to connect to the
server instead of the absoluteURI parameter.
The request host header will still be created from the options parameter.
Use SocketAddress.domainSocketAddress(String) to connect to a unix domain socket server.
HttpClientRequest request(HttpMethod method, int port, String host, String requestURI, Handler<AsyncResult<HttpClientResponse>> responseHandler)
method - the HTTP methodport - the porthost - the hostrequestURI - the relative URIresponseHandler - the response handlerHttpClientRequest request(HttpMethod method, SocketAddress serverAddress, int port, String host, String requestURI, Handler<AsyncResult<HttpClientResponse>> responseHandler)
request(HttpMethod, int, String, String, Handler) using the serverAddress parameter to connect to the
server instead of the absoluteURI parameter.
The request host header will still be created from the host and port parameters.
Use SocketAddress.domainSocketAddress(String) to connect to a unix domain socket server.
HttpClientRequest request(HttpMethod method, String host, String requestURI, Handler<AsyncResult<HttpClientResponse>> responseHandler)
method - the HTTP methodhost - the hostrequestURI - the relative URIresponseHandler - the response handlerHttpClientRequest request(HttpMethod method, String requestURI)
method - the HTTP methodrequestURI - the relative URIHttpClientRequest request(HttpMethod method, String requestURI, Handler<AsyncResult<HttpClientResponse>> responseHandler)
method - the HTTP methodrequestURI - the relative URIresponseHandler - the response handlerHttpClientRequest requestAbs(HttpMethod method, String absoluteURI)
method - the HTTP methodabsoluteURI - the absolute URIHttpClientRequest requestAbs(HttpMethod method, SocketAddress serverAddress, String absoluteURI)
requestAbs(HttpMethod, String) using the serverAddress parameter to connect to the
server instead of the absoluteURI parameter.
The request host header will still be created from the absoluteURI parameter.
Use SocketAddress.domainSocketAddress(String) to connect to a unix domain socket server.
HttpClientRequest requestAbs(HttpMethod method, String absoluteURI, Handler<AsyncResult<HttpClientResponse>> responseHandler)
method - the HTTP methodabsoluteURI - the absolute URIresponseHandler - the response handlerHttpClientRequest requestAbs(HttpMethod method, SocketAddress serverAddress, String absoluteURI, Handler<AsyncResult<HttpClientResponse>> responseHandler)
requestAbs(HttpMethod, String, Handler) using the serverAddress parameter to connect to the
server instead of the absoluteURI parameter.
The request host header will still be created from the absoluteURI parameter.
Use SocketAddress.domainSocketAddress(String) to connect to a unix domain socket server.
HttpClientRequest get(RequestOptions options)
options - the request optionsHttpClientRequest get(int port, String host, String requestURI)
port - the porthost - the hostrequestURI - the relative URIHttpClientRequest get(String host, String requestURI)
host - the hostrequestURI - the relative URIHttpClientRequest get(RequestOptions options, Handler<AsyncResult<HttpClientResponse>> responseHandler)
options - the request optionsresponseHandler - the response handlerHttpClientRequest get(int port, String host, String requestURI, Handler<AsyncResult<HttpClientResponse>> responseHandler)
port - the porthost - the hostrequestURI - the relative URIresponseHandler - the response handlerHttpClientRequest get(String host, String requestURI, Handler<AsyncResult<HttpClientResponse>> responseHandler)
host - the hostrequestURI - the relative URIresponseHandler - the response handlerHttpClientRequest get(String requestURI)
requestURI - the relative URIHttpClientRequest get(String requestURI, Handler<AsyncResult<HttpClientResponse>> responseHandler)
requestURI - the relative URIresponseHandler - the response handlerHttpClientRequest getAbs(String absoluteURI)
absoluteURI - the absolute URIHttpClientRequest getAbs(String absoluteURI, Handler<AsyncResult<HttpClientResponse>> responseHandler)
absoluteURI - the absolute URIresponseHandler - the response handlerHttpClient getNow(RequestOptions options, Handler<AsyncResult<HttpClientResponse>> responseHandler)
options - the request optionsresponseHandler - the response handlerdefault Future<HttpClientResponse> getNow(RequestOptions options)
getNow(RequestOptions, Handler) but returns a Future of the asynchronous resultHttpClient getNow(int port, String host, String requestURI, Handler<AsyncResult<HttpClientResponse>> responseHandler)
port - the porthost - the hostrequestURI - the relative URIresponseHandler - the response handlerdefault Future<HttpClientResponse> getNow(int port, String host, String requestURI)
getNow(int, String, String, Handler) but returns a Future of the asynchronous resultHttpClient getNow(String host, String requestURI, Handler<AsyncResult<HttpClientResponse>> responseHandler)
host - the hostrequestURI - the relative URIresponseHandler - the response handlerdefault Future<HttpClientResponse> getNow(String host, String requestURI)
getNow(String, String, Handler) but returns a Future of the asynchronous resultHttpClient getNow(String requestURI, Handler<AsyncResult<HttpClientResponse>> responseHandler)
requestURI - the relative URIresponseHandler - the response handlerdefault Future<HttpClientResponse> getNow(String requestURI)
getNow(String, Handler) but returns a Future of the asynchronous resultHttpClientRequest post(RequestOptions options)
options - the request optionsHttpClientRequest post(int port, String host, String requestURI)
port - the porthost - the hostrequestURI - the relative URIHttpClientRequest post(String host, String requestURI)
host - the hostrequestURI - the relative URIHttpClientRequest post(RequestOptions options, Handler<AsyncResult<HttpClientResponse>> responseHandler)
options - the request optionsresponseHandler - the response handlerHttpClientRequest post(int port, String host, String requestURI, Handler<AsyncResult<HttpClientResponse>> responseHandler)
port - the porthost - the hostrequestURI - the relative URIresponseHandler - the response handlerHttpClientRequest post(String host, String requestURI, Handler<AsyncResult<HttpClientResponse>> responseHandler)
host - the hostrequestURI - the relative URIresponseHandler - the response handlerHttpClientRequest post(String requestURI)
requestURI - the relative URIHttpClientRequest post(String requestURI, Handler<AsyncResult<HttpClientResponse>> responseHandler)
requestURI - the relative URIresponseHandler - the response handlerHttpClientRequest postAbs(String absoluteURI)
absoluteURI - the absolute URIHttpClientRequest postAbs(String absoluteURI, Handler<AsyncResult<HttpClientResponse>> responseHandler)
absoluteURI - the absolute URIresponseHandler - the response handlerHttpClientRequest head(RequestOptions options)
options - the request optionsHttpClientRequest head(int port, String host, String requestURI)
port - the porthost - the hostrequestURI - the relative URIHttpClientRequest head(String host, String requestURI)
host - the hostrequestURI - the relative URIHttpClientRequest head(RequestOptions options, Handler<AsyncResult<HttpClientResponse>> responseHandler)
options - the request optionsresponseHandler - the response handlerHttpClientRequest head(int port, String host, String requestURI, Handler<AsyncResult<HttpClientResponse>> responseHandler)
port - the porthost - the hostrequestURI - the relative URIresponseHandler - the response handlerHttpClientRequest head(String host, String requestURI, Handler<AsyncResult<HttpClientResponse>> responseHandler)
host - the hostrequestURI - the relative URIresponseHandler - the response handlerHttpClientRequest head(String requestURI)
requestURI - the relative URIHttpClientRequest head(String requestURI, Handler<AsyncResult<HttpClientResponse>> responseHandler)
requestURI - the relative URIresponseHandler - the response handlerHttpClientRequest headAbs(String absoluteURI)
absoluteURI - the absolute URIHttpClientRequest headAbs(String absoluteURI, Handler<AsyncResult<HttpClientResponse>> responseHandler)
absoluteURI - the absolute URIresponseHandler - the response handlerHttpClient headNow(RequestOptions options, Handler<AsyncResult<HttpClientResponse>> responseHandler)
options - the request optionsresponseHandler - the response handlerdefault Future<HttpClientResponse> headNow(RequestOptions options)
headNow(RequestOptions, Handler) but returns a Future of the asynchronous resultHttpClient headNow(int port, String host, String requestURI, Handler<AsyncResult<HttpClientResponse>> responseHandler)
port - the porthost - the hostrequestURI - the relative URIresponseHandler - the response handlerdefault Future<HttpClientResponse> headNow(int port, String host, String requestURI)
headNow(int, String, String, Handler) but returns a Future of the asynchronous resultHttpClient headNow(String host, String requestURI, Handler<AsyncResult<HttpClientResponse>> responseHandler)
host - the hostrequestURI - the relative URIresponseHandler - the response handlerdefault Future<HttpClientResponse> headNow(String host, String requestURI)
headNow(String, String, Handler) but returns a Future of the asynchronous resultHttpClient headNow(String requestURI, Handler<AsyncResult<HttpClientResponse>> responseHandler)
requestURI - the relative URIresponseHandler - the response handlerdefault Future<HttpClientResponse> headNow(String requestURI)
headNow(String, Handler) but returns a Future of the asynchronous resultHttpClientRequest options(RequestOptions options)
options - the request optionsHttpClientRequest options(int port, String host, String requestURI)
port - the porthost - the hostrequestURI - the relative URIHttpClientRequest options(String host, String requestURI)
host - the hostrequestURI - the relative URIHttpClientRequest options(RequestOptions options, Handler<AsyncResult<HttpClientResponse>> responseHandler)
options - the request optionsresponseHandler - the response handlerHttpClientRequest options(int port, String host, String requestURI, Handler<AsyncResult<HttpClientResponse>> responseHandler)
port - the porthost - the hostrequestURI - the relative URIresponseHandler - the response handlerHttpClientRequest options(String host, String requestURI, Handler<AsyncResult<HttpClientResponse>> responseHandler)
host - the hostrequestURI - the relative URIresponseHandler - the response handlerHttpClientRequest options(String requestURI)
requestURI - the relative URIHttpClientRequest options(String requestURI, Handler<AsyncResult<HttpClientResponse>> responseHandler)
requestURI - the relative URIresponseHandler - the response handlerHttpClientRequest optionsAbs(String absoluteURI)
absoluteURI - the absolute URIHttpClientRequest optionsAbs(String absoluteURI, Handler<AsyncResult<HttpClientResponse>> responseHandler)
absoluteURI - the absolute URIresponseHandler - the response handlerHttpClient optionsNow(RequestOptions options, Handler<AsyncResult<HttpClientResponse>> responseHandler)
options - the request optionsresponseHandler - the response handlerdefault Future<HttpClientResponse> optionsNow(RequestOptions options)
optionsNow(RequestOptions, Handler) but returns a Future of the asynchronous resultHttpClient optionsNow(int port, String host, String requestURI, Handler<AsyncResult<HttpClientResponse>> responseHandler)
port - the porthost - the hostrequestURI - the relative URIresponseHandler - the response handlerdefault Future<HttpClientResponse> optionsNow(int port, String host, String requestURI)
optionsNow(int, String, String, Handler) but returns a Future of the asynchronous resultHttpClient optionsNow(String host, String requestURI, Handler<AsyncResult<HttpClientResponse>> responseHandler)
host - the hostrequestURI - the relative URIresponseHandler - the response handlerdefault Future<HttpClientResponse> optionsNow(String host, String requestURI)
optionsNow(String, String, Handler) but returns a Future of the asynchronous resultHttpClient optionsNow(String requestURI, Handler<AsyncResult<HttpClientResponse>> responseHandler)
requestURI - the relative URIresponseHandler - the response handlerdefault Future<HttpClientResponse> optionsNow(String requestURI)
optionsNow(String, Handler) but returns a Future of the asynchronous resultHttpClientRequest put(RequestOptions options)
options - the request optionsHttpClientRequest put(int port, String host, String requestURI)
port - the porthost - the hostrequestURI - the relative URIHttpClientRequest put(String host, String requestURI)
host - the hostrequestURI - the relative URIHttpClientRequest put(RequestOptions options, Handler<AsyncResult<HttpClientResponse>> responseHandler)
options - the request optionsresponseHandler - the response handlerHttpClientRequest put(int port, String host, String requestURI, Handler<AsyncResult<HttpClientResponse>> responseHandler)
port - the porthost - the hostrequestURI - the relative URIresponseHandler - the response handlerHttpClientRequest put(String host, String requestURI, Handler<AsyncResult<HttpClientResponse>> responseHandler)
host - the hostrequestURI - the relative URIresponseHandler - the response handlerHttpClientRequest put(String requestURI)
requestURI - the relative URIHttpClientRequest put(String requestURI, Handler<AsyncResult<HttpClientResponse>> responseHandler)
requestURI - the relative URIresponseHandler - the response handlerHttpClientRequest putAbs(String absoluteURI)
absoluteURI - the absolute URIHttpClientRequest putAbs(String absoluteURI, Handler<AsyncResult<HttpClientResponse>> responseHandler)
absoluteURI - the absolute URIresponseHandler - the response handlerHttpClientRequest delete(RequestOptions options)
options - the request optionsHttpClientRequest delete(int port, String host, String requestURI)
port - the porthost - the hostrequestURI - the relative URIHttpClientRequest delete(String host, String requestURI)
host - the hostrequestURI - the relative URIHttpClientRequest delete(RequestOptions options, Handler<AsyncResult<HttpClientResponse>> responseHandler)
options - the request optionsresponseHandler - the response handlerHttpClientRequest delete(int port, String host, String requestURI, Handler<AsyncResult<HttpClientResponse>> responseHandler)
port - the porthost - the hostrequestURI - the relative URIresponseHandler - the response handlerHttpClientRequest delete(String host, String requestURI, Handler<AsyncResult<HttpClientResponse>> responseHandler)
host - the hostrequestURI - the relative URIresponseHandler - the response handlerHttpClientRequest delete(String requestURI)
requestURI - the relative URIHttpClientRequest delete(String requestURI, Handler<AsyncResult<HttpClientResponse>> responseHandler)
requestURI - the relative URIresponseHandler - the response handlerHttpClientRequest deleteAbs(String absoluteURI)
absoluteURI - the absolute URIHttpClientRequest deleteAbs(String absoluteURI, Handler<AsyncResult<HttpClientResponse>> responseHandler)
absoluteURI - the absolute URIresponseHandler - the response handlervoid webSocket(int port,
String host,
String requestURI,
Handler<AsyncResult<WebSocket>> handler)
port - the porthost - the hostrequestURI - the relative URIhandler - handler that will be called with the websocket when connectedFuture<WebSocket> webSocket(int port, String host, String requestURI)
webSocket(int, String, String, Handler) but returns a Future of the asynchronous resultvoid webSocket(String host, String requestURI, Handler<AsyncResult<WebSocket>> handler)
host - the hostrequestURI - the relative URIhandler - handler that will be called with the websocket when connectedFuture<WebSocket> webSocket(String host, String requestURI)
webSocket(String, String, Handler) but returns a Future of the asynchronous resultvoid webSocket(String requestURI, Handler<AsyncResult<WebSocket>> handler)
requestURI - the relative URIhandler - handler that will be called with the websocket when connectedFuture<WebSocket> webSocket(String requestURI)
webSocket(String, Handler) but returns a Future of the asynchronous resultvoid webSocket(WebSocketConnectOptions options, Handler<AsyncResult<WebSocket>> handler)
options - the request optionsFuture<WebSocket> webSocket(WebSocketConnectOptions options)
webSocket(WebSocketConnectOptions, Handler) but returns a Future of the asynchronous resultvoid webSocketAbs(String url, MultiMap headers, WebsocketVersion version, List<String> subProtocols, Handler<AsyncResult<WebSocket>> handler)
url - the absolute urlheaders - the headersversion - the websocket versionsubProtocols - the subprotocols to usehandler - handler that will be called if websocket connection failsFuture<WebSocket> webSocketAbs(String url, MultiMap headers, WebsocketVersion version, List<String> subProtocols)
webSocketAbs(String, MultiMap, WebsocketVersion, List, Handler) but returns a Future of the asynchronous resultHttpClient connectionHandler(Handler<HttpConnection> handler)
HttpClient redirectHandler(java.util.function.Function<HttpClientResponse,Future<HttpClientRequest>> handler)
The redirect handler is called when a 3xx response is received and the request is configured to
follow redirects with HttpClientRequest.setFollowRedirects(boolean).
The redirect handler is passed the HttpClientResponse, it can return an HttpClientRequest or null.
Future<HttpClientRequest> is returned, the client will send this new request
The handler must return a Future<HttpClientRequest> unsent so the client can further configure it and send it.
handler - the new redirect handlerjava.util.function.Function<HttpClientResponse,Future<HttpClientRequest>> redirectHandler()
void close()
Copyright © 2019 Eclipse. All rights reserved.