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

Class MongoAuth

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

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

  • Field Details

    • __TYPE_ARG

      public static final TypeArg<MongoAuth> __TYPE_ARG

    • PROPERTY_COLLECTION_NAME

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

    • PROPERTY_USERNAME_FIELD

      public static final String PROPERTY_USERNAME_FIELD
      The property name to be used to set the name of the field, where the username is stored inside
      See Also:

    • PROPERTY_ROLE_FIELD

      public static final String PROPERTY_ROLE_FIELD
      The property name to be used to set the name of the field, where the roles are stored inside
      See Also:

    • PROPERTY_PERMISSION_FIELD

      public static final String PROPERTY_PERMISSION_FIELD
      The property name to be used to set the name of the field, where the permissions are stored inside
      See Also:

    • PROPERTY_PASSWORD_FIELD

      public static final String PROPERTY_PASSWORD_FIELD
      The property name to be used to set the name of the field, where the password is stored inside
      See Also:

    • PROPERTY_CREDENTIAL_USERNAME_FIELD

      public static final String PROPERTY_CREDENTIAL_USERNAME_FIELD
      The property name to be used to set the name of the field, where the username for the credentials is stored inside
      See Also:

    • PROPERTY_CREDENTIAL_PASSWORD_FIELD

      public static final String PROPERTY_CREDENTIAL_PASSWORD_FIELD
      The property name to be used to set the name of the field, where the password for the credentials is stored inside
      See Also:

    • PROPERTY_SALT_FIELD

      public static final String PROPERTY_SALT_FIELD
      The property name to be used to set the name of the field, where the SALT is stored inside
      See Also:

    • PROPERTY_SALT_STYLE

      public static final String PROPERTY_SALT_STYLE
      The property name to be used to set the name of the field, where the salt style is stored inside
      See Also:

    • DEFAULT_COLLECTION_NAME

      public static final String DEFAULT_COLLECTION_NAME
      The default name of the collection to be used
      See Also:

    • DEFAULT_USERNAME_FIELD

      public static final String DEFAULT_USERNAME_FIELD
      The default name of the property for the username, like it is stored in mongodb
      See Also:

    • DEFAULT_PASSWORD_FIELD

      public static final String DEFAULT_PASSWORD_FIELD
      The default name of the property for the password, like it is stored in mongodb
      See Also:

    • DEFAULT_ROLE_FIELD

      public static final String DEFAULT_ROLE_FIELD
      The default name of the property for the roles, like it is stored in mongodb. Roles are expected to be saved as JsonArray
      See Also:

    • DEFAULT_PERMISSION_FIELD

      public static final String DEFAULT_PERMISSION_FIELD
      The default name of the property for the permissions, like it is stored in mongodb. Permissions are expected to be saved as JsonArray
      See Also:

    • DEFAULT_CREDENTIAL_USERNAME_FIELD

      public static final String DEFAULT_CREDENTIAL_USERNAME_FIELD
      The default name of the property for the username, like it is transported in credentials by method AuthenticationProvider.authenticate(io.vertx.core.json.JsonObject)
      See Also:

    • DEFAULT_CREDENTIAL_PASSWORD_FIELD

      public static final String DEFAULT_CREDENTIAL_PASSWORD_FIELD
      The default name of the property for the password, like it is transported in credentials by method AuthenticationProvider.authenticate(io.vertx.core.json.JsonObject)
      See Also:

    • DEFAULT_SALT_FIELD

      public static final String DEFAULT_SALT_FIELD
      The default name of the property for the salt field
      See Also:

    • ROLE_PREFIX

      public static final String ROLE_PREFIX
      The prefix which is used by the method when checking for role access
      See Also:

  • Constructor Details

    • MongoAuth

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

    • MongoAuth

      public MongoAuth(Object delegate)

  • Method Details

    • getDelegate

      public io.vertx.ext.auth.mongo.MongoAuth getDelegate()
      Specified by:
      getDelegate in interface MutinyDelegate
      Overrides:
      getDelegate in class AuthProvider
      Returns:
      the delegate used by this Mutiny object of generated type

    • toString

      public String toString()
      Overrides:
      toString in class AuthProvider

    • equals

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class AuthProvider

    • create

      @Deprecated public static MongoAuth create(MongoClient mongoClient, io.vertx.core.json.JsonObject config)
      Deprecated.
      Parameters:
      mongoClient - an instance of to be used for data storage and retrival
      config - the configuration object for the current instance. By this
      Returns:
      the created instance of MongoAuths

    • setCollectionName

      @Deprecated public MongoAuth setCollectionName(String collectionName)
      Deprecated.
      Parameters:
      collectionName - the name of the collection to be used for storing and reading user data
      Returns:
      the current instance itself for fluent calls

    • setUsernameField

      @Deprecated public MongoAuth setUsernameField(String fieldName)
      Deprecated.
      Parameters:
      fieldName - the name of the field to be used
      Returns:
      the current instance itself for fluent calls

    • setPasswordField

      @Deprecated public MongoAuth setPasswordField(String fieldName)
      Deprecated.
      Parameters:
      fieldName - the name of the field to be used
      Returns:
      the current instance itself for fluent calls

    • setRoleField

      @Deprecated public MongoAuth setRoleField(String fieldName)
      Deprecated.
      Parameters:
      fieldName - the name of the field to be used
      Returns:
      the current instance itself for fluent calls

    • setPermissionField

      @Deprecated public MongoAuth setPermissionField(String fieldName)
      Deprecated.
      Parameters:
      fieldName - the name of the field to be used
      Returns:
      the current instance itself for fluent calls

    • setUsernameCredentialField

      @Deprecated public MongoAuth setUsernameCredentialField(String fieldName)
      Deprecated.
      Parameters:
      fieldName - the name of the field to be used
      Returns:
      the current instance itself for fluent calls

    • setPasswordCredentialField

      @Deprecated public MongoAuth setPasswordCredentialField(String fieldName)
      Deprecated.
      Parameters:
      fieldName - the name of the field to be used
      Returns:
      the current instance itself for fluent calls

    • setSaltField

      @Deprecated public MongoAuth setSaltField(String fieldName)
      Deprecated.
      Parameters:
      fieldName - the name of the field to be used
      Returns:
      the current instance itself for fluent calls

    • getCollectionName

      @Deprecated public String getCollectionName()
      Deprecated.
      Returns:
      the collectionName

    • getUsernameField

      @Deprecated public String getUsernameField()
      Deprecated.
      Returns:
      the usernameField

    • getPasswordField

      @Deprecated public String getPasswordField()
      Deprecated.
      Returns:
      the passwordField

    • getRoleField

      @Deprecated public String getRoleField()
      Deprecated.
      Returns:
      the roleField

    • getPermissionField

      @Deprecated public String getPermissionField()
      Deprecated.
      Returns:
      the permissionField

    • getUsernameCredentialField

      @Deprecated public String getUsernameCredentialField()
      Deprecated.
      Returns:
      the usernameCredentialField

    • getPasswordCredentialField

      @Deprecated public String getPasswordCredentialField()
      Deprecated.
      Returns:
      the passwordCredentialField

    • getSaltField

      @Deprecated public String getSaltField()
      Deprecated.
      Returns:
      the saltField

    • setHashStrategy

      @Deprecated public MongoAuth setHashStrategy(HashStrategy hashStrategy)
      Deprecated.
      Parameters:
      hashStrategy - the HashStrategy to be set
      Returns:
      the current instance itself for fluent calls

    • getHashStrategy

      @Deprecated public HashStrategy getHashStrategy()
      Deprecated.
      Returns:
      the defined instance of HashStrategy

    • setHashAlgorithm

      @Deprecated public MongoAuth setHashAlgorithm(io.vertx.ext.auth.mongo.HashAlgorithm hashAlgorithm)
      Deprecated.
      Parameters:
      hashAlgorithm - the HashAlgorithm to be set
      Returns:
      the current instance itself for fluent calls

    • insertUser

      @CheckReturnValue @Deprecated public io.smallrye.mutiny.Uni<String> insertUser(String username, String password, List<String> roles, List<String> permissions)
      Deprecated.
      Please use MongoUserUtil instead. Insert a new user into mongo in the convenient way

      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 passsword in clear text, will be adapted following the definitions of the defined HashStrategy
      roles - a list of roles to be set
      permissions - a list of permissions to be set
      Returns:
      the uni firing the result of the operation when completed, or a failure if the operation failed.

    • insertUserAndAwait

      @Deprecated public String insertUserAndAwait(String username, String password, List<String> roles, List<String> permissions)
      Deprecated.
      Please use MongoUserUtil instead. Insert a new user into mongo in the convenient way
      Blocking variant of insertUser(String,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
      password - the passsword in clear text, will be adapted following the definitions of the defined HashStrategy
      roles - a list of roles to be set
      permissions - a list of permissions to be set
      Returns:
      the String instance produced by the operation.

    • insertUserAndForget

      @Deprecated public void insertUserAndForget(String username, String password, List<String> roles, List<String> permissions)
      Deprecated.
      Please use MongoUserUtil instead. Insert a new user into mongo in the convenient way
      Variant of insertUser(String,String,List,List) that ignores the result of the operation.

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

      Parameters:
      username - the username to be set
      password - the passsword in clear text, will be adapted following the definitions of the defined HashStrategy
      roles - a list of roles to be set
      permissions - a list of permissions to be set

    • newInstance

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