class MongoAuth extends AuthProvider
An extension of AuthProvider which is using as store
- Alphabetic
- By Inheritance
- MongoAuth
- AuthProvider
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new MongoAuth(_asJava: AnyRef)
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
asJava: AnyRef
- Definition Classes
- AuthProvider
-
def
authenticate(authInfo: JsonObject, resultHandler: Handler[AsyncResult[User]]): Unit
- Definition Classes
- AuthProvider
-
def
authenticateFuture(authInfo: JsonObject): Future[User]
- Definition Classes
- AuthProvider
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
getCollectionName(): String
The name of the collection used to store User objects inside.
The name of the collection used to store User objects inside. Defaults to io.vertx.scala.ext.auth.mongo.MongoAuth
- returns
the collectionName
-
def
getHashStrategy(): HashStrategy
The HashStrategy which is used by the current instance
The HashStrategy which is used by the current instance
- returns
the defined instance of HashStrategy
-
def
getPasswordCredentialField(): String
Get the name of the field to be used as property for the password of credentials in the method io.vertx.scala.ext.auth.AuthProvider#authenticateFuture.
Get the name of the field to be used as property for the password of credentials in the method io.vertx.scala.ext.auth.AuthProvider#authenticateFuture. Defaults to io.vertx.scala.ext.auth.mongo.MongoAuth
- returns
the passwordCredentialField
-
def
getPasswordField(): String
Get the name of the field to be used for the password Defaults to io.vertx.scala.ext.auth.mongo.MongoAuth
Get the name of the field to be used for the password Defaults to io.vertx.scala.ext.auth.mongo.MongoAuth
- returns
the passwordField
-
def
getPermissionField(): String
Get the name of the field to be used for the permissions.
Get the name of the field to be used for the permissions. Defaults to io.vertx.scala.ext.auth.mongo.MongoAuth. Permissions are expected to be saved as JsonArray
- returns
the permissionField
-
def
getRoleField(): String
Get the name of the field to be used for the roles.
Get the name of the field to be used for the roles. Defaults to io.vertx.scala.ext.auth.mongo.MongoAuth. Roles are expected to be saved as JsonArray
- returns
the roleField
-
def
getSaltField(): String
Get the name of the field to be used for the salt.
Get the name of the field to be used for the salt. Only used when io.vertx.scala.ext.auth.mongo.HashStrategy#setSaltStyle is set to
- returns
the saltField
-
def
getUsernameCredentialField(): String
Get the name of the field to be used as property for the username in the method io.vertx.scala.ext.auth.AuthProvider#authenticateFuture.
Get the name of the field to be used as property for the username in the method io.vertx.scala.ext.auth.AuthProvider#authenticateFuture. Defaults to io.vertx.scala.ext.auth.mongo.MongoAuth
- returns
the usernameCredentialField
-
def
getUsernameField(): String
Get the name of the field to be used for the username.
Get the name of the field to be used for the username. Defaults to io.vertx.scala.ext.auth.mongo.MongoAuth
- returns
the usernameField
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
insertUser(username: String, password: String, roles: Buffer[String], permissions: Buffer[String], resultHandler: Handler[AsyncResult[String]]): Unit
Insert a new user into mongo in the convenient way
Insert a new user into mongo in the convenient way
- 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
- resultHandler
the ResultHandler will be provided with the id of the generated record
-
def
insertUserFuture(username: String, password: String, roles: Buffer[String], permissions: Buffer[String]): Future[String]
Like insertUser but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
def
setCollectionName(collectionName: String): MongoAuth
Set the name of the collection to be used.
Set the name of the collection to be used. Defaults to io.vertx.scala.ext.auth.mongo.MongoAuth
- collectionName
the name of the collection to be used for storing and reading user data
- returns
the current instance itself for fluent calls
-
def
setHashAlgorithm(hashAlgorithm: HashAlgorithm): MongoAuth
The Hash Algorithm which is used by the current instance
The Hash Algorithm which is used by the current instance
- hashAlgorithm
the HashAlgorithm to be set
- returns
the current instance itself for fluent calls
-
def
setHashStrategy(hashStrategy: HashStrategy): MongoAuth
The HashStrategy which is used by the current instance
The HashStrategy which is used by the current instance
- hashStrategy
the HashStrategy to be set
- returns
the current instance itself for fluent calls
-
def
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.scala.ext.auth.AuthProvider#authenticateFuture.
Set the name of the field to be used as property for the password of credentials in the method io.vertx.scala.ext.auth.AuthProvider#authenticateFuture. Defaults to io.vertx.scala.ext.auth.mongo.MongoAuth
- fieldName
the name of the field to be used
- returns
the current instance itself for fluent calls
-
def
setPasswordField(fieldName: String): MongoAuth
Set the name of the field to be used for the password Defaults to io.vertx.scala.ext.auth.mongo.MongoAuth
Set the name of the field to be used for the password Defaults to io.vertx.scala.ext.auth.mongo.MongoAuth
- fieldName
the name of the field to be used
- returns
the current instance itself for fluent calls
-
def
setPermissionField(fieldName: String): MongoAuth
Set the name of the field to be used for the permissions.
Set the name of the field to be used for the permissions. Defaults to io.vertx.scala.ext.auth.mongo.MongoAuth. Permissions are expected to be saved as JsonArray
- fieldName
the name of the field to be used
- returns
the current instance itself for fluent calls
-
def
setRoleField(fieldName: String): MongoAuth
Set the name of the field to be used for the roles.
Set the name of the field to be used for the roles. Defaults to io.vertx.scala.ext.auth.mongo.MongoAuth. Roles are expected to be saved as JsonArray
- fieldName
the name of the field to be used
- returns
the current instance itself for fluent calls
-
def
setSaltField(fieldName: String): MongoAuth
Set the name of the field to be used for the salt.
Set the name of the field to be used for the salt. Only used when io.vertx.scala.ext.auth.mongo.HashStrategy#setSaltStyle is set to
- fieldName
the name of the field to be used
- returns
the current instance itself for fluent calls
-
def
setUsernameCredentialField(fieldName: String): MongoAuth
Set the name of the field to be used as property for the username in the method io.vertx.scala.ext.auth.AuthProvider#authenticateFuture.
Set the name of the field to be used as property for the username in the method io.vertx.scala.ext.auth.AuthProvider#authenticateFuture. Defaults to io.vertx.scala.ext.auth.mongo.MongoAuth
- fieldName
the name of the field to be used
- returns
the current instance itself for fluent calls
-
def
setUsernameField(fieldName: String): MongoAuth
Set the name of the field to be used for the username.
Set the name of the field to be used for the username. Defaults to io.vertx.scala.ext.auth.mongo.MongoAuth
- fieldName
the name of the field to be used
- returns
the current instance itself for fluent calls
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )