trait JwtClaims extends AnyRef
JwtClaims provides a utility to access claims extracted from a JWT token. Not for user extension
- Annotations
- @DoNotInherit()
- Source
- JwtClaims.scala
- Alphabetic
- By Inheritance
- JwtClaims
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def booleanClaim(name: String): Option[Boolean]
Extracts a boolean claim from the list of claims.
Extracts a boolean claim from the list of claims.
- name
the name of the claim.
- returns
an Option containing the boolean value of the claim if it exists and is a boolean, None otherwise.
- abstract def doubleClaim(name: String): Option[Double]
Extracts a double claim from the list of claims.
Extracts a double claim from the list of claims.
- name
the name of the claim.
- returns
an Option containing the double value of the claim if it exists and is a double, None otherwise.
- abstract def hasClaim(name: String): Boolean
Checks if a claim with the given name exists in the list of claims.
Checks if a claim with the given name exists in the list of claims.
- name
the name of the claim.
- returns
true if the claim exists, false otherwise.
- abstract def intClaim(name: String): Option[Int]
Extracts an integer claim from the list of claims.
Extracts an integer claim from the list of claims.
- name
the name of the claim.
- returns
an Option containing the integer value of the claim if it exists and is an integer, None otherwise.
- abstract def longClaim(name: String): Option[Long]
Extracts a long claim from the list of claims.
Extracts a long claim from the list of claims.
- name
the name of the claim.
- returns
an Option containing the long value of the claim if it exists and is a long, None otherwise.
- abstract def rawClaim(name: String): Option[JsValue]
Extracts a raw claim from the list of claims.
Extracts a raw claim from the list of claims. This can be useful if you need to extract a claim that is not a primitive type but a complex one.
- name
the name of the claim.
- returns
an Option containing the raw JsValue of the claim if it exists, None otherwise.
- abstract def stringClaim(name: String): Option[String]
Extracts a string claim from the list of claims.
Extracts a string claim from the list of claims.
- name
the name of the claim.
- returns
an Option containing the string value of the claim if it exists and is a string, None otherwise.
- abstract def stringClaims(name: String): List[String]
Extracts a list of string claims from the list of claims.
Extracts a list of string claims from the list of claims.
- name
the name of the claim.
- returns
a List containing the string values of the claim if it exists and is a list of strings, empty list otherwise.
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- def ->[B](y: B): (JwtClaims, B)
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- def ensuring(cond: (JwtClaims) => Boolean, msg: => Any): JwtClaims
- def ensuring(cond: (JwtClaims) => Boolean): JwtClaims
- def ensuring(cond: Boolean, msg: => Any): JwtClaims
- def ensuring(cond: Boolean): JwtClaims
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from JwtClaims toStringFormat[JwtClaims] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)instead ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- def →[B](y: B): (JwtClaims, B)
- Implicit
- This member is added by an implicit conversion from JwtClaims toArrowAssoc[JwtClaims] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.