Module io.smallrye.mutiny.vertx.web.client
Package io.vertx.mutiny.ext.web.client

Class WebClient

java.lang.Object
io.vertx.mutiny.ext.web.client.WebClient
All Implemented Interfaces:
io.smallrye.mutiny.vertx.MutinyDelegate
Direct Known Subclasses:
OAuth2WebClient, WebClientSession
public class WebClient extends Object implements io.smallrye.mutiny.vertx.MutinyDelegate
An asynchronous HTTP / HTTP/2 client called WebClient.

The web client makes easy to do HTTP request/response interactions with a web server, and provides advanced features like:

  • Json body encoding / decoding
  • request/response pumping
  • error handling

The web client does not deprecate the , it is actually based on it and therefore inherits its configuration and great features like pooling. The HttpClient should be used when fine grained control over the HTTP requests/response is necessary.

NOTE: This class has been automatically generated from the original non Mutiny-ified interface using Vert.x codegen.

  • Field Details

    • __TYPE_ARG

      public static final io.smallrye.mutiny.vertx.TypeArg<WebClient> __TYPE_ARG

  • Constructor Details

    • WebClient

      public WebClient(io.vertx.ext.web.client.WebClient delegate)

    • WebClient

      public WebClient(Object delegate)

  • Method Details

    • getDelegate

      public io.vertx.ext.web.client.WebClient getDelegate()
      Specified by:
      getDelegate in interface io.smallrye.mutiny.vertx.MutinyDelegate

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • create

      public static WebClient create(io.vertx.mutiny.core.Vertx vertx)
      Parameters:
      vertx - the vertx instance
      Returns:
      the created web client

    • create

      public static WebClient create(io.vertx.mutiny.core.Vertx vertx, io.vertx.ext.web.client.WebClientOptions options)
      Parameters:
      vertx - the vertx instance
      options - the Web Client options
      Returns:
      the created web client

    • wrap

      public static WebClient wrap(io.vertx.mutiny.core.http.HttpClient httpClient)
      Parameters:
      httpClient - the to wrap
      Returns:
      the web client

    • wrap

      public static WebClient wrap(io.vertx.mutiny.core.http.HttpClient httpClient, io.vertx.ext.web.client.WebClientOptions options)
      Parameters:
      httpClient - the to wrap
      options - the Web Client options
      Returns:
      the web client

    • request

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> request(io.vertx.core.http.HttpMethod method, int port, String host, String requestURI)
      Parameters:
      method - the HTTP method
      port - the port
      host - the host
      requestURI - the request URI
      Returns:
      an HTTP client request object

    • request

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> request(io.vertx.core.http.HttpMethod method, int port, String host, io.vertx.mutiny.uritemplate.UriTemplate requestURI)
      Parameters:
      method - the HTTP method
      port - the port
      host - the host
      requestURI - the request URI as a
      Returns:
      an HTTP client request object

    • request

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> request(io.vertx.core.http.HttpMethod method, io.vertx.mutiny.core.net.SocketAddress serverAddress, int port, String host, String requestURI)
      Parameters:
      method -
      serverAddress -
      port -
      host -
      requestURI -
      Returns:

    • request

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> request(io.vertx.core.http.HttpMethod method, io.vertx.mutiny.core.net.SocketAddress serverAddress, int port, String host, io.vertx.mutiny.uritemplate.UriTemplate requestURI)
      Parameters:
      method -
      serverAddress -
      port -
      host -
      requestURI -
      Returns:

    • request

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> request(io.vertx.core.http.HttpMethod method, String host, String requestURI)
      Parameters:
      method - the HTTP method
      host - the host
      requestURI - the request URI
      Returns:
      an HTTP client request object

    • request

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> request(io.vertx.core.http.HttpMethod method, String host, io.vertx.mutiny.uritemplate.UriTemplate requestURI)
      Parameters:
      method - the HTTP method
      host - the host
      requestURI - the request URI as a
      Returns:
      an HTTP client request object

    • request

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> request(io.vertx.core.http.HttpMethod method, io.vertx.mutiny.core.net.SocketAddress serverAddress, String host, String requestURI)
      Parameters:
      method -
      serverAddress -
      host -
      requestURI -
      Returns:

    • request

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> request(io.vertx.core.http.HttpMethod method, io.vertx.mutiny.core.net.SocketAddress serverAddress, String host, io.vertx.mutiny.uritemplate.UriTemplate requestURI)
      Parameters:
      method -
      serverAddress -
      host -
      requestURI -
      Returns:

    • request

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> request(io.vertx.core.http.HttpMethod method, String requestURI)
      Parameters:
      method - the HTTP method
      requestURI - the request URI
      Returns:
      an HTTP client request object

    • request

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> request(io.vertx.core.http.HttpMethod method, io.vertx.mutiny.uritemplate.UriTemplate requestURI)
      Parameters:
      method - the HTTP method
      requestURI - the request URI as a
      Returns:
      an HTTP client request object

    • request

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> request(io.vertx.core.http.HttpMethod method, io.vertx.mutiny.core.net.SocketAddress serverAddress, String requestURI)
      Parameters:
      method -
      serverAddress -
      requestURI -
      Returns:

    • request

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> request(io.vertx.core.http.HttpMethod method, io.vertx.mutiny.core.net.SocketAddress serverAddress, io.vertx.mutiny.uritemplate.UriTemplate requestURI)
      Parameters:
      method -
      serverAddress -
      requestURI -
      Returns:

    • request

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> request(io.vertx.core.http.HttpMethod method, io.vertx.core.http.RequestOptions options)
      Parameters:
      method - the HTTP method
      options - the request options
      Returns:
      an HTTP client request object

    • request

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> request(io.vertx.core.http.HttpMethod method, io.vertx.mutiny.core.net.SocketAddress serverAddress, io.vertx.core.http.RequestOptions options)
      Parameters:
      method -
      serverAddress -
      options -
      Returns:

    • requestAbs

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> requestAbs(io.vertx.core.http.HttpMethod method, String absoluteURI)
      Parameters:
      method - the HTTP method
      absoluteURI - the absolute URI
      Returns:
      an HTTP client request object

    • requestAbs

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> requestAbs(io.vertx.core.http.HttpMethod method, io.vertx.mutiny.uritemplate.UriTemplate absoluteURI)
      Parameters:
      method - the HTTP method
      absoluteURI - the absolute URI as a
      Returns:
      an HTTP client request object

    • requestAbs

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> requestAbs(io.vertx.core.http.HttpMethod method, io.vertx.mutiny.core.net.SocketAddress serverAddress, String absoluteURI)
      Parameters:
      method -
      serverAddress -
      absoluteURI -
      Returns:

    • requestAbs

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> requestAbs(io.vertx.core.http.HttpMethod method, io.vertx.mutiny.core.net.SocketAddress serverAddress, io.vertx.mutiny.uritemplate.UriTemplate absoluteURI)
      Parameters:
      method -
      serverAddress -
      absoluteURI -
      Returns:

    • get

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> get(String requestURI)
      Parameters:
      requestURI - the request URI
      Returns:
      an HTTP client request object

    • get

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> get(io.vertx.mutiny.uritemplate.UriTemplate requestURI)
      Parameters:
      requestURI - the request URI as a
      Returns:
      an HTTP client request object

    • get

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> get(int port, String host, String requestURI)
      Parameters:
      port - the port
      host - the host
      requestURI - the request URI
      Returns:
      an HTTP client request object

    • get

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> get(int port, String host, io.vertx.mutiny.uritemplate.UriTemplate requestURI)
      Parameters:
      port - the port
      host - the host
      requestURI - the request URI as a
      Returns:
      an HTTP client request object

    • get

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> get(String host, String requestURI)
      Parameters:
      host - the host
      requestURI - the request URI
      Returns:
      an HTTP client request object

    • get

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> get(String host, io.vertx.mutiny.uritemplate.UriTemplate requestURI)
      Parameters:
      host - the host
      requestURI - the request URI as a
      Returns:
      an HTTP client request object

    • getAbs

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> getAbs(String absoluteURI)
      Parameters:
      absoluteURI - the absolute URI
      Returns:
      an HTTP client request object

    • getAbs

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> getAbs(io.vertx.mutiny.uritemplate.UriTemplate absoluteURI)
      Parameters:
      absoluteURI - the absolute URI as a
      Returns:
      an HTTP client request object

    • post

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> post(String requestURI)
      Parameters:
      requestURI - the request URI
      Returns:
      an HTTP client request object

    • post

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> post(io.vertx.mutiny.uritemplate.UriTemplate requestURI)
      Parameters:
      requestURI - the request URI as a
      Returns:
      an HTTP client request object

    • post

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> post(int port, String host, String requestURI)
      Parameters:
      port - the port
      host - the host
      requestURI - the request URI
      Returns:
      an HTTP client request object

    • post

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> post(int port, String host, io.vertx.mutiny.uritemplate.UriTemplate requestURI)
      Parameters:
      port - the port
      host - the host
      requestURI - the request URI as a
      Returns:
      an HTTP client request object

    • post

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> post(String host, String requestURI)
      Parameters:
      host - the host
      requestURI - the request URI
      Returns:
      an HTTP client request object

    • post

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> post(String host, io.vertx.mutiny.uritemplate.UriTemplate requestURI)
      Parameters:
      host - the host
      requestURI - the request URI as a
      Returns:
      an HTTP client request object

    • postAbs

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> postAbs(String absoluteURI)
      Parameters:
      absoluteURI - the absolute URI
      Returns:
      an HTTP client request object

    • postAbs

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> postAbs(io.vertx.mutiny.uritemplate.UriTemplate absoluteURI)
      Parameters:
      absoluteURI - the absoluate URI as a
      Returns:
      an HTTP client request object

    • put

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> put(String requestURI)
      Parameters:
      requestURI - the request URI
      Returns:
      an HTTP client request object

    • put

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> put(io.vertx.mutiny.uritemplate.UriTemplate requestURI)
      Parameters:
      requestURI - the request URI as a
      Returns:
      an HTTP client request object

    • put

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> put(int port, String host, String requestURI)
      Parameters:
      port - the port
      host - the host
      requestURI - the request URI
      Returns:
      an HTTP client request object

    • put

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> put(int port, String host, io.vertx.mutiny.uritemplate.UriTemplate requestURI)
      Parameters:
      port - the port
      host - the host
      requestURI - the request URI as a
      Returns:
      an HTTP client request object

    • put

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> put(String host, String requestURI)
      Parameters:
      host - the host
      requestURI - the request URI
      Returns:
      an HTTP client request object

    • put

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> put(String host, io.vertx.mutiny.uritemplate.UriTemplate requestURI)
      Parameters:
      host - the host
      requestURI - the request URI as a
      Returns:
      an HTTP client request object

    • putAbs

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> putAbs(String absoluteURI)
      Parameters:
      absoluteURI - the absolute URI
      Returns:
      an HTTP client request object

    • putAbs

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> putAbs(io.vertx.mutiny.uritemplate.UriTemplate absoluteURI)
      Parameters:
      absoluteURI - the absolute URI as a
      Returns:
      an HTTP client request object

    • delete

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> delete(String requestURI)
      Parameters:
      requestURI - the request URI
      Returns:
      an HTTP client request object

    • delete

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> delete(io.vertx.mutiny.uritemplate.UriTemplate requestURI)
      Parameters:
      requestURI - the request URI as a
      Returns:
      an HTTP client request object

    • delete

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> delete(int port, String host, String requestURI)
      Parameters:
      port - the port
      host - the host
      requestURI - the request URI
      Returns:
      an HTTP client request object

    • delete

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> delete(int port, String host, io.vertx.mutiny.uritemplate.UriTemplate requestURI)
      Parameters:
      port - the port
      host - the host
      requestURI - the request URI as a
      Returns:
      an HTTP client request object

    • delete

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> delete(String host, String requestURI)
      Parameters:
      host - the host
      requestURI - the request URI
      Returns:
      an HTTP client request object

    • delete

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> delete(String host, io.vertx.mutiny.uritemplate.UriTemplate requestURI)
      Parameters:
      host - the host
      requestURI - the request URI as a
      Returns:
      an HTTP client request object

    • deleteAbs

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> deleteAbs(String absoluteURI)
      Parameters:
      absoluteURI - the absolute URI
      Returns:
      an HTTP client request object

    • deleteAbs

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> deleteAbs(io.vertx.mutiny.uritemplate.UriTemplate absoluteURI)
      Parameters:
      absoluteURI - the absolute URI as a
      Returns:
      an HTTP client request object

    • patch

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> patch(String requestURI)
      Parameters:
      requestURI - the request URI
      Returns:
      an HTTP client request object

    • patch

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> patch(io.vertx.mutiny.uritemplate.UriTemplate requestURI)
      Parameters:
      requestURI - the request URI as a
      Returns:
      an HTTP client request object

    • patch

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> patch(int port, String host, String requestURI)
      Parameters:
      port - the port
      host - the host
      requestURI - the request URI
      Returns:
      an HTTP client request object

    • patch

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> patch(int port, String host, io.vertx.mutiny.uritemplate.UriTemplate requestURI)
      Parameters:
      port - the port
      host - the host
      requestURI - the request URI as a
      Returns:
      an HTTP client request object

    • patch

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> patch(String host, String requestURI)
      Parameters:
      host - the host
      requestURI - the request URI
      Returns:
      an HTTP client request object

    • patch

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> patch(String host, io.vertx.mutiny.uritemplate.UriTemplate requestURI)
      Parameters:
      host - the host
      requestURI - the request URI as a
      Returns:
      an HTTP client request object

    • patchAbs

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> patchAbs(String absoluteURI)
      Parameters:
      absoluteURI - the absolute URI
      Returns:
      an HTTP client request object

    • patchAbs

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> patchAbs(io.vertx.mutiny.uritemplate.UriTemplate absoluteURI)
      Parameters:
      absoluteURI - the absolute URI as a
      Returns:
      an HTTP client request object

    • head

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> head(String requestURI)
      Parameters:
      requestURI - the request URI
      Returns:
      an HTTP client request object

    • head

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> head(io.vertx.mutiny.uritemplate.UriTemplate requestURI)
      Parameters:
      requestURI - the request URI as a
      Returns:
      an HTTP client request object

    • head

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> head(int port, String host, String requestURI)
      Parameters:
      port - the port
      host - the host
      requestURI - the request URI
      Returns:
      an HTTP client request object

    • head

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> head(int port, String host, io.vertx.mutiny.uritemplate.UriTemplate requestURI)
      Parameters:
      port - the port
      host - the host
      requestURI - the request URI as a
      Returns:
      an HTTP client request object

    • head

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> head(String host, String requestURI)
      Parameters:
      host - the host
      requestURI - the request URI
      Returns:
      an HTTP client request object

    • head

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> head(String host, io.vertx.mutiny.uritemplate.UriTemplate requestURI)
      Parameters:
      host - the host
      requestURI - the request URI as a
      Returns:
      an HTTP client request object

    • headAbs

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> headAbs(String absoluteURI)
      Parameters:
      absoluteURI - the absolute URI
      Returns:
      an HTTP client request object

    • headAbs

      public HttpRequest<io.vertx.mutiny.core.buffer.Buffer> headAbs(io.vertx.mutiny.uritemplate.UriTemplate absoluteURI)
      Parameters:
      absoluteURI - the absolute URI as a
      Returns:
      an HTTP client request object

    • updateSSLOptions

      @CheckReturnValue public io.smallrye.mutiny.Uni<Boolean> updateSSLOptions(io.vertx.core.net.SSLOptions options)
      Like updateSSLOptions(io.vertx.core.net.SSLOptions) but supplying a handler that will be called when the update happened (or has failed).

      Unlike the bare Vert.x variant, this method returns a Uni. Don't forget to subscribe on it to trigger the operation.

      Parameters:
      options - the new SSL options
      Returns:
      the uni firing the result of the operation when completed, or a failure if the operation failed.

    • updateSSLOptionsAndAwait

      public Boolean updateSSLOptionsAndAwait(io.vertx.core.net.SSLOptions options)
      Blocking variant of updateSSLOptions(SSLOptions).

      This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

      Parameters:
      options - the new SSL options
      Returns:
      the Boolean instance produced by the operation.

    • updateSSLOptionsAndForget

      public void updateSSLOptionsAndForget(io.vertx.core.net.SSLOptions options)
      Variant of updateSSLOptions(SSLOptions) that ignores the result of the operation.

      This method subscribes on the result of updateSSLOptions(SSLOptions), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation from updateSSLOptions(SSLOptions) but you don't need to compose it with other operations.

      Parameters:
      options - the new SSL options

    • updateSSLOptions

      @CheckReturnValue public io.smallrye.mutiny.Uni<Boolean> updateSSLOptions(io.vertx.core.net.SSLOptions options, boolean force)
      Like updateSSLOptions(io.vertx.core.net.SSLOptions) but supplying a handler that will be called when the update happened (or has failed).

      Unlike the bare Vert.x variant, this method returns a Uni. Don't forget to subscribe on it to trigger the operation.

      Parameters:
      options - the new SSL options
      force - force the update when options are equals
      Returns:
      the uni firing the result of the operation when completed, or a failure if the operation failed.

    • updateSSLOptionsAndAwait

      public Boolean updateSSLOptionsAndAwait(io.vertx.core.net.SSLOptions options, boolean force)
      Blocking variant of updateSSLOptions(SSLOptions,boolean).

      This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

      Parameters:
      options - the new SSL options
      force - force the update when options are equals
      Returns:
      the Boolean instance produced by the operation.

    • updateSSLOptionsAndForget

      public void updateSSLOptionsAndForget(io.vertx.core.net.SSLOptions options, boolean force)
      Variant of updateSSLOptions(SSLOptions,boolean) that ignores the result of the operation.

      This method subscribes on the result of updateSSLOptions(SSLOptions,boolean), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation from updateSSLOptions(SSLOptions,boolean) but you don't need to compose it with other operations.

      Parameters:
      options - the new SSL options
      force - force the update when options are equals

    • close

      public void close()

    • newInstance

      public static WebClient newInstance(io.vertx.ext.web.client.WebClient arg)