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

Class AzureADAuth

java.lang.Object
io.vertx.mutiny.ext.auth.oauth2.providers.OpenIDConnectAuth
io.vertx.mutiny.ext.auth.oauth2.providers.AzureADAuth
All Implemented Interfaces:
MutinyDelegate
public class AzureADAuth extends OpenIDConnectAuth implements MutinyDelegate
Simplified factory to create an for Azure AD.

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

  • Field Details

  • Constructor Details

    • AzureADAuth

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

    • AzureADAuth

      public AzureADAuth(Object delegate)

  • Method Details

    • getDelegate

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

    • toString

      public String toString()
      Overrides:
      toString in class OpenIDConnectAuth

    • equals

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class OpenIDConnectAuth

    • create

      public static OAuth2Auth create(Vertx vertx, String clientId, String clientSecret, String guid)
      Parameters:
      vertx -
      clientId - the client id given to you by Azure
      clientSecret - the client secret given to you by Azure
      guid - the guid of your application given to you by Azure
      Returns:

    • create

      public static OAuth2Auth create(Vertx vertx, String clientId, String clientSecret, String guid, io.vertx.core.http.HttpClientOptions httpClientOptions)
      Parameters:
      vertx -
      clientId - the client id given to you by Azure
      clientSecret - the client secret given to you by Azure
      guid - the guid of your application given to you by Azure
      httpClientOptions - custom http client options
      Returns:

    • 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.

      With this provider, if the given configuration is using the flow type then the extra parameters object will include requested_token_use = on_behalf_of as required by https://docs.microsoft.com/en-us/azure/active-directory.

      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
      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
      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

    • newInstance

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