interface MongoAuth : AuthProvider
An extension of AuthProvider which is using MongoClient as store
Author
mremme
static val DEFAULT_COLLECTION_NAME: String
The default name of the collection to be used |
|
static val DEFAULT_CREDENTIAL_PASSWORD_FIELD: String
The default name of the property for the password, like it is transported in credentials by method |
|
static val DEFAULT_CREDENTIAL_USERNAME_FIELD: String
The default name of the property for the username, like it is transported in credentials by method |
|
static val DEFAULT_PASSWORD_FIELD: String
The default name of the property for the password, like it is stored in mongodb |
|
static val DEFAULT_PERMISSION_FIELD: String
The default name of the property for the permissions, like it is stored in mongodb. Permissions are expected to be saved as JsonArray |
|
static val DEFAULT_ROLE_FIELD: String
The default name of the property for the roles, like it is stored in mongodb. Roles are expected to be saved as JsonArray |
|
static val DEFAULT_SALT_FIELD: String
The default name of the property for the salt field |
|
static val DEFAULT_USERNAME_FIELD: String
The default name of the property for the username, like it is stored in mongodb |
|
static val PROPERTY_COLLECTION_NAME: String
The property name to be used to set the name of the collection inside the config |
|
static val PROPERTY_CREDENTIAL_PASSWORD_FIELD: String
The property name to be used to set the name of the field, where the password for the credentials is stored inside |
|
static val PROPERTY_CREDENTIAL_USERNAME_FIELD: String
The property name to be used to set the name of the field, where the username for the credentials is stored inside |
|
static val PROPERTY_PASSWORD_FIELD: String
The property name to be used to set the name of the field, where the password is stored inside |
|
static val PROPERTY_PERMISSION_FIELD: String
The property name to be used to set the name of the field, where the permissions are stored inside |
|
static val PROPERTY_ROLE_FIELD: String
The property name to be used to set the name of the field, where the roles are stored inside |
|
static val PROPERTY_SALT_FIELD: String
The property name to be used to set the name of the field, where the SALT is stored inside |
|
static val PROPERTY_SALT_STYLE: String
The property name to be used to set the name of the field, where the salt style is stored inside |
|
static val PROPERTY_USERNAME_FIELD: String
The property name to be used to set the name of the field, where the username is stored inside |
|
static val ROLE_PREFIX: String
The prefix which is used by the method |
open static fun create(mongoClient: MongoClient, config: JsonObject): MongoAuth
Creates an instance of MongoAuth by using the given MongoClient and configuration object. An example for a configuration object:
|
|
abstract fun getCollectionName(): String
The name of the collection used to store User objects inside. Defaults to |
|
abstract fun getHashStrategy(): HashStrategy
The HashStrategy which is used by the current instance |
|
abstract fun getPasswordCredentialField(): String
Get the name of the field to be used as property for the password of credentials in the method |
|
abstract fun getPasswordField(): String
Get the name of the field to be used for the password Defaults to |
|
abstract fun getPermissionField(): String
Get the name of the field to be used for the permissions. Defaults to |
|
abstract fun getRoleField(): String
Get the name of the field to be used for the roles. Defaults to |
|
abstract fun getSaltField(): String
Get the name of the field to be used for the salt. Only used when |
|
abstract fun getUsernameCredentialField(): String
Get the name of the field to be used as property for the username in the method |
|
abstract fun getUsernameField(): String
Get the name of the field to be used for the username. Defaults to |
|
abstract fun insertUser(username: String, password: String, roles: MutableList<String>, permissions: MutableList<String>, resultHandler: Handler<AsyncResult<String>>): Unit
Insert a new user into mongo in the convenient way |
|
abstract fun setCollectionName(collectionName: String): MongoAuth
Set the name of the collection to be used. Defaults to |
|
abstract fun setHashAlgorithm(hashAlgorithm: HashAlgorithm): MongoAuth
The Hash Algorithm which is used by the current instance |
|
abstract fun setHashStrategy(hashStrategy: HashStrategy): MongoAuth
The HashStrategy which is used by the current instance |
|
abstract fun setPasswordCredentialField(fieldName: String): MongoAuth
Set the name of the field to be used as property for the password of credentials in the method |
|
abstract fun setPasswordField(fieldName: String): MongoAuth
Set the name of the field to be used for the password Defaults to |
|
abstract fun setPermissionField(fieldName: String): MongoAuth
Set the name of the field to be used for the permissions. Defaults to |
|
abstract fun setRoleField(fieldName: String): MongoAuth
Set the name of the field to be used for the roles. Defaults to |
|
abstract fun setSaltField(fieldName: String): MongoAuth
Set the name of the field to be used for the salt. Only used when |
|
abstract fun setUsernameCredentialField(fieldName: String): MongoAuth
Set the name of the field to be used as property for the username in the method |
|
abstract fun setUsernameField(fieldName: String): MongoAuth
Set the name of the field to be used for the username. Defaults to |