Package org.forgerock.json.jose.jwe

Enum JweAlgorithm

java.lang.Object

java.lang.Enum<JweAlgorithm>

org.forgerock.json.jose.jwe.JweAlgorithm

All Implemented Interfaces:

Serializable, Comparable<JweAlgorithm>, Algorithm

public enum JweAlgorithm
extends Enum<JweAlgorithm>
implements Algorithm

An Enum of the possible encryption algorithms that can be used to encrypt a JWT.

Since:

2.0.0

See Also:

• JWE Algorithms

Enum Constant Summary

Enum Constants

Enum Constant	Description
A128KW	AES-128 KeyWrap.
A192KW	AES-192 KeyWrap.
A256KW	AES-256 KeyWrap.
DIRECT	Direct encryption with a shared symmetric key.
RSA_OAEP	RSA in ECB mode with OAEP with SHA-1 and MGF1 padding.
RSA_OAEP_256	RSA in ECB mode with OAEP with SHA-256 and MGF1 with SHA-256 padding.
RSAES_PKCS1_V1_5	RSA in ECB mode with PKCS1 Padding.

Method Summary

Modifier and Type	Method	Description
String	getAlgorithm()	Gets the actual name of the algorithm that is understood by Java cryptographic operations.
JweAlgorithmType	getAlgorithmType()	Gets the JweAlgorithmType of the JweAlgorithm.
String	getJwaAlgorithmName()	Gets the name of the algorithm as defined in the JWA standard.
static JweAlgorithm	parseAlgorithm(String algorithm)	Parses the given algorithm string to find the matching EncryptionMethod enum constant.
String	toString()	Turns the JweAlgorithm constant into a JSON value string.
static JweAlgorithm	valueOf(String name)	Returns the enum constant of this type with the specified name.
static JweAlgorithm[]	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 Details

RSAES_PKCS1_V1_5

public static final JweAlgorithm RSAES_PKCS1_V1_5

RSA in ECB mode with PKCS1 Padding.

RSA_OAEP

public static final JweAlgorithm RSA_OAEP

RSA in ECB mode with OAEP with SHA-1 and MGF1 padding.

RSA_OAEP_256

public static final JweAlgorithm RSA_OAEP_256

RSA in ECB mode with OAEP with SHA-256 and MGF1 with SHA-256 padding.

DIRECT

public static final JweAlgorithm DIRECT

Direct encryption with a shared symmetric key.

A128KW

public static final JweAlgorithm A128KW

AES-128 KeyWrap.

A192KW

public static final JweAlgorithm A192KW

AES-192 KeyWrap.

A256KW

public static final JweAlgorithm A256KW

AES-256 KeyWrap.

Method Details

values

public static JweAlgorithm[] values()

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

Returns:

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

valueOf

public static JweAlgorithm 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

getAlgorithm

public String getAlgorithm()

Description copied from interface: Algorithm

Gets the actual name of the algorithm that is understood by Java cryptographic operations.

Specified by:

getAlgorithm in interface Algorithm

Returns:

The name of the algorithm.

getJwaAlgorithmName

public String getJwaAlgorithmName()

Description copied from interface: Algorithm

Gets the name of the algorithm as defined in the JWA standard.

Specified by:

getJwaAlgorithmName in interface Algorithm

Returns:

The name of the algorithm.

getAlgorithmType

public JweAlgorithmType getAlgorithmType()

Gets the JweAlgorithmType of the JweAlgorithm.

Returns:

The JweAlgorithmType.

parseAlgorithm

public static JweAlgorithm parseAlgorithm(String algorithm)

Parses the given algorithm string to find the matching EncryptionMethod enum constant.

Parameters:

algorithm - The encryption algorithm.

Returns:

The JweAlgorithm enum.

toString

public String toString()

Turns the JweAlgorithm constant into a JSON value string.

Overrides:

toString in class Enum<JweAlgorithm>

Returns: