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, AppleIdAuth, AzureADAuth, GoogleAuth, IBMCloudAuth, KeycloakAuth, SalesforceAuth, ZohoAuth
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.

Author:
Paulo Lopes
See Also:
  • OpenIDConnectAuth

  • Field Details

  • Constructor Details

    • OpenIDConnectAuth

      public OpenIDConnectAuth(io.vertx.ext.auth.oauth2.providers.OpenIDConnectAuth delegate)
      Create a new instance of OpenIDConnectAuth delegating to the given (non-null) instance of OpenIDConnectAuth.

    • OpenIDConnectAuth

      public OpenIDConnectAuth(Object delegate)

  • Method Details

    • getDelegate

      public io.vertx.ext.auth.oauth2.providers.OpenIDConnectAuth getDelegate()
      Get the delegate instance.

      This method returns the instance on which this shim is delegating the calls. And so, give you access to the bare API.

      Specified by:
      getDelegate in interface MutinyDelegate
      Returns:
      the delegate instance

    • 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. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

      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:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • io.vertx.ext.auth.oauth2.providers.OpenIDConnectAuth#discover(Vertx, OAuth2Options)

    • discoverAndAwait

      public static OAuth2Auth discoverAndAwait(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 OAuth2Auth. This method awaits indefinitely 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 operation result
      See Also:
      • io.vertx.ext.auth.oauth2.providers.OpenIDConnectAuth#discover(Vertx, OAuth2Options)

    • discoverAndForget

      public static void discoverAndForget(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 ignores the OAuth2Auth result or any failure.

      Parameters:
      vertx - the vertx instance
      config - the initial config, it should contain a site url
      See Also:
      • io.vertx.ext.auth.oauth2.providers.OpenIDConnectAuth#discover(Vertx, OAuth2Options)

    • newInstance

      public static OpenIDConnectAuth newInstance(io.vertx.ext.auth.oauth2.providers.OpenIDConnectAuth delegate)
      Creates a new instance of the OpenIDConnectAuth.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

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

    • toString

      public String toString()
      Overrides:
      toString in class Object