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

Class ZohoAuth

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

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

Author:
Paulo Lopes
See Also:
  • ZohoAuth

  • Field Details

  • Constructor Details

    • ZohoAuth

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

    • ZohoAuth

      public ZohoAuth(Object delegate)

  • Method Details

    • getDelegate

      public io.vertx.ext.auth.oauth2.providers.ZohoAuth 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, String soid, 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
      soid - the soid of your application given to you by Zoho
      config - the initial config
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • io.vertx.ext.auth.oauth2.providers.ZohoAuth#discover(Vertx, String, OAuth2Options)

    • discoverAndAwait

      public static OAuth2Auth discoverAndAwait(Vertx vertx, String soid, 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
      soid - the soid of your application given to you by Zoho
      config - the initial config
      Returns:
      The operation result
      See Also:
      • io.vertx.ext.auth.oauth2.providers.ZohoAuth#discover(Vertx, String, OAuth2Options)

    • discoverAndForget

      public static void discoverAndForget(Vertx vertx, String soid, 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
      soid - the soid of your application given to you by Zoho
      config - the initial config
      See Also:
      • io.vertx.ext.auth.oauth2.providers.ZohoAuth#discover(Vertx, String, OAuth2Options)

    • discover

      @CheckReturnValue public static io.smallrye.mutiny.Uni<OAuth2Auth> discover(Vertx vertx, String dc, String soid, 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
      dc - the data center to use (e.g. "com", "eu", "in", "us")
      soid - the soid of your application given to you by Zoho
      config - the initial config
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • io.vertx.ext.auth.oauth2.providers.ZohoAuth#discover(Vertx, String, String, OAuth2Options)

    • discoverAndAwait

      public static OAuth2Auth discoverAndAwait(Vertx vertx, String dc, String soid, 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
      dc - the data center to use (e.g. "com", "eu", "in", "us")
      soid - the soid of your application given to you by Zoho
      config - the initial config
      Returns:
      The operation result
      See Also:
      • io.vertx.ext.auth.oauth2.providers.ZohoAuth#discover(Vertx, String, String, OAuth2Options)

    • discoverAndForget

      public static void discoverAndForget(Vertx vertx, String dc, String soid, 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
      dc - the data center to use (e.g. "com", "eu", "in", "us")
      soid - the soid of your application given to you by Zoho
      config - the initial config
      See Also:
      • io.vertx.ext.auth.oauth2.providers.ZohoAuth#discover(Vertx, String, String, OAuth2Options)

    • create

      public static OAuth2Auth create(Vertx vertx, String clientId, String clientSecret, String soid)
      Create a OAuth2Auth provider for Zoho (default DC)
      Parameters:
      clientId - the client id given to you by Zoho
      clientSecret - the client secret given to you by Zoho

    • create

      public static OAuth2Auth create(Vertx vertx, String dc, String clientId, String clientSecret, String soid, io.vertx.core.http.HttpClientOptions httpClientOptions)
      Create a OAuth2Auth provider for Zoho
      Parameters:
      dc - the data center to use (e.g. "com", "eu", "in", "us")
      clientId - the client id given to you by Zoho
      clientSecret - the client secret given to you by Zoho
      soid - the soid of your application given to you by Zoho
      httpClientOptions - custom http client options

    • newInstance

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

    • 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