vertx-lang-scala-docs_2.12 3.4.1 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 jwt
  Definition Classes
    auth
- JWTAuth
- JWTOptions

c

io.vertx.scala.ext.auth.jwt

# JWTOptions 

###
Companion object JWTOptions

#### class JWTOptions extends AnyRef

Options related to creation of new tokens.

If any expiresInMinutes, audience, subject, issuer are not provided, there is no default. The jwt generated won't include those properties in the payload.

Generated JWTs will include an iat claim by default unless noTimestamp is specified.

Linear Supertypes
AnyRef, Any
 
Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. JWTOptions
2. AnyRef
3. Any

1. Hide All
2. Show All

Visibility

1. Public
2. All

### Instance Constructors

1.  new JWTOptions(_asJava: ext.auth.jwt.JWTOptions)

### 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 addAudience(value: String): JWTOptions

   The target audience of this token

5.  def addHeader(key: String, value: String): JWTOptions
6.  def addPermission(value: String): JWTOptions

   The permissions of this token.

7.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
8.  def asJava: ext.auth.jwt.JWTOptions
9.  def clone(): AnyRef
   Attributes
     protected[java.lang]
   Definition Classes
     AnyRef
   Annotations
     @throws( ... )
10.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
11.  def equals(arg0: Any): Boolean
    Definition Classes
      AnyRef → Any
12.  def finalize(): Unit
    Attributes
      protected[java.lang]
    Definition Classes
      AnyRef
    Annotations
      @throws( classOf[java.lang.Throwable] )
13.  def getAlgorithm: String
14.  def getAudience: Buffer[String]
15.  final def getClass(): Class[_]
    Definition Classes
      AnyRef → Any
16.  def getExpiresInMinutes: Long
17.  def getExpiresInSeconds: Long
18.  def getIssuer: String
19.  def getNoTimestamp: Boolean
20.  def getSubject: String
21.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
22.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
23.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
24.  final def notify(): Unit
    Definition Classes
      AnyRef
25.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
26.  def setAlgorithm(value: String): JWTOptions

    The algorithm to use, it should be one of the alias [HS256, HS384, HS512, RS256, RS384, RS512, ES256, ES384, ES512]

27.  def setAudience(value: Buffer[String]): JWTOptions

    The target audience of this token

28.  def setExpiresInMinutes(value: Long): JWTOptions

    The expiration time for the token in minutes

29.  def setExpiresInSeconds(value: Long): JWTOptions

    The expiration time for the token in seconds

30.  def setIssuer(value: String): JWTOptions

    The issuer of this token

31.  def setNoTimestamp(value: Boolean): JWTOptions

    Disable the generation of issued at claim

32.  def setPermissions(value: Buffer[String]): JWTOptions
33.  def setSubject(value: String): JWTOptions

    The subject of this token

34.  final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
      AnyRef
35.  def toString(): String
    Definition Classes
      AnyRef → Any
36.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
37.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
38.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

### Inherited from AnyRef

### Inherited from Any

### Ungrouped