A B C D F G H I L M O P Q R S T U V W
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- addCachedMethod(HttpMethod) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
-
Add an HTTP method that is cacheable.
- addCachedStatusCode(Integer) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
-
Add a status code that is cacheable.
- addCrlPath(String) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
- addCrlPath(String) - Method in class io.vertx.ext.web.client.WebClientOptions
- addCrlValue(Buffer) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
- addCrlValue(Buffer) - Method in class io.vertx.ext.web.client.WebClientOptions
- addEnabledCipherSuite(String) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
- addEnabledCipherSuite(String) - Method in class io.vertx.ext.web.client.WebClientOptions
- addEnabledSecureTransportProtocol(String) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
- addEnabledSecureTransportProtocol(String) - Method in class io.vertx.ext.web.client.WebClientOptions
- addHeader(CharSequence, CharSequence) - Method in interface io.vertx.ext.web.client.WebClientSession
-
Configure the client to add an HTTP header to every request.
- addHeader(CharSequence, Iterable<CharSequence>) - Method in interface io.vertx.ext.web.client.WebClientSession
-
Configure the client to add an HTTP header to every request.
- addHeader(String, Iterable<String>) - Method in interface io.vertx.ext.web.client.WebClientSession
-
Configure the client to add an HTTP header to every request.
- addHeader(String, String) - Method in interface io.vertx.ext.web.client.WebClientSession
-
Configure the client to add an HTTP header to every request.
- addInterceptor(Handler<HttpContext<?>>) - Method in interface io.vertx.ext.web.client.OAuth2WebClient
- addInterceptor(Handler<HttpContext<?>>) - Method in interface io.vertx.ext.web.client.WebClient
-
Add interceptor in the chain.
- addInterceptor(Handler<HttpContext<?>>) - Method in interface io.vertx.ext.web.client.WebClientSession
- addNonProxyHost(String) - Method in class io.vertx.ext.web.client.WebClientOptions
- addQueryParam(String, String) - Method in interface io.vertx.ext.web.client.HttpRequest
-
Add a query parameter to the request.
- as(BodyCodec<U>) - Method in interface io.vertx.ext.web.client.HttpRequest
-
Configure the request to decode the response with the
responseCodec
. - authentication(Credentials) - Method in interface io.vertx.ext.web.client.HttpRequest
-
Configure the request to perform HTTP Authentication.
B
- basicAuthentication(Buffer, Buffer) - Method in interface io.vertx.ext.web.client.HttpRequest
-
Configure the request to perform basic access authentication.
- basicAuthentication(String, String) - Method in interface io.vertx.ext.web.client.HttpRequest
-
Configure the request to perform basic access authentication.
- bearerTokenAuthentication(String) - Method in interface io.vertx.ext.web.client.HttpRequest
-
Configure the request to perform bearer token authentication.
- body() - Method in interface io.vertx.ext.web.client.HttpResponse
- bodyAsBuffer() - Method in interface io.vertx.ext.web.client.HttpResponse
- bodyAsJson(Class<R>) - Method in interface io.vertx.ext.web.client.HttpResponse
- bodyAsJsonArray() - Method in interface io.vertx.ext.web.client.HttpResponse
- bodyAsJsonObject() - Method in interface io.vertx.ext.web.client.HttpResponse
- bodyAsString() - Method in interface io.vertx.ext.web.client.HttpResponse
- bodyAsString(String) - Method in interface io.vertx.ext.web.client.HttpResponse
- bodyCodec() - Method in interface io.vertx.ext.web.client.HttpRequest
- build() - Static method in interface io.vertx.ext.web.client.spi.CacheStore
-
Builds a no-op cache store.
- build() - Static method in interface io.vertx.ext.web.client.spi.CookieStore
-
Builds an in memory cookie store.
C
- CacheStore - Interface in io.vertx.ext.web.client.spi
-
An API to store and retrieve HTTP responses.
- CachingWebClient - Interface in io.vertx.ext.web.client
-
An asynchronous cache aware HTTP / HTTP/2 client called
CachingWebClient
. - CachingWebClientOptions - Class in io.vertx.ext.web.client
- CachingWebClientOptions() - Constructor for class io.vertx.ext.web.client.CachingWebClientOptions
- CachingWebClientOptions(boolean) - Constructor for class io.vertx.ext.web.client.CachingWebClientOptions
- CachingWebClientOptions(JsonObject) - Constructor for class io.vertx.ext.web.client.CachingWebClientOptions
- CachingWebClientOptions(WebClientOptions) - Constructor for class io.vertx.ext.web.client.CachingWebClientOptions
- CachingWebClientOptionsConverter - Class in io.vertx.ext.web.client
-
Converter and mapper for
CachingWebClientOptions
. - CachingWebClientOptionsConverter() - Constructor for class io.vertx.ext.web.client.CachingWebClientOptionsConverter
- close() - Method in interface io.vertx.ext.web.client.WebClient
-
Close the client.
- connectTimeout() - Method in interface io.vertx.ext.web.client.HttpRequest
- connectTimeout(long) - Method in interface io.vertx.ext.web.client.HttpRequest
-
Sets the amount of time after which, if the request is not obtained from the client within the timeout period, the response is failed with a
TimeoutException
. - cookieStore() - Method in interface io.vertx.ext.web.client.WebClientSession
-
Returns this client's
CookieStore
- CookieStore - Interface in io.vertx.ext.web.client.spi
-
A cookie store that manages cookies for a single user; received for different domains and valid for different paths.
- copy() - Method in interface io.vertx.ext.web.client.HttpRequest
-
Copy this request
- create(Vertx) - Static method in interface io.vertx.ext.web.client.WebClient
-
Create a web client using the provided
vertx
instance and default options. - create(Vertx, WebClientOptions) - Static method in interface io.vertx.ext.web.client.WebClient
-
Create a web client using the provided
vertx
instance and default pooling options. - create(Vertx, WebClientOptions, PoolOptions) - Static method in interface io.vertx.ext.web.client.WebClient
-
Create a web client using the provided
vertx
instance. - create(WebClient) - Static method in interface io.vertx.ext.web.client.CachingWebClient
-
Create a cache aware web client using the provided
WebClient
. - create(WebClient) - Static method in interface io.vertx.ext.web.client.WebClientSession
-
Create a session aware web client using the provided
webClient
instance. - create(WebClient, OAuth2Auth) - Static method in interface io.vertx.ext.web.client.OAuth2WebClient
-
Create a session aware web client using the provided
webClient
instance. - create(WebClient, OAuth2Auth, OAuth2WebClientOptions) - Static method in interface io.vertx.ext.web.client.OAuth2WebClient
-
Create a session aware web client using the provided
webClient
instance. - create(WebClient, CachingWebClientOptions) - Static method in interface io.vertx.ext.web.client.CachingWebClient
-
Create a cache aware web client using the provided
WebClient
. - create(WebClient, CacheStore) - Static method in interface io.vertx.ext.web.client.CachingWebClient
-
Create a cache aware web client using the provided
WebClient
. - create(WebClient, CacheStore, CachingWebClientOptions) - Static method in interface io.vertx.ext.web.client.CachingWebClient
-
Create a cache aware web client using the provided
WebClient
. - create(WebClient, CookieStore) - Static method in interface io.vertx.ext.web.client.WebClientSession
-
Create a session aware web client using the provided
webClient
instance.
D
- DEFAULT_CACHED_METHODS - Static variable in class io.vertx.ext.web.client.CachingWebClientOptions
- DEFAULT_CACHED_STATUS_CODES - Static variable in class io.vertx.ext.web.client.CachingWebClientOptions
- DEFAULT_EXPAND_OPTIONS - Static variable in class io.vertx.ext.web.client.WebClientOptions
- DEFAULT_FOLLOW_REDIRECTS - Static variable in class io.vertx.ext.web.client.WebClientOptions
-
The default value of whether the Web Client should follow redirects = true.
- DEFAULT_LEEWAY - Static variable in class io.vertx.ext.web.client.OAuth2WebClientOptions
-
The default leeway when validating token expiration times.
- DEFAULT_RENEW_TOKEN_ON_FORBIDDEN - Static variable in class io.vertx.ext.web.client.OAuth2WebClientOptions
-
The default value of whether to perform a single token refresh if the response status code is 401 (Forbidden).
- DEFAULT_USER_AGENT - Static variable in class io.vertx.ext.web.client.WebClientOptions
-
The default user agent string = Vert.x-WebClient/<version>.
- DEFAULT_USER_AGENT_ENABLED - Static variable in class io.vertx.ext.web.client.WebClientOptions
-
The default value of whether the Web Client should send a user agent header = true.
- delete(int, String, UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
-
Create an HTTP DELETE request to send to the server at the specified host and port.
- delete(int, String, String) - Method in interface io.vertx.ext.web.client.WebClient
-
Create an HTTP DELETE request to send to the server at the specified host and port.
- delete(CacheKey) - Method in interface io.vertx.ext.web.client.spi.CacheStore
-
Delete a key from the cache.
- delete(CacheKey, Handler<AsyncResult<Void>>) - Method in interface io.vertx.ext.web.client.spi.CacheStore
-
Delete all variations of a key from the cache.
- delete(UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
-
Create an HTTP DELETE request to send to the server at the default host and port.
- delete(String) - Method in interface io.vertx.ext.web.client.WebClient
-
Create an HTTP DELETE request to send to the server at the default host and port.
- delete(String, UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
-
Create an HTTP DELETE request to send to the server at the specified host and default port.
- delete(String, String) - Method in interface io.vertx.ext.web.client.WebClient
-
Create an HTTP DELETE request to send to the server at the specified host and default port.
- deleteAbs(UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
-
Create an HTTP DELETE request to send to the server using an absolute URI, specifying a response handler to receive the response
- deleteAbs(String) - Method in interface io.vertx.ext.web.client.WebClient
-
Create an HTTP DELETE request to send to the server using an absolute URI, specifying a response handler to receive the response
F
- flush() - Method in interface io.vertx.ext.web.client.spi.CacheStore
-
Delete all entries from the cache.
- flush(Handler<AsyncResult<Void>>) - Method in interface io.vertx.ext.web.client.spi.CacheStore
-
Delete all entries from the cache.
- followedRedirects() - Method in interface io.vertx.ext.web.client.HttpResponse
- followRedirects() - Method in interface io.vertx.ext.web.client.HttpRequest
- followRedirects(boolean) - Method in interface io.vertx.ext.web.client.HttpRequest
-
Set whether to follow request redirections
G
- get(int, String, UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
-
Create an HTTP GET request to send to the server at the specified host and port.
- get(int, String, String) - Method in interface io.vertx.ext.web.client.WebClient
-
Create an HTTP GET request to send to the server at the specified host and port.
- get(CacheKey) - Method in interface io.vertx.ext.web.client.spi.CacheStore
-
Retrieve a cached response.
- get(CacheKey, Handler<AsyncResult<CachedHttpResponse>>) - Method in interface io.vertx.ext.web.client.spi.CacheStore
-
Retrieve a cached response.
- get(UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
-
Create an HTTP GET request to send to the server at the default host and port.
- get(Boolean, String, String) - Method in interface io.vertx.ext.web.client.spi.CookieStore
-
Returns and
Iterable
of cookies satisfying the filters passed as paraemters. - get(String) - Method in interface io.vertx.ext.web.client.WebClient
-
Create an HTTP GET request to send to the server at the default host and port.
- get(String, UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
-
Create an HTTP GET request to send to the server at the specified host and default port.
- get(String, String) - Method in interface io.vertx.ext.web.client.WebClient
-
Create an HTTP GET request to send to the server at the specified host and default port.
- getAbs(UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
-
Create an HTTP GET request to send to the server using an absolute URI, specifying a response handler to receive the response
- getAbs(String) - Method in interface io.vertx.ext.web.client.WebClient
-
Create an HTTP GET request to send to the server using an absolute URI, specifying a response handler to receive the response
- getCachedMethods() - Method in class io.vertx.ext.web.client.CachingWebClientOptions
- getCachedStatusCodes() - Method in class io.vertx.ext.web.client.CachingWebClientOptions
- getLeeway() - Method in class io.vertx.ext.web.client.OAuth2WebClientOptions
-
Weather to allow leeway while validating if a token is considered expired.
- getTemplateExpandOptions() - Method in class io.vertx.ext.web.client.WebClientOptions
- getTrailer(String) - Method in interface io.vertx.ext.web.client.HttpResponse
-
Return the first trailer value with the specified name
- getUser() - Method in interface io.vertx.ext.web.client.OAuth2WebClient
-
Get the authenticated user (if any) that is associated with this client.
- getUserAgent() - Method in class io.vertx.ext.web.client.WebClientOptions
H
- head(int, String, UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
-
Create an HTTP HEAD request to send to the server at the specified host and port.
- head(int, String, String) - Method in interface io.vertx.ext.web.client.WebClient
-
Create an HTTP HEAD request to send to the server at the specified host and port.
- head(UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
-
Create an HTTP HEAD request to send to the server at the default host and port.
- head(String) - Method in interface io.vertx.ext.web.client.WebClient
-
Create an HTTP HEAD request to send to the server at the default host and port.
- head(String, UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
-
Create an HTTP HEAD request to send to the server at the specified host and default port.
- head(String, String) - Method in interface io.vertx.ext.web.client.WebClient
-
Create an HTTP HEAD request to send to the server at the specified host and default port.
- headAbs(UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
-
Create an HTTP HEAD request to send to the server using an absolute URI, specifying a response handler to receive the response
- headAbs(String) - Method in interface io.vertx.ext.web.client.WebClient
-
Create an HTTP HEAD request to send to the server using an absolute URI, specifying a response handler to receive the response
- headers() - Method in interface io.vertx.ext.web.client.HttpRequest
- host() - Method in interface io.vertx.ext.web.client.HttpRequest
- host(String) - Method in interface io.vertx.ext.web.client.HttpRequest
-
Configure the request to use a new host
value
. - HttpRequest<T> - Interface in io.vertx.ext.web.client
-
A client-side HTTP request.
- HttpResponse<T> - Interface in io.vertx.ext.web.client
-
An HTTP response.
I
- idleTimeout() - Method in interface io.vertx.ext.web.client.HttpRequest
- idleTimeout(long) - Method in interface io.vertx.ext.web.client.HttpRequest
-
Sets the amount of time after which, if the request does not return any data within the timeout period, the request/response is closed and the related futures are failed with a
TimeoutException
. - io.vertx.ext.web.client - package io.vertx.ext.web.client
- io.vertx.ext.web.client.spi - package io.vertx.ext.web.client.spi
- io.vertx.web.client - module io.vertx.web.client
- isFollowRedirects() - Method in class io.vertx.ext.web.client.WebClientOptions
- isRenewTokenOnForbidden() - Method in class io.vertx.ext.web.client.OAuth2WebClientOptions
-
Weather to refresh or not the current user token if a forbidden http status response is received.
- isUserAgentEnabled() - Method in class io.vertx.ext.web.client.WebClientOptions
- isVaryCachingEnabled() - Method in class io.vertx.ext.web.client.CachingWebClientOptions
L
- loadUserAgent() - Static method in class io.vertx.ext.web.client.WebClientOptions
- localStore() - Static method in interface io.vertx.ext.web.client.spi.CacheStore
-
Builds a cache store that uses a
ConcurrentHashMap
.
M
- method() - Method in interface io.vertx.ext.web.client.HttpRequest
- method(HttpMethod) - Method in interface io.vertx.ext.web.client.HttpRequest
-
Configure the request to use a new method
value
. - multipartMixed() - Method in interface io.vertx.ext.web.client.HttpRequest
- multipartMixed(boolean) - Method in interface io.vertx.ext.web.client.HttpRequest
-
Allow or disallow multipart mixed encoding when sending
MultipartForm
having files sharing the same file name.
O
- OAuth2WebClient - Interface in io.vertx.ext.web.client
-
An asynchronous OAuth2/OIDC aware HTTP / HTTP/2 client called
WebClientOAuth2
. - OAuth2WebClientOptions - Class in io.vertx.ext.web.client
- OAuth2WebClientOptions() - Constructor for class io.vertx.ext.web.client.OAuth2WebClientOptions
- OAuth2WebClientOptions(JsonObject) - Constructor for class io.vertx.ext.web.client.OAuth2WebClientOptions
-
Creates a new instance from JSON.
- OAuth2WebClientOptions(OAuth2WebClientOptions) - Constructor for class io.vertx.ext.web.client.OAuth2WebClientOptions
-
Copy constructor.
- OAuth2WebClientOptionsConverter - Class in io.vertx.ext.web.client
-
Converter and mapper for
OAuth2WebClientOptions
. - OAuth2WebClientOptionsConverter() - Constructor for class io.vertx.ext.web.client.OAuth2WebClientOptionsConverter
P
- patch(int, String, UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
-
Create an HTTP PATCH request to send to the server at the specified host and port.
- patch(int, String, String) - Method in interface io.vertx.ext.web.client.WebClient
-
Create an HTTP PATCH request to send to the server at the specified host and port.
- patch(UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
-
Create an HTTP PATCH request to send to the server at the default host and port.
- patch(String) - Method in interface io.vertx.ext.web.client.WebClient
-
Create an HTTP PATCH request to send to the server at the default host and port.
- patch(String, UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
-
Create an HTTP PATCH request to send to the server at the specified host and default port.
- patch(String, String) - Method in interface io.vertx.ext.web.client.WebClient
-
Create an HTTP PATCH request to send to the server at the specified host and default port.
- patchAbs(UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
-
Create an HTTP PATCH request to send to the server using an absolute URI, specifying a response handler to receive the response
- patchAbs(String) - Method in interface io.vertx.ext.web.client.WebClient
-
Create an HTTP PATCH request to send to the server using an absolute URI, specifying a response handler to receive the response
- port() - Method in interface io.vertx.ext.web.client.HttpRequest
- port(int) - Method in interface io.vertx.ext.web.client.HttpRequest
-
Configure the request to use a new port
value
. - post(int, String, UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
-
Create an HTTP POST request to send to the server at the specified host and port.
- post(int, String, String) - Method in interface io.vertx.ext.web.client.WebClient
-
Create an HTTP POST request to send to the server at the specified host and port.
- post(UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
-
Create an HTTP POST request to send to the server at the default host and port.
- post(String) - Method in interface io.vertx.ext.web.client.WebClient
-
Create an HTTP POST request to send to the server at the default host and port.
- post(String, UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
-
Create an HTTP POST request to send to the server at the specified host and default port.
- post(String, String) - Method in interface io.vertx.ext.web.client.WebClient
-
Create an HTTP POST request to send to the server at the specified host and default port.
- postAbs(UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
-
Create an HTTP POST request to send to the server using an absolute URI, specifying a response handler to receive the response
- postAbs(String) - Method in interface io.vertx.ext.web.client.WebClient
-
Create an HTTP POST request to send to the server using an absolute URI, specifying a response handler to receive the response
- proxy() - Method in interface io.vertx.ext.web.client.HttpRequest
- proxy(ProxyOptions) - Method in interface io.vertx.ext.web.client.HttpRequest
-
Configure the request to set a proxy for this request.
- put(int, String, UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
-
Create an HTTP PUT request to send to the server at the specified host and port.
- put(int, String, String) - Method in interface io.vertx.ext.web.client.WebClient
-
Create an HTTP PUT request to send to the server at the specified host and port.
- put(Cookie) - Method in interface io.vertx.ext.web.client.spi.CookieStore
-
Add a cookie to this
CookieStore
. - put(UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
-
Create an HTTP PUT request to send to the server at the default host and port.
- put(String) - Method in interface io.vertx.ext.web.client.WebClient
-
Create an HTTP PUT request to send to the server at the default host and port.
- put(String, UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
-
Create an HTTP PUT request to send to the server at the specified host and default port.
- put(String, String) - Method in interface io.vertx.ext.web.client.WebClient
-
Create an HTTP PUT request to send to the server at the specified host and default port.
- putAbs(UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
-
Create an HTTP PUT request to send to the server using an absolute URI, specifying a response handler to receive the response
- putAbs(String) - Method in interface io.vertx.ext.web.client.WebClient
-
Create an HTTP PUT request to send to the server using an absolute URI, specifying a response handler to receive the response
- putHeader(String, Iterable<String>) - Method in interface io.vertx.ext.web.client.HttpRequest
-
Configure the request to set a new HTTP header with multiple values.
- putHeader(String, String) - Method in interface io.vertx.ext.web.client.HttpRequest
-
Configure the request to set a new HTTP header.
- putHeaders(MultiMap) - Method in interface io.vertx.ext.web.client.HttpRequest
-
Configure the request to add multiple HTTP headers .
Q
- queryParams() - Method in interface io.vertx.ext.web.client.HttpRequest
-
Return the current query parameters.
R
- remove(Cookie) - Method in interface io.vertx.ext.web.client.spi.CookieStore
-
Removes a previously added cookie.
- removeCachedMethod(HttpMethod) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
-
Remove an HTTP method that is cacheable.
- removeCachedStatusCode(Integer) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
-
Remove a status code that is cacheable.
- removeEnabledSecureTransportProtocol(String) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
- removeEnabledSecureTransportProtocol(String) - Method in class io.vertx.ext.web.client.WebClientOptions
- removeHeader(CharSequence) - Method in interface io.vertx.ext.web.client.WebClientSession
-
Removes a previously added header.
- removeHeader(String) - Method in interface io.vertx.ext.web.client.WebClientSession
-
Removes a previously added header.
- request(HttpMethod, int, String, UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
-
Create an HTTP request to send to the server at the specified host and port.
- request(HttpMethod, int, String, String) - Method in interface io.vertx.ext.web.client.WebClient
-
Create an HTTP request to send to the server at the specified host and port.
- request(HttpMethod, RequestOptions) - Method in interface io.vertx.ext.web.client.WebClient
-
Create an HTTP request to send to the server at the specified host and port.
- request(HttpMethod, SocketAddress, int, String, UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
-
Like
WebClient.request(HttpMethod, int, String, UriTemplate)
using theserverAddress
parameter to connect to the server instead of theport
andhost
parameters. - request(HttpMethod, SocketAddress, int, String, String) - Method in interface io.vertx.ext.web.client.WebClient
-
Like
WebClient.request(HttpMethod, int, String, String)
using theserverAddress
parameter to connect to the server instead of theport
andhost
parameters. - request(HttpMethod, SocketAddress, RequestOptions) - Method in interface io.vertx.ext.web.client.WebClient
-
Like
WebClient.request(HttpMethod, RequestOptions)
using theserverAddress
parameter to connect to the server instead of theoptions
parameter. - request(HttpMethod, SocketAddress, UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
-
Like
WebClient.request(HttpMethod, UriTemplate)
using theserverAddress
parameter to connect to the server instead of the default port and default host. - request(HttpMethod, SocketAddress, String) - Method in interface io.vertx.ext.web.client.WebClient
-
Like
WebClient.request(HttpMethod, String)
using theserverAddress
parameter to connect to the server instead of the default port and default host. - request(HttpMethod, SocketAddress, String, UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
-
Like
WebClient.request(HttpMethod, String, UriTemplate)
using theserverAddress
parameter to connect to the server instead of the default port andhost
parameter. - request(HttpMethod, SocketAddress, String, String) - Method in interface io.vertx.ext.web.client.WebClient
-
Like
WebClient.request(HttpMethod, String, String)
using theserverAddress
parameter to connect to the server instead of the default port andhost
parameter. - request(HttpMethod, UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
-
Create an HTTP request to send to the server at the default host and port.
- request(HttpMethod, String) - Method in interface io.vertx.ext.web.client.WebClient
-
Create an HTTP request to send to the server at the default host and port.
- request(HttpMethod, String, UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
-
Create an HTTP request to send to the server at the specified host and default port.
- request(HttpMethod, String, String) - Method in interface io.vertx.ext.web.client.WebClient
-
Create an HTTP request to send to the server at the specified host and default port.
- requestAbs(HttpMethod, SocketAddress, UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
-
Like
WebClient.requestAbs(HttpMethod, UriTemplate)
using theserverAddress
parameter to connect to the server instead of theabsoluteURI
parameter. - requestAbs(HttpMethod, SocketAddress, String) - Method in interface io.vertx.ext.web.client.WebClient
-
Like
WebClient.requestAbs(HttpMethod, String)
using theserverAddress
parameter to connect to the server instead of theabsoluteURI
parameter. - requestAbs(HttpMethod, UriTemplate) - Method in interface io.vertx.ext.web.client.WebClient
-
Create an HTTP request to send to the server using an absolute URI
- requestAbs(HttpMethod, String) - Method in interface io.vertx.ext.web.client.WebClient
-
Create an HTTP request to send to the server using an absolute URI
- routingKey() - Method in interface io.vertx.ext.web.client.HttpRequest
-
Return the routing key, the routing key can be used by a Vert.x client side sticky load balancer to pin the request to a remote HTTP server.
- routingKey(String) - Method in interface io.vertx.ext.web.client.HttpRequest
-
Set the routing key, the routing key can be used by a Vert.x client side sticky load balancer to pin the request to a remote HTTP server.
S
- send() - Method in interface io.vertx.ext.web.client.HttpRequest
-
Send a request, the
handler
will receive the response as anHttpResponse
. - sendBuffer(Buffer) - Method in interface io.vertx.ext.web.client.HttpRequest
-
Like
HttpRequest.send()
but with an HTTP requestbody
buffer. - sendForm(MultiMap) - Method in interface io.vertx.ext.web.client.HttpRequest
-
Like
HttpRequest.send()
but with an HTTP requestbody
multimap encoded as form and the content type set toapplication/x-www-form-urlencoded
. - sendForm(MultiMap, String) - Method in interface io.vertx.ext.web.client.HttpRequest
-
Like
HttpRequest.send()
but with an HTTP requestbody
multimap encoded as form and the content type set toapplication/x-www-form-urlencoded
. - sendJson(Object) - Method in interface io.vertx.ext.web.client.HttpRequest
-
Like
HttpRequest.send()
but with an HTTP requestbody
object encoded as json and the content type set toapplication/json
. - sendJsonObject(JsonObject) - Method in interface io.vertx.ext.web.client.HttpRequest
-
Like
HttpRequest.send()
but with an HTTP requestbody
object encoded as json and the content type set toapplication/json
. - sendMultipartForm(MultipartForm) - Method in interface io.vertx.ext.web.client.HttpRequest
-
Like
HttpRequest.send()
but with an HTTP requestbody
multimap encoded as form and the content type set tomultipart/form-data
. - sendStream(ReadStream<Buffer>) - Method in interface io.vertx.ext.web.client.HttpRequest
-
Like
HttpRequest.send()
but with an HTTP requestbody
stream. - set(CacheKey, CachedHttpResponse) - Method in interface io.vertx.ext.web.client.spi.CacheStore
-
Add a response in the cache with the given key.
- set(CacheKey, CachedHttpResponse, Handler<AsyncResult<CachedHttpResponse>>) - Method in interface io.vertx.ext.web.client.spi.CacheStore
-
Add a response in the cache with the given key.
- setAlpnVersions(List<HttpVersion>) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
- setAlpnVersions(List<HttpVersion>) - Method in class io.vertx.ext.web.client.WebClientOptions
- setCachedMethods(Set<HttpMethod>) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
-
Configure the HTTP methods that can be cached.
- setCachedStatusCodes(Set<Integer>) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
-
Configure the status codes that can be cached.
- setConnectTimeout(int) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
- setConnectTimeout(int) - Method in class io.vertx.ext.web.client.WebClientOptions
- setDecoderInitialBufferSize(int) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
- setDecoderInitialBufferSize(int) - Method in class io.vertx.ext.web.client.WebClientOptions
- setDecompressionSupported(boolean) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
- setDecompressionSupported(boolean) - Method in class io.vertx.ext.web.client.WebClientOptions
- setDefaultHost(String) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
- setDefaultHost(String) - Method in class io.vertx.ext.web.client.WebClientOptions
- setDefaultPort(int) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
- setDefaultPort(int) - Method in class io.vertx.ext.web.client.WebClientOptions
- setEnabledSecureTransportProtocols(Set<String>) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
- setEnabledSecureTransportProtocols(Set<String>) - Method in class io.vertx.ext.web.client.WebClientOptions
- setEnableVaryCaching(boolean) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
-
Configure the client cache behavior for
Vary
responses. - setFollowRedirects(boolean) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
- setFollowRedirects(boolean) - Method in class io.vertx.ext.web.client.WebClientOptions
-
Configure the default behavior of the client to follow HTTP
30x
redirections. - setForceSni(boolean) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
- setForceSni(boolean) - Method in class io.vertx.ext.web.client.WebClientOptions
- setHttp2ClearTextUpgrade(boolean) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
- setHttp2ClearTextUpgrade(boolean) - Method in class io.vertx.ext.web.client.WebClientOptions
- setHttp2ConnectionWindowSize(int) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
- setHttp2ConnectionWindowSize(int) - Method in class io.vertx.ext.web.client.WebClientOptions
- setHttp2KeepAliveTimeout(int) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
- setHttp2KeepAliveTimeout(int) - Method in class io.vertx.ext.web.client.WebClientOptions
- setHttp2MultiplexingLimit(int) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
- setHttp2MultiplexingLimit(int) - Method in class io.vertx.ext.web.client.WebClientOptions
- setIdleTimeout(int) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
- setIdleTimeout(int) - Method in class io.vertx.ext.web.client.WebClientOptions
- setIdleTimeoutUnit(TimeUnit) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
- setIdleTimeoutUnit(TimeUnit) - Method in class io.vertx.ext.web.client.WebClientOptions
- setInitialSettings(Http2Settings) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
- setInitialSettings(Http2Settings) - Method in class io.vertx.ext.web.client.WebClientOptions
- setKeepAlive(boolean) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
- setKeepAlive(boolean) - Method in class io.vertx.ext.web.client.WebClientOptions
- setKeepAliveTimeout(int) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
- setKeepAliveTimeout(int) - Method in class io.vertx.ext.web.client.WebClientOptions
- setKeyCertOptions(KeyCertOptions) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
- setKeyCertOptions(KeyCertOptions) - Method in class io.vertx.ext.web.client.WebClientOptions
- setLeeway(int) - Method in class io.vertx.ext.web.client.OAuth2WebClientOptions
-
Set a default leeway in seconds to be considered while validating tokens for expiration.
- setLocalAddress(String) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
- setLocalAddress(String) - Method in class io.vertx.ext.web.client.WebClientOptions
- setLogActivity(boolean) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
- setLogActivity(boolean) - Method in class io.vertx.ext.web.client.WebClientOptions
- setMaxChunkSize(int) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
- setMaxChunkSize(int) - Method in class io.vertx.ext.web.client.WebClientOptions
- setMaxHeaderSize(int) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
- setMaxHeaderSize(int) - Method in class io.vertx.ext.web.client.WebClientOptions
- setMaxInitialLineLength(int) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
- setMaxInitialLineLength(int) - Method in class io.vertx.ext.web.client.WebClientOptions
- setMaxRedirects(int) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
- setMaxRedirects(int) - Method in class io.vertx.ext.web.client.WebClientOptions
- setMetricsName(String) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
- setMetricsName(String) - Method in class io.vertx.ext.web.client.WebClientOptions
- setName(String) - Method in class io.vertx.ext.web.client.WebClientOptions
- setNonProxyHosts(List<String>) - Method in class io.vertx.ext.web.client.WebClientOptions
- setPipelining(boolean) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
- setPipelining(boolean) - Method in class io.vertx.ext.web.client.WebClientOptions
- setPipeliningLimit(int) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
- setPipeliningLimit(int) - Method in class io.vertx.ext.web.client.WebClientOptions
- setProtocolVersion(HttpVersion) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
- setProtocolVersion(HttpVersion) - Method in class io.vertx.ext.web.client.WebClientOptions
- setProxyOptions(ProxyOptions) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
- setProxyOptions(ProxyOptions) - Method in class io.vertx.ext.web.client.WebClientOptions
- setQueryParam(String, String) - Method in interface io.vertx.ext.web.client.HttpRequest
-
Set a query parameter to the request.
- setReadIdleTimeout(int) - Method in class io.vertx.ext.web.client.WebClientOptions
- setReceiveBufferSize(int) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
- setReceiveBufferSize(int) - Method in class io.vertx.ext.web.client.WebClientOptions
- setRenewTokenOnForbidden(boolean) - Method in class io.vertx.ext.web.client.OAuth2WebClientOptions
-
Set a default behavior on how to handle the first forbidden response.
- setReuseAddress(boolean) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
- setReuseAddress(boolean) - Method in class io.vertx.ext.web.client.WebClientOptions
- setReusePort(boolean) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
- setReusePort(boolean) - Method in class io.vertx.ext.web.client.WebClientOptions
- setSendBufferSize(int) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
- setSendBufferSize(int) - Method in class io.vertx.ext.web.client.WebClientOptions
- setShared(boolean) - Method in class io.vertx.ext.web.client.WebClientOptions
- setSoLinger(int) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
- setSoLinger(int) - Method in class io.vertx.ext.web.client.WebClientOptions
- setSsl(boolean) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
- setSsl(boolean) - Method in class io.vertx.ext.web.client.WebClientOptions
- setSslEngineOptions(SSLEngineOptions) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
- setSslEngineOptions(SSLEngineOptions) - Method in class io.vertx.ext.web.client.WebClientOptions
- setSslHandshakeTimeout(long) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
- setSslHandshakeTimeout(long) - Method in class io.vertx.ext.web.client.WebClientOptions
- setSslHandshakeTimeoutUnit(TimeUnit) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
- setSslHandshakeTimeoutUnit(TimeUnit) - Method in class io.vertx.ext.web.client.WebClientOptions
- setTcpCork(boolean) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
- setTcpCork(boolean) - Method in class io.vertx.ext.web.client.WebClientOptions
- setTcpFastOpen(boolean) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
- setTcpFastOpen(boolean) - Method in class io.vertx.ext.web.client.WebClientOptions
- setTcpKeepAlive(boolean) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
- setTcpKeepAlive(boolean) - Method in class io.vertx.ext.web.client.WebClientOptions
- setTcpNoDelay(boolean) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
- setTcpNoDelay(boolean) - Method in class io.vertx.ext.web.client.WebClientOptions
- setTcpQuickAck(boolean) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
- setTcpQuickAck(boolean) - Method in class io.vertx.ext.web.client.WebClientOptions
- setTemplateExpandOptions(ExpandOptions) - Method in class io.vertx.ext.web.client.WebClientOptions
- setTemplateParam(String, String) - Method in interface io.vertx.ext.web.client.HttpRequest
-
Set a request URI template string parameter to the request, expanded when the request URI is a
UriTemplate
. - setTemplateParam(String, List<String>) - Method in interface io.vertx.ext.web.client.HttpRequest
-
Set a request URI template list parameter to the request, expanded when the request URI is a
UriTemplate
. - setTemplateParam(String, Map<String, String>) - Method in interface io.vertx.ext.web.client.HttpRequest
-
Set a request URI template map parameter to the request, expanded when the request URI is a
UriTemplate
. - setTracingPolicy(TracingPolicy) - Method in class io.vertx.ext.web.client.WebClientOptions
- setTrafficClass(int) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
- setTrafficClass(int) - Method in class io.vertx.ext.web.client.WebClientOptions
- setTrustAll(boolean) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
- setTrustAll(boolean) - Method in class io.vertx.ext.web.client.WebClientOptions
- setTrustOptions(TrustOptions) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
- setTrustOptions(TrustOptions) - Method in class io.vertx.ext.web.client.WebClientOptions
- setUseAlpn(boolean) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
- setUseAlpn(boolean) - Method in class io.vertx.ext.web.client.WebClientOptions
- setUserAgent(String) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
- setUserAgent(String) - Method in class io.vertx.ext.web.client.WebClientOptions
-
Sets the Web Client user agent header.
- setUserAgentEnabled(boolean) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
- setUserAgentEnabled(boolean) - Method in class io.vertx.ext.web.client.WebClientOptions
-
Sets whether the Web Client should send a user agent header.
- setVerifyHost(boolean) - Method in class io.vertx.ext.web.client.CachingWebClientOptions
- setVerifyHost(boolean) - Method in class io.vertx.ext.web.client.WebClientOptions
- setWriteIdleTimeout(int) - Method in class io.vertx.ext.web.client.WebClientOptions
- sharedDataStore(Vertx) - Static method in interface io.vertx.ext.web.client.spi.CacheStore
-
Builds a cache store that uses an
AsyncMap
fromSharedData
. - ssl() - Method in interface io.vertx.ext.web.client.HttpRequest
- ssl(Boolean) - Method in interface io.vertx.ext.web.client.HttpRequest
-
Configure the request whether to use SSL.
T
- templateParams() - Method in interface io.vertx.ext.web.client.HttpRequest
-
Return the current request URI template parameters.
- timeout() - Method in interface io.vertx.ext.web.client.HttpRequest
- timeout(long) - Method in interface io.vertx.ext.web.client.HttpRequest
-
Configures the amount of time in milliseconds after which if the request does not return any data within the timeout period an
TimeoutException
fails the request. - toJson() - Method in class io.vertx.ext.web.client.CachingWebClientOptions
-
Convert to JSON
- toJson() - Method in class io.vertx.ext.web.client.OAuth2WebClientOptions
-
Convert to JSON
- toJson() - Method in class io.vertx.ext.web.client.WebClientOptions
-
Convert to JSON
- traceOperation() - Method in interface io.vertx.ext.web.client.HttpRequest
- traceOperation(String) - Method in interface io.vertx.ext.web.client.HttpRequest
-
Trace operation name override.
- trailers() - Method in interface io.vertx.ext.web.client.HttpResponse
U
- updateSSLOptions(ClientSSLOptions) - Method in interface io.vertx.ext.web.client.WebClient
-
Update the client with new SSL
options
, the update happens if the options object is valid and different from the existing options object. - updateSSLOptions(ClientSSLOptions, boolean) - Method in interface io.vertx.ext.web.client.WebClient
-
Update the client with new SSL
options
, the update happens if the options object is valid and different from the existing options object. - uri() - Method in interface io.vertx.ext.web.client.HttpRequest
- uri(String) - Method in interface io.vertx.ext.web.client.HttpRequest
-
Configure the request to use a new request URI
value
.
V
- virtualHost() - Method in interface io.vertx.ext.web.client.HttpRequest
- virtualHost(String) - Method in interface io.vertx.ext.web.client.HttpRequest
-
Configure the request to use a virtual host
value
.
W
- WebClient - Interface in io.vertx.ext.web.client
-
An asynchronous HTTP / HTTP/2 client called
WebClient
. - WebClientOptions - Class in io.vertx.ext.web.client
- WebClientOptions() - Constructor for class io.vertx.ext.web.client.WebClientOptions
- WebClientOptions(HttpClientOptions) - Constructor for class io.vertx.ext.web.client.WebClientOptions
-
Copy constructor using
HttpClientOptions
. - WebClientOptions(JsonObject) - Constructor for class io.vertx.ext.web.client.WebClientOptions
-
Creates a new instance from JSON.
- WebClientOptions(WebClientOptions) - Constructor for class io.vertx.ext.web.client.WebClientOptions
-
Copy constructor.
- WebClientOptionsConverter - Class in io.vertx.ext.web.client
-
Converter and mapper for
WebClientOptions
. - WebClientOptionsConverter() - Constructor for class io.vertx.ext.web.client.WebClientOptionsConverter
- WebClientSession - Interface in io.vertx.ext.web.client
-
An asynchronous sessions aware HTTP / HTTP/2 client called
WebClientSession
. - withCredentials(Credentials) - Method in interface io.vertx.ext.web.client.OAuth2WebClient
-
Mark that request should be dispatched with authentication obtained from passed
OAuth2Auth
provider - wrap(HttpClient) - Static method in interface io.vertx.ext.web.client.WebClient
-
Wrap an
httpClient
with a web client and default options. - wrap(HttpClient, WebClientOptions) - Static method in interface io.vertx.ext.web.client.WebClient
-
Wrap an
httpClient
with a web client and default options.
All Classes All Packages