Value Members

1.  final def !=(arg0: Any): Boolean

   Definition Classes

   AnyRef → Any

2.  final def ##(): Int

   Definition Classes

   AnyRef → Any

3.  final def ==(arg0: Any): Boolean

   Definition Classes

   AnyRef → Any

4.  final def asInstanceOf[T0]: T0

   Definition Classes

   Any

5.  def asJava: AnyRef

   Definition Classes

   AuthProvider

6.  def authenticate(authInfo: JsonObject, resultHandler: Handler[AsyncResult[User]]): Unit

   Authenticate a user.

   Authenticate a user.

   The first argument is a JSON object containing information for authenticating the user. What this actually contains depends on the specific implementation. In the case of a simple username/password based authentication it is likely to contain a JSON object with the following structure:

     {
       "username": "tim",
       "password": "mypassword"
     `
   

   For other types of authentication it contain different information - for example a JWT token or OAuth bearer token.

   If the user is successfully authenticated a io.vertx.scala.ext.auth.User object is passed to the handler in an io.vertx.scala.core.AsyncResult. The user object can then be used for authorisation. * @param authInfo The auth information

   resultHandler

   The result handler

   Definition Classes

   AuthProvider

7.  def authenticateFuture(authInfo: JsonObject): Future[User]

   Like authenticate but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

   Like authenticate but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

   Definition Classes

   AuthProvider

8.  def clone(): AnyRef

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @native() @throws( ... )

9.  final def eq(arg0: AnyRef): Boolean

   Definition Classes

   AnyRef

10.  def equals(arg0: Any): Boolean

    Definition Classes

    AnyRef → Any

11.  def finalize(): Unit

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

12.  final def getClass(): Class[_]

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

13.  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 * @return the collectionName

14.  def getHashStrategy(): HashStrategy

    The HashStrategy which is used by the current instance * @return the defined instance of HashStrategy

15.  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#authenticate.

    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#authenticate. Defaults to io.vertx.scala.ext.auth.mongo.MongoAuth * @return the passwordCredentialField

16.  def getPasswordField(): String

    Get the name of the field to be used for the password Defaults to io.vertx.scala.ext.auth.mongo.MongoAuth * @return the passwordField

17.  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 * @return the permissionField

18.  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 * @return the roleField

19.  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 * @return the saltField

20.  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#authenticate.

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

21.  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 * @return the usernameField

22.  def hashCode(): Int

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

23.  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 * @param username the username to be set

    Insert a new user into mongo in the convenient way * @param 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

24.  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.

25.  final def isInstanceOf[T0]: Boolean

    Definition Classes

    Any

26.  final def ne(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

27.  final def notify(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

28.  final def notifyAll(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

29.  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 * @param collectionName the name of the collection to be used for storing and reading user data

    returns

    the current instance itself for fluent calls

30.  def setHashAlgorithm(hashAlgorithm: HashAlgorithm): MongoAuth

    The Hash Algorithm which is used by the current instance * @param hashAlgorithm the HashAlgorithm to be set

    The Hash Algorithm which is used by the current instance * @param hashAlgorithm the HashAlgorithm to be set

    returns

    the current instance itself for fluent calls

31.  def setHashStrategy(hashStrategy: HashStrategy): MongoAuth

    The HashStrategy which is used by the current instance * @param hashStrategy the HashStrategy to be set

    The HashStrategy which is used by the current instance * @param hashStrategy the HashStrategy to be set

    returns

    the current instance itself for fluent calls

32.  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#authenticate.

    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#authenticate. Defaults to io.vertx.scala.ext.auth.mongo.MongoAuth * @param fieldName the name of the field to be used

    returns

    the current instance itself for fluent calls

33.  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 * @param fieldName the name of the field to be used

    Set the name of the field to be used for the password Defaults to io.vertx.scala.ext.auth.mongo.MongoAuth * @param fieldName the name of the field to be used

    returns

    the current instance itself for fluent calls

34.  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 * @param fieldName the name of the field to be used

    returns

    the current instance itself for fluent calls

35.  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 * @param fieldName the name of the field to be used

    returns

    the current instance itself for fluent calls

36.  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 * @param fieldName the name of the field to be used

    returns

    the current instance itself for fluent calls

37.  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#authenticate.

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

    returns

    the current instance itself for fluent calls

38.  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 * @param fieldName the name of the field to be used

    returns

    the current instance itself for fluent calls

39.  final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes

    AnyRef

40.  def toString(): String

    Definition Classes

    AnyRef → Any

41.  final def wait(): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

42.  final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

43.  final def wait(arg0: Long): Unit

    Definition Classes

    AnyRef

    Annotations

    @native() @throws( ... )