Package io.vertx.mutiny.ext.auth.htdigest

Class HtdigestAuth

java.lang.Object
io.vertx.mutiny.ext.auth.authentication.AuthenticationProvider
io.vertx.mutiny.ext.auth.htdigest.HtdigestAuth
All Implemented Interfaces:
MutinyDelegate
public class HtdigestAuth extends AuthenticationProvider implements MutinyDelegate
An extension of AuthProvider which is using .htdigest file as store

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

Author:
Paulo Lopes
See Also:
  • HtdigestAuth

  • Field Details

    • HTDIGEST_FILE

      public static final String HTDIGEST_FILE
      The property name to be used to set the name of the collection inside the config
      See Also:

    • __TYPE_ARG

      public static final TypeArg<HtdigestAuth> __TYPE_ARG

  • Constructor Details

    • HtdigestAuth

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

    • HtdigestAuth

      public HtdigestAuth(Object delegate)

  • Method Details

    • getDelegate

      public io.vertx.ext.auth.htdigest.HtdigestAuth 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 AuthenticationProvider
      Returns:
      the delegate instance

    • authenticate

      @CheckReturnValue public io.smallrye.mutiny.Uni<User> authenticate(io.vertx.ext.auth.authentication.Credentials credentials)
      Authenticate a user.

      The first argument is a Credentials object containing information for authenticating the user. What this actually contains depends on the specific implementation.

      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.

      Overrides:
      authenticate in class AuthenticationProvider
      Parameters:
      credentials - The credentials
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • AuthenticationProvider.authenticate(Credentials)

    • authenticateAndAwait

      public User authenticateAndAwait(io.vertx.ext.auth.authentication.Credentials credentials)
      Authenticate a user.

      The first argument is a Credentials object containing information for authenticating the user. What this actually contains depends on the specific implementation.

      Unlike the bare Vert.x variant, this method returns a User. 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).

      Overrides:
      authenticateAndAwait in class AuthenticationProvider
      Parameters:
      credentials - The credentials
      Returns:
      The operation result
      See Also:
      • AuthenticationProvider.authenticate(Credentials)

    • authenticateAndForget

      public HtdigestAuth authenticateAndForget(io.vertx.ext.auth.authentication.Credentials credentials)
      Authenticate a user.

      The first argument is a Credentials object containing information for authenticating the user. What this actually contains depends on the specific implementation.

      Unlike the bare Vert.x variant, this method ignores the User result or any failure.

      Overrides:
      authenticateAndForget in class AuthenticationProvider
      Parameters:
      credentials - The credentials
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • AuthenticationProvider.authenticate(Credentials)

    • create

      public static HtdigestAuth create(Vertx vertx)
      Creates an instance of HtdigestAuth.
      Returns:
      the created instance of HtdigestAuths

    • create

      public static HtdigestAuth create(Vertx vertx, String htfile)
      Creates an instance of HtdigestAuth by using the given htfile file.
      Parameters:
      htfile - the existing htfile.
      Returns:
      the created instance of HtdigestAuths

    • realm

      public String realm()
      Return the currently used realm
      Returns:
      the realm

    • newInstance

      public static HtdigestAuth newInstance(io.vertx.ext.auth.htdigest.HtdigestAuth delegate)
      Creates a new instance of the HtdigestAuth.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class AuthenticationProvider

    • equals

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

    • toString

      public String toString()
      Overrides:
      toString in class AuthenticationProvider