vertx-lang-scala-docs_2.12 3.8.0 API < Back
 

# Packages

-  package root
  Definition Classes
    root
-  package io
  Definition Classes
    root
-  package vertx
  Definition Classes
    io
-  package scala
  Definition Classes
    vertx
-  package ext
  Definition Classes
    scala
-  package auth
  Definition Classes
    ext
-  package htdigest
  Definition Classes
    auth
-  package jdbc
  Definition Classes
    auth
-  package jwt
  Definition Classes
    auth
-  package mongo
  Definition Classes
    auth
-  package oauth2
  Definition Classes
    auth
-  package shiro
  Definition Classes
    auth
- AuthOptions
- AuthProvider
- ChainAuth
- HashingAlgorithm
- HashingStrategy
- KeyStoreOptions
- PubSecKeyOptions
- SecretOptions
- User
- VertxContextPRNG

c

io.vertx.scala.ext.auth

# ChainAuth 

###
Companion object ChainAuth

#### class ChainAuth extends AuthProvider

Chain several auth providers as if they were one. This is useful for cases where one want to authenticate across several providers, for example, database and fallback to passwd file.

Linear Supertypes
AuthProvider, AnyRef, Any
 
Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. ChainAuth
2. AuthProvider
3. AnyRef
4. Any

1. Hide All
2. Show All

Visibility

1. Public
2. All

### Instance Constructors

1.  new ChainAuth(_asJava: AnyRef)

### 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.  def append(other: AuthProvider): ChainAuth

   Appends a auth provider to the chain.

   Appends a auth provider to the chain. * @param other auth provider

   returns

     self

5.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
6.  def asJava: AnyRef
   Definition Classes
     AuthProvider
7.  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
8.  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
9.  def clear(): Unit

   Clears the chain.

10.  def clone(): AnyRef
    Attributes
      protected[java.lang]
    Definition Classes
      AnyRef
    Annotations
      @native() @throws( ... )
11.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
12.  def equals(arg0: Any): Boolean
    Definition Classes
      AnyRef → Any
13.  def finalize(): Unit
    Attributes
      protected[java.lang]
    Definition Classes
      AnyRef
    Annotations
      @throws( classOf[java.lang.Throwable] )
14.  final def getClass(): Class[_]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
15.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
16.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
17.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
18.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
19.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
20.  def remove(other: AuthProvider): Boolean

    Removes a provider from the chain.

    Removes a provider from the chain. * @param other provider to remove

    returns

      true if provider was removed, false if non existent in the chain.

21.  final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
      AnyRef
22.  def toString(): String
    Definition Classes
      AnyRef → Any
23.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
24.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
25.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @native() @throws( ... )

### Inherited from AuthProvider

### Inherited from AnyRef

### Inherited from Any

### Ungrouped