io.vertx.rxjava3.ext.web.client

## Class OAuth2WebClient

- java.lang.Object
- - io.vertx.rxjava3.ext.web.client.WebClient
  - - io.vertx.rxjava3.ext.web.client.OAuth2WebClient

-     public class OAuth2WebClient
      extends WebClient

  An asynchronous OAuth2/OIDC aware HTTP / HTTP/2 client called `WebClientOAuth2`.

  This client wraps a `WebClient` and makes it session aware adding features to it:

  - Request an `access_token` if no user is created
  - Refresh `access_token` if current user is expired

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

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static io.vertx.lang.rx.TypeArg<OAuth2WebClient>` | `__TYPE_ARG`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `OAuth2WebClient(OAuth2WebClient delegate)`
    `OAuth2WebClient(Object delegate)`

  - ### Method Summary

    All Methods Static Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `static OAuth2WebClient` | `create(WebClient webClient, OAuth2Auth oAuth2Auth)` Create a session aware web client using the provided `webClient` instance.
    `static OAuth2WebClient` | `create(WebClient webClient, OAuth2Auth oAuth2Auth, OAuth2WebClientOptions options)` Create a session aware web client using the provided `webClient` instance.
    `boolean` | `equals(Object o)`
    `OAuth2WebClient` | `getDelegate()`
    `User` | `getUser()` Get the authenticated user (if any) that is associated with this client.
    `int` | `hashCode()`
    `static OAuth2WebClient` | `newInstance(OAuth2WebClient arg)`
    `String` | `toString()`
    `OAuth2WebClient` | `withCredentials(Credentials credentials)` Mark that request should be dispatched with authentication obtained from passed `OAuth2Auth` provider

    - ### Methods inherited from class io.vertx.rxjava3.ext.web.client.WebClient

      `close, create, create, delete, delete, delete, delete, delete, delete, deleteAbs, deleteAbs, get, get, get, get, get, get, getAbs, getAbs, head, head, head, head, head, head, headAbs, headAbs, newInstance, patch, patch, patch, patch, patch, patch, patchAbs, patchAbs, post, post, post, post, post, post, postAbs, postAbs, put, put, put, put, put, put, putAbs, putAbs, request, request, request, request, request, request, request, request, request, request, request, request, request, request, requestAbs, requestAbs, requestAbs, requestAbs, wrap, wrap`

    - ### Methods inherited from class java.lang.Object

      `clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

- - ### Field Detail

    - #### __TYPE_ARG

          public static final io.vertx.lang.rx.TypeArg<OAuth2WebClient> __TYPE_ARG

  - ### Constructor Detail

    - #### OAuth2WebClient

          public OAuth2WebClient(OAuth2WebClient delegate)

    - #### OAuth2WebClient

          public OAuth2WebClient(Object delegate)

  - ### Method Detail

    - #### toString

          public String toString()

      Overrides:
        `toString` in class `WebClient`

    - #### equals

          public boolean equals(Object o)

      Overrides:
        `equals` in class `WebClient`

    - #### hashCode

          public int hashCode()

      Overrides:
        `hashCode` in class `WebClient`

    - #### getDelegate

          public OAuth2WebClient getDelegate()

      Overrides:
        `getDelegate` in class `WebClient`

    - #### create

          public static OAuth2WebClient create(WebClient webClient,
                                               OAuth2Auth oAuth2Auth)

      Create a session aware web client using the provided `webClient` instance.
      Parameters:
        `webClient` - the web client instance
        `oAuth2Auth` - Configured oAuth2Auth provider to be used when `withCredentials(io.vertx.ext.auth.authentication.Credentials)` used
      Returns:
        the created client

    - #### create

          public static OAuth2WebClient create(WebClient webClient,
                                               OAuth2Auth oAuth2Auth,
                                               OAuth2WebClientOptions options)

      Create a session aware web client using the provided `webClient` instance.
      Parameters:
        `webClient` - the web client instance
        `oAuth2Auth` - Configured oAuth2Auth provider to be used when `withCredentials(io.vertx.ext.auth.authentication.Credentials)` used
        `options` - extra configuration for this object
      Returns:
        the created client

    - #### getUser

          public User getUser()

      Get the authenticated user (if any) that is associated with this client.
      Returns:
        the current user associated with this client or null if no user is associated

    - #### withCredentials

          public OAuth2WebClient withCredentials(Credentials credentials)

      Mark that request should be dispatched with authentication obtained from passed `OAuth2Auth` provider
      Parameters:
        `credentials` -
      Returns:
        a reference to this, so the API can be used fluently

    - #### newInstance

          public static OAuth2WebClient newInstance(OAuth2WebClient arg)

Copyright © 2024 Eclipse. All rights reserved.