jwt-core/pdi.jwt/JwtAlgorithm

JwtAlgorithm

object JwtAlgorithm
Companion:
class
trait Sum
trait Mirror
class Object
trait Matchable
class Any

Type members

Classlikes

case object ES256 extends JwtECDSAAlgorithm
case object ES384 extends JwtECDSAAlgorithm
case object ES512 extends JwtECDSAAlgorithm
case object Ed25519 extends JwtEdDSAAlgorithm
case object HMD5 extends JwtHmacAlgorithm
case object HS224 extends JwtHmacAlgorithm
case object HS256 extends JwtHmacAlgorithm
case object HS384 extends JwtHmacAlgorithm
case object HS512 extends JwtHmacAlgorithm
case object RS256 extends JwtRSAAlgorithm
case object RS384 extends JwtRSAAlgorithm
case object RS512 extends JwtRSAAlgorithm

Inherited types

type MirroredElemLabels <: Tuple

The names of the product elements

The names of the product elements

Inherited from:
Mirror
type MirroredLabel <: String

The name of the type

The name of the type

Inherited from:
Mirror

Value members

Concrete methods

def fromString(algo: String): JwtAlgorithm

Deserialize an algorithm from its string equivalent. Only real algorithms supported, if you need to support "none", use "optionFromString".

Deserialize an algorithm from its string equivalent. Only real algorithms supported, if you need to support "none", use "optionFromString".

Value parameters:
algo

the name of the algorithm (e.g. HS256 or HmacSHA256)

Returns:

the actual instance of the algorithm

Throws:
JwtNonSupportedAlgorithm

in case the string doesn't match any known algorithm

def optionFromString(algo: String): Option[JwtAlgorithm]

Deserialize an algorithm from its string equivalent. If it's the special "none" algorithm, return None, else, return Some with the corresponding algorithm inside.

Deserialize an algorithm from its string equivalent. If it's the special "none" algorithm, return None, else, return Some with the corresponding algorithm inside.

Value parameters:
algo

the name of the algorithm (e.g. none, HS256 or HmacSHA256)

Returns:

the actual instance of the algorithm