Package io.vertx.mutiny.ext.auth.otp.hotp

Class HotpAuth

  • public class HotpAuth
extends AuthenticationProvider
    An extension of AuthProvider which uses the one time passwords based on counter to perform authentication.

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

    • Constructor Detail

      • HotpAuth

        public HotpAuth​(io.vertx.ext.auth.otp.hotp.HotpAuth delegate)

      • HotpAuth

        public HotpAuth​(Object delegate)

    • Method Detail

      • authenticatorFetcher

        public HotpAuth authenticatorFetcher​(Function<String,​io.smallrye.mutiny.Uni<io.vertx.ext.auth.otp.Authenticator>> fetcher)
        Parameters:
        fetcher - fetcher function.
        Returns:
        fluent self.

      • authenticatorUpdater

        public HotpAuth authenticatorUpdater​(Function<io.vertx.ext.auth.otp.Authenticator,​io.smallrye.mutiny.Uni<Void>> updater)
        Parameters:
        updater - updater function.
        Returns:
        fluent self.

      • createAuthenticator

        @CheckReturnValue
public io.smallrye.mutiny.Uni<io.vertx.ext.auth.otp.Authenticator> createAuthenticator​(String id,
                                                                                       io.vertx.ext.auth.otp.OtpKey otpKey)
        Creating authenticator from user id and key.

        Unlike the bare Vert.x variant, this method returns a Uni. Don't forget to subscribe on it to trigger the operation.

        Parameters:
        id - id user.
        otpKey - key of user used for auth.
        Returns:
        the uni firing the result of the operation when completed, or a failure if the operation failed.

      • createAuthenticatorAndAwait

        public io.vertx.ext.auth.otp.Authenticator createAuthenticatorAndAwait​(String id,
                                                                       io.vertx.ext.auth.otp.OtpKey otpKey)
        Blocking variant of createAuthenticator(String,OtpKey).

        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:
        id - id user.
        otpKey - key of user used for auth.
        Returns:
        the Authenticator instance produced by the operation.

      • createAuthenticatorAndForget

        public void createAuthenticatorAndForget​(String id,
                                         io.vertx.ext.auth.otp.OtpKey otpKey)
        Variant of createAuthenticator(String,OtpKey) that ignores the result of the operation.

        This method subscribes on the result of createAuthenticator(String,OtpKey), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation from createAuthenticator(String,OtpKey) but you don't need to compose it with other operations.

        Parameters:
        id - id user.
        otpKey - key of user used for auth.

      • generateUri

        public String generateUri​(io.vertx.ext.auth.otp.OtpKey otpKey,
                          String issuer,
                          String user,
                          String label)
        Parameters:
        otpKey - user key.
        issuer - issuer of key.
        user - display name of user account.
        label - the label to identify which account a key is associated with.
        Returns:
        uri containing the key.

      • generateUri

        public String generateUri​(io.vertx.ext.auth.otp.OtpKey otpKey,
                          String issuer,
                          String user)
        Parameters:
        otpKey - user key.
        issuer - issuer of key.
        user - display name of user account.
        Returns:
        uri containing the key.

      • generateUri

        public String generateUri​(io.vertx.ext.auth.otp.OtpKey otpKey,
                          String label)
        Parameters:
        otpKey - user key.
        label - the label to identify which account a key is associated with.
        Returns:
        uri containing the key.

      • create

        public static HotpAuth create()
        Returns:
        the created instance of HotpAuth.

      • create

        public static HotpAuth create​(io.vertx.ext.auth.otp.hotp.HotpAuthOptions hotpAuthOptions)
        Parameters:
        hotpAuthOptions - the config.
        Returns:
        the created instance of HotpAuth.

      • newInstance

        public static HotpAuth newInstance​(io.vertx.ext.auth.otp.hotp.HotpAuth arg)