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

Class AppleIdAuth

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

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

Author:
Paulo Lopes
See Also:
  • AppleIdAuth

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final TypeArg<AppleIdAuth>
    __TYPE_ARG
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    AppleIdAuth(io.vertx.ext.auth.oauth2.providers.AppleIdAuth delegate)
    Create a new instance of AppleIdAuth delegating to the given (non-null) instance of AppleIdAuth.
    AppleIdAuth(Object delegate)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static OAuth2Auth
    create(Vertx vertx, String clientId, String teamId, io.vertx.ext.auth.PubSecKeyOptions privateKey)
    Create a OAuth2Auth provider for Apple
    static OAuth2Auth
    create(Vertx vertx, String clientId, String teamId, io.vertx.ext.auth.PubSecKeyOptions privateKey, io.vertx.core.http.HttpClientOptions httpClientOptions)
    Create a OAuth2Auth provider for Apple
    static io.smallrye.mutiny.Uni<OAuth2Auth>
    discover(Vertx vertx, io.vertx.ext.auth.PubSecKeyOptions privateKey, io.vertx.ext.auth.oauth2.OAuth2Options config)
    Create a OAuth2Auth provider for OpenID Connect Discovery.
    static OAuth2Auth
    discoverAndAwait(Vertx vertx, io.vertx.ext.auth.PubSecKeyOptions privateKey, io.vertx.ext.auth.oauth2.OAuth2Options config)
    Create a OAuth2Auth provider for OpenID Connect Discovery.
    static void
    discoverAndForget(Vertx vertx, io.vertx.ext.auth.PubSecKeyOptions privateKey, io.vertx.ext.auth.oauth2.OAuth2Options config)
    Create a OAuth2Auth provider for OpenID Connect Discovery.
    boolean
    equals(Object o)
     
    io.vertx.ext.auth.oauth2.providers.AppleIdAuth
    getDelegate()
    Get the delegate instance.
    int
    hashCode()
     
    static AppleIdAuth
    newInstance(io.vertx.ext.auth.oauth2.providers.AppleIdAuth delegate)
    Creates a new instance of the AppleIdAuth.
    String
    toString()
     

    Methods inherited from class io.vertx.mutiny.ext.auth.oauth2.providers.OpenIDConnectAuth

    discover, discoverAndAwait, discoverAndForget, newInstance

    Methods inherited from class java.lang.Object

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

  • Field Details

  • Constructor Details

    • AppleIdAuth

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

    • AppleIdAuth

      public AppleIdAuth(Object delegate)

  • Method Details

    • getDelegate

      public io.vertx.ext.auth.oauth2.providers.AppleIdAuth 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.PubSecKeyOptions privateKey, 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:
      • io.vertx.ext.auth.oauth2.providers.AppleIdAuth#discover(Vertx, PubSecKeyOptions, OAuth2Options)

    • discoverAndAwait

      public static OAuth2Auth discoverAndAwait(Vertx vertx, io.vertx.ext.auth.PubSecKeyOptions privateKey, 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:
      • io.vertx.ext.auth.oauth2.providers.AppleIdAuth#discover(Vertx, PubSecKeyOptions, OAuth2Options)

    • discoverAndForget

      public static void discoverAndForget(Vertx vertx, io.vertx.ext.auth.PubSecKeyOptions privateKey, 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:
      • io.vertx.ext.auth.oauth2.providers.AppleIdAuth#discover(Vertx, PubSecKeyOptions, OAuth2Options)

    • create

      public static OAuth2Auth create(Vertx vertx, String clientId, String teamId, io.vertx.ext.auth.PubSecKeyOptions privateKey)
      Create a OAuth2Auth provider for Apple
      Parameters:
      clientId - the client id given to you by Apple
      teamId - the team id given to you by Apple
      privateKey - The private key for the client. This is the private key you generated when creating the

    • create

      public static OAuth2Auth create(Vertx vertx, String clientId, String teamId, io.vertx.ext.auth.PubSecKeyOptions privateKey, io.vertx.core.http.HttpClientOptions httpClientOptions)
      Create a OAuth2Auth provider for Apple
      Parameters:
      clientId - Client ID (also known as the Services ID in Apple's Developer Portal).
      teamId - Team ID for the Apple Developer Account found on top right corner of the developers page
      privateKey - The private key for the client. This is the private key you generated when creating the App id. With the identifier for the private key at Apple
      httpClientOptions - custom http client options

    • newInstance

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

    • 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