Package io.vertx.mutiny.ext.auth.oauth2.providers

Class OpenIDConnectAuth

java.lang.Object
io.vertx.mutiny.ext.auth.oauth2.providers.OpenIDConnectAuth
All Implemented Interfaces:
MutinyDelegate
Direct Known Subclasses:
AmazonCognitoAuth, AzureADAuth, GoogleAuth, IBMCloudAuth, KeycloakAuth, SalesforceAuth
public class OpenIDConnectAuth extends Object implements MutinyDelegate
Simplified factory to create an OAuth2Auth for OpenID Connect.

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

  • Field Details

  • Constructor Details

    • OpenIDConnectAuth

      public OpenIDConnectAuth(io.vertx.ext.auth.oauth2.providers.OpenIDConnectAuth delegate)

    • OpenIDConnectAuth

      public OpenIDConnectAuth(Object delegate)

  • Method Details

    • getDelegate

      public io.vertx.ext.auth.oauth2.providers.OpenIDConnectAuth getDelegate()
      Specified by:
      getDelegate in interface MutinyDelegate
      Returns:
      the delegate used by this Mutiny object of generated type

    • 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

    • discover

      @CheckReturnValue public static io.smallrye.mutiny.Uni<OAuth2Auth> discover(Vertx vertx, io.vertx.ext.auth.oauth2.OAuth2Options config)
      Create a OAuth2Auth provider for OpenID Connect Discovery. The discovery will use the given site in the configuration options and attempt to load the well known descriptor.

      If the discovered config includes a json web key url, it will be also fetched and the JWKs will be loaded into the OAuth provider so tokens can be decoded.

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

      Parameters:
      vertx - the vertx instance
      config - the initial config, it should contain a site url
      Returns:
      the uni firing the result of the operation when completed, or a failure if the operation failed.

    • discoverAndAwait

      public static OAuth2Auth discoverAndAwait(Vertx vertx, io.vertx.ext.auth.oauth2.OAuth2Options config)
      Blocking variant of discover(io.vertx.mutiny.core.Vertx,OAuth2Options).

      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:
      vertx - the vertx instance
      config - the initial config, it should contain a site url
      Returns:
      the OAuth2Auth instance produced by the operation.

    • discoverAndForget

      public static void discoverAndForget(Vertx vertx, io.vertx.ext.auth.oauth2.OAuth2Options config)
      Variant of discover(io.vertx.mutiny.core.Vertx,OAuth2Options) that ignores the result of the operation.

      This method subscribes on the result of discover(io.vertx.mutiny.core.Vertx,OAuth2Options), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation from discover(io.vertx.mutiny.core.Vertx,OAuth2Options) but you don't need to compose it with other operations.

      Parameters:
      vertx - the vertx instance
      config - the initial config, it should contain a site url

    • newInstance

      public static OpenIDConnectAuth newInstance(io.vertx.ext.auth.oauth2.providers.OpenIDConnectAuth arg)