t

pdi.jwt

JwtCirceParser

trait JwtCirceParser[H, C] extends JwtJsonCommon[Json, H, C]

Implementation of JwtCore using Json from Circe.

Linear Supertypes
JwtJsonCommon[Json, H, C], JwtCore[H, C], AnyRef, Any
Known Subclasses
JwtCirce, JwtCirce
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. JwtCirceParser
  2. JwtJsonCommon
  3. JwtCore
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def extractAlgorithm(header: H): Option[JwtAlgorithm]
    Attributes
    protected
    Definition Classes
    JwtCore
  2. abstract def extractExpiration(claim: C): Option[Long]
    Attributes
    protected
    Definition Classes
    JwtCore
  3. abstract def extractNotBefore(claim: C): Option[Long]
    Attributes
    protected
    Definition Classes
    JwtCore
  4. abstract def parseClaim(claim: String): C
    Attributes
    protected
    Definition Classes
    JwtCore
  5. abstract def parseHeader(header: String): H
    Attributes
    protected
    Definition Classes
    JwtCore

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[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  6. def decode(token: String, key: PublicKey): Try[C]
    Definition Classes
    JwtCore
  7. def decode(token: String, key: PublicKey, options: JwtOptions): Try[C]

    Same as decodeAll but only return the claim

    Same as decodeAll but only return the claim

    token

    a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header

    key

    the key that will be used to check the token signature

    returns

    if successful, the claim of the token in its correct type

    Definition Classes
    JwtCore
  8. def decode(token: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm]): Try[C]
    Definition Classes
    JwtCore
  9. def decode(token: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Try[C]

    Same as decodeAll but only return the claim

    Same as decodeAll but only return the claim

    token

    a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header

    key

    the key that will be used to check the token signature

    algorithms

    a list of possible algorithms that the token can use. See Security concerns for more infos.

    returns

    if successful, the claim of the token in its correct type

    Definition Classes
    JwtCore
  10. def decode(token: String, key: SecretKey): Try[C]
    Definition Classes
    JwtCore
  11. def decode(token: String, key: SecretKey, options: JwtOptions): Try[C]

    Same as decodeAll but only return the claim

    Same as decodeAll but only return the claim

    token

    a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header

    key

    the key that will be used to check the token signature

    returns

    if successful, the claim of the token in its correct type

    Definition Classes
    JwtCore
  12. def decode(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm]): Try[C]
    Definition Classes
    JwtCore
  13. def decode(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Try[C]

    Same as decodeAll but only return the claim

    Same as decodeAll but only return the claim

    token

    a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header

    key

    the key that will be used to check the token signature

    algorithms

    a list of possible algorithms that the token can use. See Security concerns for more infos.

    returns

    if successful, the claim of the token in its correct type

    Definition Classes
    JwtCore
  14. def decode(token: String, key: String, algorithms: => Seq[JwtAsymmetricAlgorithm]): Try[C]
    Definition Classes
    JwtCore
  15. def decode(token: String, key: String, algorithms: => Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Try[C]

    Same as decodeAll but only return the claim

    Same as decodeAll but only return the claim

    token

    a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header

    key

    the key that will be used to check the token signature

    algorithms

    a list of possible algorithms that the token can use. See Security concerns for more infos.

    returns

    if successful, the claim of the token in its correct type

    Definition Classes
    JwtCore
  16. def decode(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm]): Try[C]
    Definition Classes
    JwtCore
  17. def decode(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Try[C]

    Same as decodeAll but only return the claim

    Same as decodeAll but only return the claim

    token

    a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header

    key

    the key that will be used to check the token signature

    algorithms

    a list of possible algorithms that the token can use. See Security concerns for more infos.

    returns

    if successful, the claim of the token in its correct type

    Definition Classes
    JwtCore
  18. def decode(token: String): Try[C]
    Definition Classes
    JwtCore
  19. def decode(token: String, options: JwtOptions): Try[C]

    Same as decodeAll but only return the claim

    Same as decodeAll but only return the claim

    token

    a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header

    returns

    if successful, the claim of the token in its correct type

    Definition Classes
    JwtCore
  20. def decodeAll(token: String, key: PublicKey): Try[(H, C, String)]
    Definition Classes
    JwtCore
  21. def decodeAll(token: String, key: PublicKey, options: JwtOptions): Try[(H, C, String)]

    Same as decodeRawAll but return the real header and claim types

    Same as decodeRawAll but return the real header and claim types

    token

    a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header

    key

    the key that will be used to check the token signature

    returns

    if successful, a tuple representing the header, the claim and eventually the signature

    Definition Classes
    JwtCore
  22. def decodeAll(token: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm]): Try[(H, C, String)]
    Definition Classes
    JwtCore
  23. def decodeAll(token: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Try[(H, C, String)]

    Same as decodeRawAll but return the real header and claim types

    Same as decodeRawAll but return the real header and claim types

    token

    a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header

    key

    the key that will be used to check the token signature

    algorithms

    a list of possible algorithms that the token can use. See Security concerns for more infos.

    returns

    if successful, a tuple representing the header, the claim and eventually the signature

    Definition Classes
    JwtCore
  24. def decodeAll(token: String, key: SecretKey): Try[(H, C, String)]
    Definition Classes
    JwtCore
  25. def decodeAll(token: String, key: SecretKey, options: JwtOptions): Try[(H, C, String)]

    Same as decodeRawAll but return the real header and claim types

    Same as decodeRawAll but return the real header and claim types

    token

    a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header

    key

    the key that will be used to check the token signature

    returns

    if successful, a tuple representing the header, the claim and eventually the signature

    Definition Classes
    JwtCore
  26. def decodeAll(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm]): Try[(H, C, String)]
    Definition Classes
    JwtCore
  27. def decodeAll(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Try[(H, C, String)]

    Same as decodeRawAll but return the real header and claim types

    Same as decodeRawAll but return the real header and claim types

    token

    a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header

    key

    the key that will be used to check the token signature

    algorithms

    a list of possible algorithms that the token can use. See Security concerns for more infos.

    returns

    if successful, a tuple representing the header, the claim and eventually the signature

    Definition Classes
    JwtCore
  28. def decodeAll(token: String, key: String, algorithms: => Seq[JwtAsymmetricAlgorithm]): Try[(H, C, String)]
    Definition Classes
    JwtCore
  29. def decodeAll(token: String, key: String, algorithms: => Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Try[(H, C, String)]

    Same as decodeRawAll but return the real header and claim types

    Same as decodeRawAll but return the real header and claim types

    token

    a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header

    key

    the key that will be used to check the token signature

    algorithms

    a list of possible algorithms that the token can use. See Security concerns for more infos.

    returns

    if successful, a tuple representing the header, the claim and eventually the signature

    Definition Classes
    JwtCore
  30. def decodeAll(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm]): Try[(H, C, String)]
    Definition Classes
    JwtCore
  31. def decodeAll(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Try[(H, C, String)]

    Same as decodeRawAll but return the real header and claim types

    Same as decodeRawAll but return the real header and claim types

    token

    a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header

    key

    the key that will be used to check the token signature

    algorithms

    a list of possible algorithms that the token can use. See Security concerns for more infos.

    returns

    if successful, a tuple representing the header, the claim and eventually the signature

    Definition Classes
    JwtCore
  32. def decodeAll(token: String): Try[(H, C, String)]
    Definition Classes
    JwtCore
  33. def decodeAll(token: String, options: JwtOptions): Try[(H, C, String)]

    Same as decodeRawAll but return the real header and claim types

    Same as decodeRawAll but return the real header and claim types

    token

    a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header

    returns

    if successful, a tuple representing the header, the claim and eventually the signature

    Definition Classes
    JwtCore
  34. def decodeJson(token: String, key: PublicKey): Try[Json]
    Definition Classes
    JwtJsonCommon
  35. def decodeJson(token: String, key: PublicKey, options: JwtOptions): Try[Json]
    Definition Classes
    JwtJsonCommon
  36. def decodeJson(token: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm]): Try[Json]
    Definition Classes
    JwtJsonCommon
  37. def decodeJson(token: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Try[Json]
    Definition Classes
    JwtJsonCommon
  38. def decodeJson(token: String, key: SecretKey): Try[Json]
    Definition Classes
    JwtJsonCommon
  39. def decodeJson(token: String, key: SecretKey, options: JwtOptions): Try[Json]
    Definition Classes
    JwtJsonCommon
  40. def decodeJson(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm]): Try[Json]
    Definition Classes
    JwtJsonCommon
  41. def decodeJson(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Try[Json]
    Definition Classes
    JwtJsonCommon
  42. def decodeJson(token: String, key: String, algorithms: => Seq[JwtAsymmetricAlgorithm]): Try[Json]
    Definition Classes
    JwtJsonCommon
  43. def decodeJson(token: String, key: String, algorithms: => Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Try[Json]
    Definition Classes
    JwtJsonCommon
  44. def decodeJson(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm]): Try[Json]
    Definition Classes
    JwtJsonCommon
  45. def decodeJson(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Try[Json]
    Definition Classes
    JwtJsonCommon
  46. def decodeJson(token: String): Try[Json]
    Definition Classes
    JwtJsonCommon
  47. def decodeJson(token: String, options: JwtOptions): Try[Json]
    Definition Classes
    JwtJsonCommon
  48. def decodeJsonAll(token: String, key: PublicKey): Try[(Json, Json, String)]
    Definition Classes
    JwtJsonCommon
  49. def decodeJsonAll(token: String, key: PublicKey, options: JwtOptions): Try[(Json, Json, String)]
    Definition Classes
    JwtJsonCommon
  50. def decodeJsonAll(token: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm]): Try[(Json, Json, String)]
    Definition Classes
    JwtJsonCommon
  51. def decodeJsonAll(token: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Try[(Json, Json, String)]
    Definition Classes
    JwtJsonCommon
  52. def decodeJsonAll(token: String, key: SecretKey): Try[(Json, Json, String)]
    Definition Classes
    JwtJsonCommon
  53. def decodeJsonAll(token: String, key: SecretKey, options: JwtOptions): Try[(Json, Json, String)]
    Definition Classes
    JwtJsonCommon
  54. def decodeJsonAll(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm]): Try[(Json, Json, String)]
    Definition Classes
    JwtJsonCommon
  55. def decodeJsonAll(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Try[(Json, Json, String)]
    Definition Classes
    JwtJsonCommon
  56. def decodeJsonAll(token: String, key: String, algorithms: => Seq[JwtAsymmetricAlgorithm]): Try[(Json, Json, String)]
    Definition Classes
    JwtJsonCommon
  57. def decodeJsonAll(token: String, key: String, algorithms: => Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Try[(Json, Json, String)]
    Definition Classes
    JwtJsonCommon
  58. def decodeJsonAll(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm]): Try[(Json, Json, String)]
    Definition Classes
    JwtJsonCommon
  59. def decodeJsonAll(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Try[(Json, Json, String)]
    Definition Classes
    JwtJsonCommon
  60. def decodeJsonAll(token: String): Try[(Json, Json, String)]
    Definition Classes
    JwtJsonCommon
  61. def decodeJsonAll(token: String, options: JwtOptions): Try[(Json, Json, String)]
    Definition Classes
    JwtJsonCommon
  62. def decodeRaw(token: String, key: PublicKey): Try[String]
    Definition Classes
    JwtCore
  63. def decodeRaw(token: String, key: PublicKey, options: JwtOptions): Try[String]

    Same as decodeRawAll but only return the claim (you only care about the claim most of the time)

    Same as decodeRawAll but only return the claim (you only care about the claim most of the time)

    token

    a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header

    key

    the key that will be used to check the token signature

    returns

    if successful, a string representing the JSON version of the claim

    Definition Classes
    JwtCore
  64. def decodeRaw(token: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm]): Try[String]
    Definition Classes
    JwtCore
  65. def decodeRaw(token: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Try[String]

    Same as decodeRawAll but only return the claim (you only care about the claim most of the time)

    Same as decodeRawAll but only return the claim (you only care about the claim most of the time)

    token

    a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header

    key

    the key that will be used to check the token signature

    algorithms

    a list of possible algorithms that the token can use. See Security concerns for more infos.

    returns

    if successful, a string representing the JSON version of the claim

    Definition Classes
    JwtCore
  66. def decodeRaw(token: String, key: SecretKey): Try[String]
    Definition Classes
    JwtCore
  67. def decodeRaw(token: String, key: SecretKey, options: JwtOptions): Try[String]

    Same as decodeRawAll but only return the claim (you only care about the claim most of the time)

    Same as decodeRawAll but only return the claim (you only care about the claim most of the time)

    token

    a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header

    key

    the key that will be used to check the token signature

    returns

    if successful, a string representing the JSON version of the claim

    Definition Classes
    JwtCore
  68. def decodeRaw(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm]): Try[String]
    Definition Classes
    JwtCore
  69. def decodeRaw(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Try[String]

    Same as decodeRawAll but only return the claim (you only care about the claim most of the time)

    Same as decodeRawAll but only return the claim (you only care about the claim most of the time)

    token

    a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header

    key

    the key that will be used to check the token signature

    algorithms

    a list of possible algorithms that the token can use. See Security concerns for more infos.

    returns

    if successful, a string representing the JSON version of the claim

    Definition Classes
    JwtCore
  70. def decodeRaw(token: String, key: String, algorithms: => Seq[JwtAsymmetricAlgorithm]): Try[String]
    Definition Classes
    JwtCore
  71. def decodeRaw(token: String, key: String, algorithms: => Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Try[String]

    Same as decodeRawAll but only return the claim (you only care about the claim most of the time)

    Same as decodeRawAll but only return the claim (you only care about the claim most of the time)

    token

    a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header

    key

    the key that will be used to check the token signature

    algorithms

    a list of possible algorithms that the token can use. See Security concerns for more infos.

    returns

    if successful, a string representing the JSON version of the claim

    Definition Classes
    JwtCore
  72. def decodeRaw(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm]): Try[String]
    Definition Classes
    JwtCore
  73. def decodeRaw(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Try[String]

    Same as decodeRawAll but only return the claim (you only care about the claim most of the time)

    Same as decodeRawAll but only return the claim (you only care about the claim most of the time)

    token

    a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header

    key

    the key that will be used to check the token signature

    algorithms

    a list of possible algorithms that the token can use. See Security concerns for more infos.

    returns

    if successful, a string representing the JSON version of the claim

    Definition Classes
    JwtCore
  74. def decodeRaw(token: String): Try[String]
    Definition Classes
    JwtCore
  75. def decodeRaw(token: String, options: JwtOptions): Try[String]

    Same as decodeRawAll but only return the claim (you only care about the claim most of the time)

    Same as decodeRawAll but only return the claim (you only care about the claim most of the time)

    token

    a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header

    returns

    if successful, a string representing the JSON version of the claim

    Definition Classes
    JwtCore
  76. def decodeRawAll(token: String, key: PublicKey): Try[(String, String, String)]
    Definition Classes
    JwtCore
  77. def decodeRawAll(token: String, key: PublicKey, options: JwtOptions): Try[(String, String, String)]
    Definition Classes
    JwtCore
  78. def decodeRawAll(token: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm]): Try[(String, String, String)]
    Definition Classes
    JwtCore
  79. def decodeRawAll(token: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Try[(String, String, String)]

    Will try to decode a JSON Web Token to raw strings using an asymmetric algorithm

    Will try to decode a JSON Web Token to raw strings using an asymmetric algorithm

    token

    a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header

    key

    the key that will be used to check the token signature

    algorithms

    a list of possible algorithms that the token can use. See Security concerns for more infos.

    returns

    if successful, a tuple of 3 strings, the header, the claim and the signature

    Definition Classes
    JwtCore
  80. def decodeRawAll(token: String, key: SecretKey): Try[(String, String, String)]
    Definition Classes
    JwtCore
  81. def decodeRawAll(token: String, key: SecretKey, options: JwtOptions): Try[(String, String, String)]
    Definition Classes
    JwtCore
  82. def decodeRawAll(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm]): Try[(String, String, String)]
    Definition Classes
    JwtCore
  83. def decodeRawAll(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Try[(String, String, String)]

    Will try to decode a JSON Web Token to raw strings using a HMAC algorithm

    Will try to decode a JSON Web Token to raw strings using a HMAC algorithm

    token

    a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header

    key

    the key that will be used to check the token signature

    algorithms

    a list of possible algorithms that the token can use. See Security concerns for more infos.

    returns

    if successful, a tuple of 3 strings, the header, the claim and the signature

    Definition Classes
    JwtCore
  84. def decodeRawAll(token: String, key: String, algorithms: => Seq[JwtAsymmetricAlgorithm]): Try[(String, String, String)]
    Definition Classes
    JwtCore
  85. def decodeRawAll(token: String, key: String, algorithms: => Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Try[(String, String, String)]

    Will try to decode a JSON Web Token to raw strings using an asymmetric algorithm

    Will try to decode a JSON Web Token to raw strings using an asymmetric algorithm

    token

    a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header

    key

    the key that will be used to check the token signature

    algorithms

    a list of possible algorithms that the token can use. See Security concerns for more infos.

    returns

    if successful, a tuple of 3 strings, the header, the claim and the signature

    Definition Classes
    JwtCore
  86. def decodeRawAll(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm]): Try[(String, String, String)]
    Definition Classes
    JwtCore
  87. def decodeRawAll(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Try[(String, String, String)]

    Will try to decode a JSON Web Token to raw strings using a HMAC algorithm

    Will try to decode a JSON Web Token to raw strings using a HMAC algorithm

    token

    a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header

    key

    the key that will be used to check the token signature

    algorithms

    a list of possible algorithms that the token can use. See Security concerns for more infos.

    returns

    if successful, a tuple of 3 strings, the header, the claim and the signature

    Definition Classes
    JwtCore
  88. def decodeRawAll(token: String): Try[(String, String, String)]
    Definition Classes
    JwtCore
  89. def decodeRawAll(token: String, options: JwtOptions): Try[(String, String, String)]

    Will try to decode a JSON Web Token to raw strings

    Will try to decode a JSON Web Token to raw strings

    token

    a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header

    returns

    if successful, a tuple of 3 strings, the header, the claim and the signature

    Definition Classes
    JwtCore
  90. def encode(claim: Json, key: PrivateKey, algorithm: JwtAsymmetricAlgorithm): String
    Definition Classes
    JwtJsonCommon
  91. def encode(claim: Json, key: SecretKey, algorithm: JwtHmacAlgorithm): String
    Definition Classes
    JwtJsonCommon
  92. def encode(claim: Json, key: String, algorithm: JwtAlgorithm): String
    Definition Classes
    JwtJsonCommon
  93. def encode(claim: Json): String
    Definition Classes
    JwtJsonCommon
  94. def encode(header: Json, claim: Json, key: Key): String
    Definition Classes
    JwtJsonCommon
  95. def encode(header: Json, claim: Json, key: String): String
    Definition Classes
    JwtJsonCommon
  96. def encode(header: Json, claim: Json): String
    Definition Classes
    JwtJsonCommon
  97. def encode(header: JwtHeader, claim: JwtClaim, key: Key): String

    An alias of encode if you only want to pass a string as the key, the algorithm will be deduced from the header.

    An alias of encode if you only want to pass a string as the key, the algorithm will be deduced from the header.

    header

    the header to stringify as a JSON before encoding the token

    claim

    the claim to stringify as a JSON before encoding the token

    key

    the secret key to use to sign the token (note that the algorithm will be deduced from the header)

    returns

    a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header

    Definition Classes
    JwtCore
  98. def encode(header: JwtHeader, claim: JwtClaim, key: String): String

    An alias of encode if you only want to pass a string as the key, the algorithm will be deduced from the header.

    An alias of encode if you only want to pass a string as the key, the algorithm will be deduced from the header.

    header

    the header to stringify as a JSON before encoding the token

    claim

    the claim to stringify as a JSON before encoding the token

    key

    the secret key to use to sign the token (note that the algorithm will be deduced from the header)

    returns

    a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header

    Definition Classes
    JwtCore
  99. def encode(header: JwtHeader, claim: JwtClaim): String

    An alias to encode if you want to use case classes for the header and the claim rather than strings, they will just be stringified to JSON format.

    An alias to encode if you want to use case classes for the header and the claim rather than strings, they will just be stringified to JSON format.

    header

    the header to stringify as a JSON before encoding the token

    claim

    the claim to stringify as a JSON before encoding the token

    returns

    a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header

    Definition Classes
    JwtCore
  100. def encode(claim: JwtClaim, key: PrivateKey, algorithm: JwtAsymmetricAlgorithm): String

    An alias to encode which will provide an automatically generated header and use the claim as a case class.

    An alias to encode which will provide an automatically generated header and use the claim as a case class.

    claim

    the claim of the JSON Web Token

    key

    the key that will be used to check the token signature

    algorithm

    the algorithm to sign the token

    returns

    a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header

    Definition Classes
    JwtCore
  101. def encode(claim: JwtClaim, key: SecretKey, algorithm: JwtHmacAlgorithm): String

    An alias to encode which will provide an automatically generated header and use the claim as a case class.

    An alias to encode which will provide an automatically generated header and use the claim as a case class.

    claim

    the claim of the JSON Web Token

    key

    the key that will be used to check the token signature

    algorithm

    the algorithm to sign the token

    returns

    a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header

    Definition Classes
    JwtCore
  102. def encode(claim: JwtClaim, key: String, algorithm: JwtAlgorithm): String

    An alias to encode which will provide an automatically generated header and use the claim as a case class.

    An alias to encode which will provide an automatically generated header and use the claim as a case class.

    claim

    the claim of the JSON Web Token

    key

    the key that will be used to check the token signature

    algorithm

    the algorithm to sign the token

    returns

    a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header

    Definition Classes
    JwtCore
  103. def encode(claim: JwtClaim): String

    An alias to encode which will provide an automatically generated header and setting both key and algorithm to None.

    An alias to encode which will provide an automatically generated header and setting both key and algorithm to None.

    claim

    the claim of the JSON Web Token

    returns

    a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header

    Definition Classes
    JwtCore
  104. def encode(claim: String, key: PrivateKey, algorithm: JwtAsymmetricAlgorithm): String

    An alias to encode which will provide an automatically generated header and allowing you to get rid of Option for the key and the algorithm.

    An alias to encode which will provide an automatically generated header and allowing you to get rid of Option for the key and the algorithm.

    claim

    a valid stringified JSON representing the claim of the token

    key

    the key that will be used to check the token signature

    algorithm

    the algorithm to sign the token

    returns

    a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header

    Definition Classes
    JwtCore
  105. def encode(claim: String, key: SecretKey, algorithm: JwtHmacAlgorithm): String

    An alias to encode which will provide an automatically generated header and allowing you to get rid of Option for the key and the algorithm.

    An alias to encode which will provide an automatically generated header and allowing you to get rid of Option for the key and the algorithm.

    claim

    a valid stringified JSON representing the claim of the token

    key

    the key that will be used to check the token signature

    algorithm

    the algorithm to sign the token

    returns

    a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header

    Definition Classes
    JwtCore
  106. def encode(claim: String, key: String, algorithm: JwtAlgorithm): String

    An alias to encode which will provide an automatically generated header and allowing you to get rid of Option for the key and the algorithm.

    An alias to encode which will provide an automatically generated header and allowing you to get rid of Option for the key and the algorithm.

    claim

    a valid stringified JSON representing the claim of the token

    key

    the key that will be used to check the token signature

    algorithm

    the algorithm to sign the token

    returns

    a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header

    Definition Classes
    JwtCore
  107. def encode(claim: String): String

    An alias to encode which will provide an automatically generated header.

    An alias to encode which will provide an automatically generated header.

    claim

    a valid stringified JSON representing the claim of the token

    returns

    a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header

    Definition Classes
    JwtCore
  108. def encode(header: String, claim: String, key: PrivateKey, algorithm: JwtAsymmetricAlgorithm): String
    Definition Classes
    JwtCore
  109. def encode(header: String, claim: String, key: SecretKey, algorithm: JwtHmacAlgorithm): String
    Definition Classes
    JwtCore
  110. def encode(header: String, claim: String, key: String, algorithm: JwtAlgorithm): String

    Encode a JSON Web Token from its different parts.

    Encode a JSON Web Token from its different parts. Both the header and the claim will be encoded to Base64 url-safe, then a signature will be eventually generated from it if you did pass a key and an algorithm, and finally, those three parts will be merged as a single string, using dots as separator.

    header

    a valid stringified JSON representing the header of the token

    claim

    a valid stringified JSON representing the claim of the token

    key

    the key that will be used to check the token signature

    algorithm

    the algorithm to sign the token

    returns

    a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header

    Definition Classes
    JwtCore
  111. def encode(header: String, claim: String): String
    Definition Classes
    JwtCore
  112. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  113. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  114. def extractAlgorithm(header: JwtHeader): Option[JwtAlgorithm]
    Attributes
    protected
    Definition Classes
    JwtJsonCommon
  115. def extractExpiration(claim: JwtClaim): Option[Long]
    Attributes
    protected
    Definition Classes
    JwtJsonCommon
  116. def extractNotBefore(claim: JwtClaim): Option[Long]
    Attributes
    protected
    Definition Classes
    JwtJsonCommon
  117. def getAlg(cursor: HCursor): Option[JwtAlgorithm]
    Attributes
    protected
  118. def getAlgorithm(header: Json): Option[JwtAlgorithm]
    Attributes
    protected
    Definition Classes
    JwtCirceParser → JwtJsonCommon
  119. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  120. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  121. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  122. def isValid(token: String, key: PublicKey): Boolean
    Definition Classes
    JwtCore
  123. def isValid(token: String, key: PublicKey, options: JwtOptions): Boolean
    Definition Classes
    JwtCore
  124. def isValid(token: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm]): Boolean
    Definition Classes
    JwtCore
  125. def isValid(token: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Boolean

    An alias for isValid if you want to directly pass a string as the key

    An alias for isValid if you want to directly pass a string as the key

    token

    a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header

    key

    the key that will be used to check the token signature

    algorithms

    a list of possible algorithms that the token can use. See Security concerns for more infos.

    returns

    a boolean value indicating if the token is valid or not

    Definition Classes
    JwtCore
  126. def isValid(token: String, key: SecretKey): Boolean
    Definition Classes
    JwtCore
  127. def isValid(token: String, key: SecretKey, options: JwtOptions): Boolean
    Definition Classes
    JwtCore
  128. def isValid(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm]): Boolean
    Definition Classes
    JwtCore
  129. def isValid(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Boolean

    An alias for isValid if you want to directly pass a string as the key

    An alias for isValid if you want to directly pass a string as the key

    token

    a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header

    key

    the key that will be used to check the token signature

    algorithms

    a list of possible algorithms that the token can use. See Security concerns for more infos.

    returns

    a boolean value indicating if the token is valid or not

    Definition Classes
    JwtCore
  130. def isValid(token: String, key: String, algorithms: => Seq[JwtAsymmetricAlgorithm]): Boolean
    Definition Classes
    JwtCore
  131. def isValid(token: String, key: String, algorithms: => Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Boolean

    An alias for isValid if you want to directly pass a string as the key for asymmetric algorithms

    An alias for isValid if you want to directly pass a string as the key for asymmetric algorithms

    token

    a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header

    key

    the key that will be used to check the token signature

    algorithms

    a list of possible algorithms that the token can use. See Security concerns for more infos.

    returns

    a boolean value indicating if the token is valid or not

    Definition Classes
    JwtCore
  132. def isValid(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm]): Boolean
    Definition Classes
    JwtCore
  133. def isValid(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Boolean

    An alias for isValid if you want to directly pass a string as the key for HMAC algorithms

    An alias for isValid if you want to directly pass a string as the key for HMAC algorithms

    token

    a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header

    key

    the key that will be used to check the token signature

    algorithms

    a list of possible algorithms that the token can use. See Security concerns for more infos.

    returns

    a boolean value indicating if the token is valid or not

    Definition Classes
    JwtCore
  134. def isValid(token: String): Boolean
    Definition Classes
    JwtCore
  135. def isValid(token: String, options: JwtOptions): Boolean

    Test if a token is valid.

    Test if a token is valid. Doesn't throw any exception.

    token

    a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header

    returns

    a boolean value indicating if the token is valid or not

    Definition Classes
    JwtCore
  136. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  137. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  138. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  139. def parse(value: String): Json
    Attributes
    protected
    Definition Classes
    JwtCirceParser → JwtJsonCommon
  140. def stringify(value: Json): String
    Attributes
    protected
    Definition Classes
    JwtCirceParser → JwtJsonCommon
  141. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  142. def toString(): String
    Definition Classes
    AnyRef → Any
  143. def validate(token: String, key: PublicKey): Unit
    Definition Classes
    JwtCore
  144. def validate(token: String, key: PublicKey, options: JwtOptions): Unit
    Definition Classes
    JwtCore
  145. def validate(token: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm]): Unit
    Definition Classes
    JwtCore
  146. def validate(token: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Unit

    An alias of validate in case you want to directly pass a string key.

    An alias of validate in case you want to directly pass a string key.

    token

    a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header

    key

    the key that will be used to check the token signature

    algorithms

    a list of possible algorithms that the token can use. See Security concerns for more infos.

    Definition Classes
    JwtCore
    Exceptions thrown

    IllegalArgumentException couldn't decode the token since it's not a valid base64 string

    JwtExpirationException the token isn't valid anymore because its expiration attribute is in the past

    JwtLengthException the number of parts separated by dots is wrong

    JwtNotBeforeException the token isn't valid yet because its notBefore attribute is in the future

    JwtValidationException default validation exception

  147. def validate(token: String, key: SecretKey): Unit
    Definition Classes
    JwtCore
  148. def validate(token: String, key: SecretKey, options: JwtOptions): Unit
    Definition Classes
    JwtCore
  149. def validate(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm]): Unit
    Definition Classes
    JwtCore
  150. def validate(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Unit

    An alias of validate in case you want to directly pass a string key.

    An alias of validate in case you want to directly pass a string key.

    token

    a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header

    key

    the key that will be used to check the token signature

    algorithms

    a list of possible algorithms that the token can use. See Security concerns for more infos.

    Definition Classes
    JwtCore
    Exceptions thrown

    IllegalArgumentException couldn't decode the token since it's not a valid base64 string

    JwtExpirationException the token isn't valid anymore because its expiration attribute is in the past

    JwtLengthException the number of parts separated by dots is wrong

    JwtNotBeforeException the token isn't valid yet because its notBefore attribute is in the future

    JwtValidationException default validation exception

  151. def validate(token: String, key: String, algorithms: => Seq[JwtAsymmetricAlgorithm]): Unit
    Definition Classes
    JwtCore
  152. def validate(token: String, key: String, algorithms: => Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Unit

    An alias of validate in case you want to directly pass a string key for asymmetric algorithms.

    An alias of validate in case you want to directly pass a string key for asymmetric algorithms.

    token

    a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header

    key

    the key that will be used to check the token signature

    algorithms

    a list of possible algorithms that the token can use. See Security concerns for more infos.

    Definition Classes
    JwtCore
    Exceptions thrown

    IllegalArgumentException couldn't decode the token since it's not a valid base64 string

    JwtExpirationException the token isn't valid anymore because its expiration attribute is in the past

    JwtLengthException the number of parts separated by dots is wrong

    JwtNotBeforeException the token isn't valid yet because its notBefore attribute is in the future

    JwtValidationException default validation exception

  153. def validate(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm]): Unit
    Definition Classes
    JwtCore
  154. def validate(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Unit

    An alias of validate in case you want to directly pass a string key for HMAC algorithms.

    An alias of validate in case you want to directly pass a string key for HMAC algorithms.

    token

    a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header

    key

    the key that will be used to check the token signature

    algorithms

    a list of possible algorithms that the token can use. See Security concerns for more infos.

    Definition Classes
    JwtCore
    Exceptions thrown

    IllegalArgumentException couldn't decode the token since it's not a valid base64 string

    JwtExpirationException the token isn't valid anymore because its expiration attribute is in the past

    JwtLengthException the number of parts separated by dots is wrong

    JwtNotBeforeException the token isn't valid yet because its notBefore attribute is in the future

    JwtValidationException default validation exception

  155. def validate(token: String): Unit
    Definition Classes
    JwtCore
  156. def validate(token: String, options: JwtOptions): Unit

    Valid a token: doesn't return anything but will thrown exceptions if there are any errors.

    Valid a token: doesn't return anything but will thrown exceptions if there are any errors.

    token

    a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header

    Definition Classes
    JwtCore
    Exceptions thrown

    IllegalArgumentException couldn't decode the token since it's not a valid base64 string

    JwtExpirationException the token isn't valid anymore because its expiration attribute is in the past

    JwtLengthException the number of parts separated by dots is wrong

    JwtNotBeforeException the token isn't valid yet because its notBefore attribute is in the future

    JwtValidationException default validation exception

  157. def validate(header64: String, header: H, claim64: String, claim: C, signature: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Unit
    Attributes
    protected
    Definition Classes
    JwtCore
  158. def validate(header64: String, header: H, claim64: String, claim: C, signature: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Unit
    Attributes
    protected
    Definition Classes
    JwtCore
  159. def validate(header64: String, header: H, claim64: String, claim: C, signature: String, key: String, algorithms: => Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Unit
    Attributes
    protected
    Definition Classes
    JwtCore
  160. def validate(header64: String, header: H, claim64: String, claim: C, signature: String, key: String, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Unit
    Attributes
    protected
    Definition Classes
    JwtCore
  161. def validate(header64: String, header: H, claim64: String, claim: C, signature: String, options: JwtOptions, verify: (Array[Byte], Array[Byte], JwtAlgorithm) => Boolean): Unit
    Attributes
    protected
    Definition Classes
    JwtCore
  162. def validate(header: H, claim: C, signature: String, options: JwtOptions): Unit
    Attributes
    protected
    Definition Classes
    JwtCore
  163. def validateAsymmetricAlgorithm(algorithm: JwtAsymmetricAlgorithm, algorithms: Seq[JwtAsymmetricAlgorithm]): Boolean
    Attributes
    protected
    Definition Classes
    JwtCore
  164. def validateHmacAlgorithm(algorithm: JwtHmacAlgorithm, algorithms: Seq[JwtHmacAlgorithm]): Boolean
    Attributes
    protected
    Definition Classes
    JwtCore
  165. def validateTiming(claim: C, options: JwtOptions): Try[Unit]
    Attributes
    protected
    Definition Classes
    JwtCore
  166. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  167. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  168. 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)

Inherited from JwtJsonCommon[Json, H, C]

Inherited from JwtCore[H, C]

Inherited from AnyRef

Inherited from Any

Ungrouped