vertx-lang-scala-docs_2.12 3.5.3.CR1 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

c

io.vertx.scala.ext.web.handler

# JWTAuthHandler 

###
Companion object JWTAuthHandler

#### class JWTAuthHandler extends AuthHandler with Handler[RoutingContext]

An auth handler that provides JWT Authentication support.

Linear Supertypes
AuthHandler, Handler[RoutingContext], AnyRef, Any
 
Ordering

1. Alphabetic
2. By Inheritance

Inherited

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

1. Hide All
2. Show All

Visibility

1. Public
2. All

### Instance Constructors

1.  new JWTAuthHandler(_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 addAuthorities(authorities: Set[String]): AuthHandler

   Add a set of required authorities for this auth handler

   Add a set of required authorities for this auth handler

   authorities

     the set of authorities

   returns

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

   Definition Classes
     JWTAuthHandler → AuthHandler
5.  def addAuthority(authority: String): AuthHandler

   Add a required authority for this auth handler

   Add a required authority for this auth handler

   authority

     the authority

   returns

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

   Definition Classes
     JWTAuthHandler → AuthHandler
6.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
7.  def asJava: AnyRef
   Definition Classes
     JWTAuthHandler → AuthHandler
8.  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.

   user

     a user.

   handler

     the handler for the result.

   Definition Classes
     JWTAuthHandler → AuthHandler
9.  def authorizeFuture(user: User): Future[Unit]

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

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

   Definition Classes
     JWTAuthHandler → AuthHandler
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 handle(arg0: RoutingContext): Unit
    Definition Classes
      JWTAuthHandler → AuthHandler → Handler
16.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
17.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
18.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
19.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
20.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
21.  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.

    context

      the routing context

    handler

      the handler to be called once the information is available.

    Definition Classes
      JWTAuthHandler → AuthHandler
22.  def parseCredentialsFuture(context: RoutingContext): Future[JsonObject]

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

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

    Definition Classes
      JWTAuthHandler → AuthHandler
23.  def setAudience(audience: Buffer[String]): JWTAuthHandler

    Set the audience list

    Set the audience list

    audience

      the audience list

    returns

      a reference to this for fluency

24.  def setIgnoreExpiration(ignoreExpiration: Boolean): JWTAuthHandler

    Set whether expiration is ignored

    Set whether expiration is ignored

    ignoreExpiration

      whether expiration is ignored

    returns

      a reference to this for fluency

25.  def setIssuer(issuer: String): JWTAuthHandler

    Set the issuer

    Set the issuer

    issuer

      the issuer

    returns

      a reference to this for fluency

26.  final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
      AnyRef
27.  def toString(): String
    Definition Classes
      AnyRef → Any
28.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
29.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
30.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @native() @throws( ... )

### Inherited from AuthHandler

### Inherited from Handler[RoutingContext]

### Inherited from AnyRef

### Inherited from Any

### Ungrouped