Package io.vertx.mutiny.ext.auth.authentication

Class AuthenticationProvider

java.lang.Object
io.vertx.mutiny.ext.auth.authentication.AuthenticationProvider
All Implemented Interfaces:
MutinyDelegate
Direct Known Subclasses:
ChainAuth, HotpAuth, HtdigestAuth, HtpasswdAuth, JWTAuth, LdapAuthentication, MongoAuthentication, OAuth2Auth, PropertyFileAuthentication, SqlAuthentication, TotpAuth, WebAuthn4J
public class AuthenticationProvider extends Object implements MutinyDelegate
User-facing interface for authenticating users.

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

Author:
Tim Fox
See Also:
  • AuthenticationProvider

  • Field Details

  • Constructor Details

    • AuthenticationProvider

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

    • AuthenticationProvider

      public AuthenticationProvider(Object delegate)

  • Method Details

    • getDelegate

      public io.vertx.ext.auth.authentication.AuthenticationProvider 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
      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.

      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).

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

    • authenticateAndForget

      public AuthenticationProvider 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.

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

    • newInstance

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

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

    • toString

      public String toString()
      Overrides:
      toString in class Object