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

Class AmazonCognitoAuth

java.lang.Object
io.vertx.mutiny.ext.auth.oauth2.providers.OpenIDConnectAuth
io.vertx.mutiny.ext.auth.oauth2.providers.AmazonCognitoAuth
All Implemented Interfaces:
MutinyDelegate
public class AmazonCognitoAuth extends OpenIDConnectAuth implements MutinyDelegate
Simplified factory to create an OAuth2Auth for Amazon Cognito.

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

Author:
Paulo Lopes
See Also:
  • AmazonCognitoAuth

  • Field Details

  • Constructor Details

    • AmazonCognitoAuth

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

    • AmazonCognitoAuth

      public AmazonCognitoAuth(Object delegate)

  • Method Details

    • getDelegate

      public io.vertx.ext.auth.oauth2.providers.AmazonCognitoAuth 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
      Overrides:
      getDelegate in class OpenIDConnectAuth
      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 default site in the configuration options and attempt to load the well known descriptor. If a site is provided (for example when running on a custom instance) that site will be used to do the lookup.

      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
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • AmazonCognitoAuth#discover(Vertx, OAuth2Options, Handler)
      • io.vertx.ext.auth.oauth2.providers.AmazonCognitoAuth#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 default site in the configuration options and attempt to load the well known descriptor. If a site is provided (for example when running on a custom instance) that site will be used to do the lookup.

      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
      Returns:
      The operation result
      See Also:
      • AmazonCognitoAuth#discover(Vertx, OAuth2Options, Handler)
      • io.vertx.ext.auth.oauth2.providers.AmazonCognitoAuth#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 default site in the configuration options and attempt to load the well known descriptor. If a site is provided (for example when running on a custom instance) that site will be used to do the lookup.

      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
      See Also:
      • AmazonCognitoAuth#discover(Vertx, OAuth2Options, Handler)
      • io.vertx.ext.auth.oauth2.providers.AmazonCognitoAuth#discover(Vertx, OAuth2Options)

    • create

      public static OAuth2Auth create(Vertx vertx, String region, String clientId, String clientSecret, String domain, String guid)
      Create a OAuth2Auth provider for Amazon Cognito
      Parameters:
      region - the region to use
      clientId - the client id given to you by Amazon Cognito
      clientSecret - the client secret given to you by Amazon Cognito
      domain - the Cognito domain
      guid - the guid of your application given to you by Amazon Cognito

    • create

      public static OAuth2Auth create(Vertx vertx, String region, String clientId, String clientSecret, String domain, String userPoolId, io.vertx.core.http.HttpClientOptions httpClientOptions)
      Create a OAuth2Auth provider for Amazon Cognito
      Parameters:
      region - the region to use
      clientId - the client id given to you by Amazon Cognito
      clientSecret - the client secret given to you by Amazon Cognito
      domain - the Cognito domain
      userPoolId - the userPoolId of your application given to you by Amazon Cognito
      httpClientOptions - custom http client options

    • newInstance

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class OpenIDConnectAuth

    • equals

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

    • toString

      public String toString()
      Overrides:
      toString in class OpenIDConnectAuth