vertx / io.vertx.reactivex.ext.auth.mongo / MongoAuth

MongoAuth

open class MongoAuth : AuthProvider

An extension of AuthProvider which is using as store NOTE: This class has been automatically generated from the io.vertx.ext.auth.mongo.MongoAuth non RX-ified interface using Vert.x codegen.

Constructors

<init>

MongoAuth(delegate: MongoAuth)

Properties

__TYPE_ARG

static val __TYPE_ARG: TypeArg<MongoAuth>

Functions

create

open static fun create(mongoClient: MongoClient, config: JsonObject): MongoAuth

Creates an instance of MongoAuth by using the given and configuration object. An example for a configuration object:

 JsonObject js = new JsonObject(); js.put(MongoAuth.PROPERTY_COLLECTION_NAME, createCollectionName(MongoAuth.DEFAULT_COLLECTION_NAME)); 

equals

open fun equals(other: Any?): Boolean

getCollectionName

open fun getCollectionName(): String

The name of the collection used to store User objects inside. Defaults to io.vertx.reactivex.ext.auth.mongo.MongoAuth

getDelegate

open fun getDelegate(): MongoAuth

getHashStrategy

open fun getHashStrategy(): HashStrategy

The HashStrategy which is used by the current instance

getPasswordCredentialField

open fun getPasswordCredentialField(): String

Get the name of the field to be used as property for the password of credentials in the method io.vertx.reactivex.ext.auth.AuthProvider#authenticate. Defaults to io.vertx.reactivex.ext.auth.mongo.MongoAuth

getPasswordField

open fun getPasswordField(): String

Get the name of the field to be used for the password Defaults to io.vertx.reactivex.ext.auth.mongo.MongoAuth

getPermissionField

open fun getPermissionField(): String

Get the name of the field to be used for the permissions. Defaults to io.vertx.reactivex.ext.auth.mongo.MongoAuth. Permissions are expected to be saved as JsonArray

getRoleField

open fun getRoleField(): String

Get the name of the field to be used for the roles. Defaults to io.vertx.reactivex.ext.auth.mongo.MongoAuth. Roles are expected to be saved as JsonArray

getSaltField

open fun getSaltField(): String

Get the name of the field to be used for the salt. Only used when io.vertx.reactivex.ext.auth.mongo.HashStrategy#setSaltStyle is set to

getUsernameCredentialField

open fun getUsernameCredentialField(): String

Get the name of the field to be used as property for the username in the method io.vertx.reactivex.ext.auth.AuthProvider#authenticate. Defaults to io.vertx.reactivex.ext.auth.mongo.MongoAuth

getUsernameField

open fun getUsernameField(): String

Get the name of the field to be used for the username. Defaults to io.vertx.reactivex.ext.auth.mongo.MongoAuth

hashCode

open fun hashCode(): Int

insertUser

open 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

newInstance

open static fun newInstance(arg: MongoAuth): MongoAuth

rxInsertUser

open fun rxInsertUser(username: String, password: String, roles: MutableList<String>, permissions: MutableList<String>): Single<String>

Insert a new user into mongo in the convenient way

setCollectionName

open fun setCollectionName(collectionName: String): MongoAuth

Set the name of the collection to be used. Defaults to io.vertx.reactivex.ext.auth.mongo.MongoAuth

setHashStrategy

open fun setHashStrategy(hashStrategy: HashStrategy): MongoAuth

The HashStrategy which is used by the current instance

setPasswordCredentialField

open fun setPasswordCredentialField(fieldName: String): MongoAuth

Set the name of the field to be used as property for the password of credentials in the method io.vertx.reactivex.ext.auth.AuthProvider#authenticate. Defaults to io.vertx.reactivex.ext.auth.mongo.MongoAuth

setPasswordField

open fun setPasswordField(fieldName: String): MongoAuth

Set the name of the field to be used for the password Defaults to io.vertx.reactivex.ext.auth.mongo.MongoAuth

setPermissionField

open fun setPermissionField(fieldName: String): MongoAuth

Set the name of the field to be used for the permissions. Defaults to io.vertx.reactivex.ext.auth.mongo.MongoAuth. Permissions are expected to be saved as JsonArray

setRoleField

open fun setRoleField(fieldName: String): MongoAuth

Set the name of the field to be used for the roles. Defaults to io.vertx.reactivex.ext.auth.mongo.MongoAuth. Roles are expected to be saved as JsonArray

setSaltField

open fun setSaltField(fieldName: String): MongoAuth

Set the name of the field to be used for the salt. Only used when io.vertx.reactivex.ext.auth.mongo.HashStrategy#setSaltStyle is set to

setUsernameCredentialField

open fun setUsernameCredentialField(fieldName: String): MongoAuth

Set the name of the field to be used as property for the username in the method io.vertx.reactivex.ext.auth.AuthProvider#authenticate. Defaults to io.vertx.reactivex.ext.auth.mongo.MongoAuth

setUsernameField

open fun setUsernameField(fieldName: String): MongoAuth

Set the name of the field to be used for the username. Defaults to io.vertx.reactivex.ext.auth.mongo.MongoAuth

toString

open fun toString(): String