Package io.vertx.mutiny.ext.web.handler

Class OtpAuthHandler

java.lang.Object
io.vertx.mutiny.ext.web.handler.OtpAuthHandler
All Implemented Interfaces:
MutinyDelegate, io.vertx.core.Handler<RoutingContext>, AuthenticationHandler, Consumer<RoutingContext>
public class OtpAuthHandler extends Object implements MutinyDelegate, AuthenticationHandler, io.vertx.core.Handler<RoutingContext>, Consumer<RoutingContext>
An auth handler that provides One Time Password (Multi-Factor) Authentication support.

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

  • Field Details

  • Constructor Details

    • OtpAuthHandler

      public OtpAuthHandler(io.vertx.ext.web.handler.OtpAuthHandler delegate)

    • OtpAuthHandler

      public OtpAuthHandler(Object delegate)

  • Method Details

    • getDelegate

      public io.vertx.ext.web.handler.OtpAuthHandler getDelegate()
      Specified by:
      getDelegate in interface AuthenticationHandler
      Specified by:
      getDelegate in interface MutinyDelegate
      Returns:
      the delegate used by this Mutiny object of generated type

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • equals

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • handle

      public void handle(RoutingContext arg0)
      Specified by:
      handle in interface AuthenticationHandler
      Specified by:
      handle in interface io.vertx.core.Handler<RoutingContext>

    • create

      public static OtpAuthHandler create(TotpAuth totpAuth)
      Parameters:
      totpAuth - the time based OTP provider.
      Returns:
      new instance of the handler.

    • create

      public static OtpAuthHandler create(HotpAuth hotpAuth)
      Parameters:
      hotpAuth - the hash based OTP provider.
      Returns:
      new instance of the handler.

    • verifyUrl

      public OtpAuthHandler verifyUrl(String url)
      Parameters:
      url - the location where users are to be asked for the OTP code.
      Returns:
      fluent self.

    • setupRegisterCallback

      public OtpAuthHandler setupRegisterCallback(Route route)
      Parameters:
      route - the location where users are to register new authenticator devices/apps.
      Returns:
      fluent self.

    • setupCallback

      public OtpAuthHandler setupCallback(Route route)
      Parameters:
      route - the location where users are to submit challenge responses from authenticator devices/apps.
      Returns:
      fluent self.

    • issuer

      public OtpAuthHandler issuer(String issuer)
      Parameters:
      issuer - a String for example Vert.x OTP
      Returns:
      fluent self.

    • label

      public OtpAuthHandler label(String label)
      Parameters:
      label - a String for example Vert.x OTP
      Returns:
      fluent self.

    • accept

      public void accept(RoutingContext item)
      Specified by:
      accept in interface AuthenticationHandler
      Specified by:
      accept in interface Consumer<RoutingContext>

    • newInstance

      public static OtpAuthHandler newInstance(io.vertx.ext.web.handler.OtpAuthHandler arg)