Package io.vertx.mutiny.ext.auth.jwt

Class JWTAuth

java.lang.Object
io.vertx.mutiny.ext.auth.authentication.AuthenticationProvider
io.vertx.mutiny.ext.auth.jwt.JWTAuth
All Implemented Interfaces:
MutinyDelegate
public class JWTAuth extends AuthenticationProvider implements MutinyDelegate
Factory interface for creating JWT based AuthenticationProvider instances.

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

Author:
Paulo Lopes
See Also:
  • JWTAuth

  • Field Details

  • Constructor Details

    • JWTAuth

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

    • JWTAuth

      public JWTAuth(Object delegate)

  • Method Details

    • getDelegate

      public io.vertx.ext.auth.jwt.JWTAuth 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 JWTAuth 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 JWTAuth create(Vertx vertx, io.vertx.ext.auth.jwt.JWTAuthOptions config)
      Create a JWT auth provider
      Parameters:
      vertx - the Vertx instance
      config - the config
      Returns:
      the auth provider

    • generateToken

      public String generateToken(io.vertx.core.json.JsonObject claims, io.vertx.ext.auth.JWTOptions options)
      Generate a new JWT token.
      Parameters:
      claims - Json with user defined claims for a list of official claims
      options - extra options for the generation
      Returns:
      JWT encoded token
      See Also:

    • generateToken

      public String generateToken(io.vertx.core.json.JsonObject claims)
      Generate a new JWT token.
      Parameters:
      claims - Json with user defined claims for a list of official claims
      Returns:
      JWT encoded token
      See Also:

    • newInstance

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

    • 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