Packages

abstract class JwtDirectives extends AnyRef

JwtDirectives provides utilities to easily assert and extract claims from a JSON Web Token (JWT).

For more information about JWTs, see https://jwt.io/ or consult RFC 7519: https://datatracker.ietf.org/doc/html/rfc7519

Source
JwtDirectives.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. JwtDirectives
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new JwtDirectives()

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from JwtDirectives toany2stringadd[JwtDirectives] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (JwtDirectives, B)
    Implicit
    This member is added by an implicit conversion from JwtDirectives toArrowAssoc[JwtDirectives] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  8. def ensuring(cond: (JwtDirectives) => Boolean, msg: => Any): JwtDirectives
    Implicit
    This member is added by an implicit conversion from JwtDirectives toEnsuring[JwtDirectives] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (JwtDirectives) => Boolean): JwtDirectives
    Implicit
    This member is added by an implicit conversion from JwtDirectives toEnsuring[JwtDirectives] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): JwtDirectives
    Implicit
    This member is added by an implicit conversion from JwtDirectives toEnsuring[JwtDirectives] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): JwtDirectives
    Implicit
    This member is added by an implicit conversion from JwtDirectives toEnsuring[JwtDirectives] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. def jwt(settings: JwtSettings, inner: Function[JwtClaims, Route]): Route

    Wraps its inner route with support for the JWT mechanism, enabling JWT token validation using the given jwt settings.

    Wraps its inner route with support for the JWT mechanism, enabling JWT token validation using the given jwt settings. JWT token validation is done automatically extracting the token from the Authorization header. If the token is valid, the inner route is executed and provided the set of claims as JwtClaims, otherwise a 401 Unauthorized response is returned.

  18. def jwt(inner: Function[JwtClaims, Route]): Route

    Wraps its inner route with support for the JWT mechanism, enabling JWT token validation.

    Wraps its inner route with support for the JWT mechanism, enabling JWT token validation. JWT token validation is done automatically extracting the token from the Authorization header. If the token is valid, the inner route is executed and provided the set of claims as JwtClaims, otherwise a 401 Unauthorized response is returned.

  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  22. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  23. def toString(): String
    Definition Classes
    AnyRef → Any
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from JwtDirectives toStringFormat[JwtDirectives] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def [B](y: B): (JwtDirectives, B)
    Implicit
    This member is added by an implicit conversion from JwtDirectives toArrowAssoc[JwtDirectives] 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.

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromJwtDirectives to any2stringadd[JwtDirectives]

Inherited by implicit conversion StringFormat fromJwtDirectives to StringFormat[JwtDirectives]

Inherited by implicit conversion Ensuring fromJwtDirectives to Ensuring[JwtDirectives]

Inherited by implicit conversion ArrowAssoc fromJwtDirectives to ArrowAssoc[JwtDirectives]

Ungrouped