Package org.forgerock.json.jose.jws

Enum JwsAlgorithmType

java.lang.Object

java.lang.Enum<JwsAlgorithmType>

org.forgerock.json.jose.jws.JwsAlgorithmType

All Implemented Interfaces:

Serializable, Comparable<JwsAlgorithmType>

public enum JwsAlgorithmType
extends Enum<JwsAlgorithmType>

An Enum of the possible types of JWS algorithms that can be used to sign a JWT.

Since:

2.0.0

See Also:

JwsAlgorithm

Enum Constant Summary

Enum Constants

Enum Constant	Description
ECDSA	Elliptic Curve DSA signing algorithm.
EDDSA	Edwards Curve DSA signing algorithm.
HMAC	HMAC signing algorithm.
NONE	Deprecated. This algorithm is inherently insecure and shouldn't be used.
RSA	RSA signing algorithm.

Method Summary

Modifier and Type	Method	Description
boolean	isSymmetric()	Indicates whether the algorithm type is a symmetric (secret key) algorithm like HMAC or a public key algorithm.
String	toString()	Turns the JwsAlgorithmType constant into a JSON value string.
static JwsAlgorithmType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static JwsAlgorithmType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

@Deprecated
public static final JwsAlgorithmType NONE

Deprecated.

This algorithm is inherently insecure and shouldn't be used.

No digital signature or MAC value included.

HMAC

public static final JwsAlgorithmType HMAC

HMAC signing algorithm.

RSA

public static final JwsAlgorithmType RSA

RSA signing algorithm.

ECDSA

public static final JwsAlgorithmType ECDSA

Elliptic Curve DSA signing algorithm.

EDDSA

public static final JwsAlgorithmType EDDSA

Edwards Curve DSA signing algorithm. See RFC 8037.

Method Detail

values

public static JwsAlgorithmType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (JwsAlgorithmType c : JwsAlgorithmType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static JwsAlgorithmType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

isSymmetric

public boolean isSymmetric()

Indicates whether the algorithm type is a symmetric (secret key) algorithm like HMAC or a public key algorithm. Note: the special value NONE is treated as a symmetric algorithm by this method, but it doesn't use a key at all.

Returns:

true if the algorithm type uses a shared secret key for signing and verification or false if it uses distinct private and public keys for these operations.

toString

public String toString()

Turns the JwsAlgorithmType constant into a JSON value string.

Overrides:

toString in class Enum<JwsAlgorithmType>

Returns: