Package io.vertx.mutiny.ext.auth.mongo

Class MongoUserUtil

java.lang.Object
io.vertx.mutiny.ext.auth.mongo.MongoUserUtil
All Implemented Interfaces:
MutinyDelegate
public class MongoUserUtil extends Object implements MutinyDelegate
Utility to create users/roles/permissions. This is a helper class and not intended to be a full user management utility. While the standard authentication and authorization interfaces will require usually read only access to the database, in order to use this API a full read/write access must be granted.

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

  • Field Details

  • Constructor Details

    • MongoUserUtil

      public MongoUserUtil(io.vertx.ext.auth.mongo.MongoUserUtil delegate)

    • MongoUserUtil

      public MongoUserUtil(Object delegate)

  • Method Details

    • getDelegate

      public io.vertx.ext.auth.mongo.MongoUserUtil getDelegate()
      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

    • create

      public static MongoUserUtil create(MongoClient client)
      Parameters:
      client - the client with write rights to the database.
      Returns:
      the instance

    • create

      public static MongoUserUtil create(MongoClient client, io.vertx.ext.auth.mongo.MongoAuthenticationOptions authenticationOptions, io.vertx.ext.auth.mongo.MongoAuthorizationOptions authorizationOptions)
      Parameters:
      client - the client with write rights to the database.
      authenticationOptions -
      authorizationOptions -
      Returns:
      the instance

    • createUser

      @CheckReturnValue public io.smallrye.mutiny.Uni<String> createUser(String username, String password)
      Insert a user into a database.

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

      Parameters:
      username - the username to be set
      password - the password in clear text, will be adapted following the definitions of the defined strategy
      Returns:
      the uni firing the result of the operation when completed, or a failure if the operation failed.

    • createUserAndAwait

      public String createUserAndAwait(String username, String password)
      Blocking variant of createUser(String,String).

      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:
      username - the username to be set
      password - the password in clear text, will be adapted following the definitions of the defined strategy
      Returns:
      the String instance produced by the operation.

    • createUserAndForget

      public MongoUserUtil createUserAndForget(String username, String password)
      Variant of createUser(String,String) that ignores the result of the operation.

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

      Parameters:
      username - the username to be set
      password - the password in clear text, will be adapted following the definitions of the defined strategy
      Returns:
      the instance of MongoUserUtil to chain method calls.

    • createHashedUser

      @CheckReturnValue public io.smallrye.mutiny.Uni<String> createHashedUser(String username, String hash)
      Insert a user into a database.

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

      Parameters:
      username - the username to be set
      hash - the password hash, as result of HashingStrategy.hash(java.lang.String, java.util.Map<java.lang.String, java.lang.String>, java.lang.String, java.lang.String)
      Returns:
      the uni firing the result of the operation when completed, or a failure if the operation failed.

    • createHashedUserAndAwait

      public String createHashedUserAndAwait(String username, String hash)
      Blocking variant of createHashedUser(String,String).

      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:
      username - the username to be set
      hash - the password hash, as result of HashingStrategy.hash(java.lang.String, java.util.Map<java.lang.String, java.lang.String>, java.lang.String, java.lang.String)
      Returns:
      the String instance produced by the operation.

    • createHashedUserAndForget

      public MongoUserUtil createHashedUserAndForget(String username, String hash)
      Variant of createHashedUser(String,String) that ignores the result of the operation.

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

      Parameters:
      username - the username to be set
      hash - the password hash, as result of HashingStrategy.hash(java.lang.String, java.util.Map<java.lang.String, java.lang.String>, java.lang.String, java.lang.String)
      Returns:
      the instance of MongoUserUtil to chain method calls.

    • createUserRolesAndPermissions

      @CheckReturnValue public io.smallrye.mutiny.Uni<String> createUserRolesAndPermissions(String username, List<String> roles, List<String> permissions)
      Insert a user role into a database.

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

      Parameters:
      username - the username to be set
      roles - a to be set
      permissions - a to be set
      Returns:
      the uni firing the result of the operation when completed, or a failure if the operation failed.

    • createUserRolesAndPermissionsAndAwait

      public String createUserRolesAndPermissionsAndAwait(String username, List<String> roles, List<String> permissions)
      Blocking variant of createUserRolesAndPermissions(String,List,List).

      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:
      username - the username to be set
      roles - a to be set
      permissions - a to be set
      Returns:
      the String instance produced by the operation.

    • createUserRolesAndPermissionsAndForget

      public MongoUserUtil createUserRolesAndPermissionsAndForget(String username, List<String> roles, List<String> permissions)
      Variant of createUserRolesAndPermissions(String,List,List) that ignores the result of the operation.

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

      Parameters:
      username - the username to be set
      roles - a to be set
      permissions - a to be set
      Returns:
      the instance of MongoUserUtil to chain method calls.

    • newInstance

      public static MongoUserUtil newInstance(io.vertx.ext.auth.mongo.MongoUserUtil arg)