JweAlgorithm (OpenDJ Public API Javadoc 6.5.6 Documentation)

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 and Description
`A128KW` AES-128 KeyWrap.
`A192KW` AES-192 KeyWrap.
`A256KW` AES-256 KeyWrap.
`DIRECT` Direct encryption with a shared symmetric key.
`ECDH_ES` Elliptic Curve Diffie-Hellman (ECDH) key agreement, directly using the derived key for encryption.
`ECDH_ES_A128KW` Elliptic Curve Diffie-Hellman (ECDH) key agreement using the derived key for 128-bit AES Key Wrapping.
`ECDH_ES_A192KW` Elliptic Curve Diffie-Hellman (ECDH) key agreement using the derived key for 192-bit AES Key Wrapping.
`ECDH_ES_A256KW` Elliptic Curve Diffie-Hellman (ECDH) key agreement using the derived key for 256-bit AES Key Wrapping.
`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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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.
`JweAlgorithm`	`getKeyWrappingAlgorithm()` For ECDH-ES key agreement modes, this indicates the key wrapping mode that should be applied to the resulting derived key.
`static JweAlgorithm`	`parseAlgorithm(String jwaAlgorithmName)` Parses the given algorithm string to find the matching Jwe algorithm 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 Detail
  - 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.
  - ECDH_ES
```
public static final JweAlgorithm ECDH_ES
```
    Elliptic Curve Diffie-Hellman (ECDH) key agreement, directly using the derived key for encryption.
  - ECDH_ES_A128KW
```
public static final JweAlgorithm ECDH_ES_A128KW
```
    Elliptic Curve Diffie-Hellman (ECDH) key agreement using the derived key for 128-bit AES Key Wrapping.
  - ECDH_ES_A192KW
```
public static final JweAlgorithm ECDH_ES_A192KW
```
    Elliptic Curve Diffie-Hellman (ECDH) key agreement using the derived key for 192-bit AES Key Wrapping.
  - ECDH_ES_A256KW
```
public static final JweAlgorithm ECDH_ES_A256KW
```
    Elliptic Curve Diffie-Hellman (ECDH) key agreement using the derived key for 256-bit AES Key Wrapping.
- Method Detail
  - values
```
public static JweAlgorithm[] 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 (JweAlgorithm c : JweAlgorithm.values())
    System.out.println(c);
```
    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.
  - getKeyWrappingAlgorithm
```
public JweAlgorithm getKeyWrappingAlgorithm()
```
    For ECDH-ES key agreement modes, this indicates the key wrapping mode that should be applied to the resulting derived key. This will either be the DIRECT mode or one of the A128KW, A192KW or A256KW symmetric key wrapping modes. For non-ECDH modes this will always be null.
    
    Returns:
    
    the ECDH key wrapping algorithm to use or null if this is not a key agreement mode.
  - getAlgorithmType
```
public JweAlgorithmType getAlgorithmType()
```
    Gets the JweAlgorithmType of the JweAlgorithm.
    
    Returns:
    
    The JweAlgorithmType.
  - parseAlgorithm
```
public static JweAlgorithm parseAlgorithm(String jwaAlgorithmName)
```
    Parses the given algorithm string to find the matching Jwe algorithm enum constant.
    
    Parameters:
    
    jwaAlgorithmName - The encryption JWA algorithm name.
    
    Returns:
    
    The JweAlgorithm enum.
  - toString
```
public String toString()
```
    Turns the JweAlgorithm constant into a JSON value string.
    
    Overrides:
    
    toString in class Enum<JweAlgorithm>
    
    Returns:

Enum JweAlgorithm

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

RSAES_PKCS1_V1_5

RSA_OAEP

RSA_OAEP_256

DIRECT

A128KW

A192KW

A256KW

ECDH_ES

ECDH_ES_A128KW

ECDH_ES_A192KW

ECDH_ES_A256KW

Method Detail

values

valueOf

getAlgorithm

getJwaAlgorithmName

getKeyWrappingAlgorithm

getAlgorithmType

parseAlgorithm

toString