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 web
  Definition Classes
    ext
-  package handler
  Definition Classes
    web
-  package sockjs
  Definition Classes
    handler
- AuthHandler
- BasicAuthHandler
- BodyHandler
- CSRFHandler
- ChainAuthHandler
- CookieHandler
- CorsHandler
- DigestAuthHandler
- ErrorHandler
- FaviconHandler
- FormLoginHandler
- JWTAuthHandler
- LoggerHandler
- OAuth2AuthHandler
- RedirectAuthHandler
- ResponseContentTypeHandler
- ResponseTimeHandler
- SessionHandler
- StaticHandler
- TemplateHandler
- TimeoutHandler
- UserSessionHandler
- VirtualHostHandler

t

io.vertx.scala.ext.web.handler

# AuthHandler 

###
Companion object AuthHandler

#### trait AuthHandler extends Handler[RoutingContext]

Base interface for auth handlers.

An auth handler allows your application to provide authentication/authorization support.

Auth handler requires a io.vertx.scala.ext.web.handler.SessionHandler to be on the routing chain before it.

Linear Supertypes
Handler[RoutingContext], AnyRef, Any
Known Subclasses
BasicAuthHandler, ChainAuthHandler, DigestAuthHandler, JWTAuthHandler, OAuth2AuthHandler, RedirectAuthHandler
 
Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. AuthHandler
2. Handler
3. AnyRef
4. Any

1. Hide All
2. Show All

Visibility

1. Public
2. All

### Abstract Value Members

1.  abstract def addAuthorities(authorities: Set[String]): AuthHandler

   Add a set of required authorities for this auth handler * @param authorities the set of authorities

   Add a set of required authorities for this auth handler * @param authorities the set of authorities

   returns

     a reference to this, so the API can be used fluently

2.  abstract def addAuthority(authority: String): AuthHandler

   Add a required authority for this auth handler * @param authority the authority

   Add a required authority for this auth handler * @param authority the authority

   returns

     a reference to this, so the API can be used fluently

3.  abstract def asJava: AnyRef
4.  abstract def authorize(user: User, handler: Handler[AsyncResult[Unit]]): Unit

   Authorizes the given user against all added authorities.

   Authorizes the given user against all added authorities. * @param user a user.

   handler

     the handler for the result.

5.  abstract def authorizeFuture(user: User): Future[Unit]

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

6.  abstract def handle(arg0: RoutingContext): Unit
   Definition Classes
     AuthHandler → Handler
7.  abstract def parseCredentials(context: RoutingContext, handler: Handler[AsyncResult[JsonObject]]): Unit

   Parses the credentials from the request into a JsonObject.

   Parses the credentials from the request into a JsonObject. The implementation should be able to extract the required info for the auth provider in the format the provider expects. * @param context the routing context

   handler

     the handler to be called once the information is available.

8.  abstract def parseCredentialsFuture(context: RoutingContext): Future[JsonObject]

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

### Concrete 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 clone(): AnyRef
   Attributes
     protected[java.lang]
   Definition Classes
     AnyRef
   Annotations
     @native() @throws( ... )
6.  final def eq(arg0: AnyRef): Boolean
   Definition Classes
     AnyRef
7.  def equals(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
8.  def finalize(): Unit
   Attributes
     protected[java.lang]
   Definition Classes
     AnyRef
   Annotations
     @throws( classOf[java.lang.Throwable] )
9.  final def getClass(): Class[_]
   Definition Classes
     AnyRef → Any
   Annotations
     @native()
10.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
11.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
12.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
13.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
14.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
15.  final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
      AnyRef
16.  def toString(): String
    Definition Classes
      AnyRef → Any
17.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
18.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
19.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @native() @throws( ... )

### Inherited from Handler[RoutingContext]

### Inherited from AnyRef

### Inherited from Any

### Ungrouped