java.lang.Object
- java.lang.Enum<Algorithm>
- - io.jans.as.model.jwk.Algorithm

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Algorithm>
```
public enum Algorithm
extends java.lang.Enum<Algorithm>
```
Identifies the cryptographic algorithm used with the key.

Version:

September 13, 2021

Author:

Javier Rojas Blum, Sergey Manoylo

Enum Constant Summary

Enum Constants
Enum Constant	Description
`A128GCMKW`
`A128KW`
`A192GCMKW`
`A192KW`
`A256GCMKW`
`A256KW`
`ECDH_ES`
`ECDH_ES_PLUS_A128KW`
`ECDH_ES_PLUS_A192KW`
`ECDH_ES_PLUS_A256KW`
`ED25519`
`ED448`
`ES256`
`ES256K`
`ES384`
`ES512`
`PBES2_HS256_PLUS_A128KW`
`PBES2_HS384_PLUS_A192KW`
`PBES2_HS512_PLUS_A256KW`
`PS256`
`PS384`
`PS512`
`RS256`
`RS384`
`RS512`
`RSA_OAEP`
`RSA_OAEP_256`
`RSA1_5`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static Algorithm`	`fromString(java.lang.String param)`	Returns the corresponding `Algorithm` for a parameter.
`static java.util.List<Algorithm>`	`fromString(java.lang.String[] params, Use use)`
`AlgorithmFamily`	`getFamily()`
`java.lang.String`	`getParamName()`
`Use`	`getUse()`
`java.lang.String`	`toString()`	Returns a string representation of the object.
`static Algorithm`	`valueOf(java.lang.String name)`	Returns the enum constant of this type with the specified name.
`static Algorithm[]`	`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

RS256
```
public static final Algorithm RS256
```

RS384
```
public static final Algorithm RS384
```

RS512
```
public static final Algorithm RS512
```

ES256
```
public static final Algorithm ES256
```

ES256K
```
public static final Algorithm ES256K
```

ES384
```
public static final Algorithm ES384
```

ES512
```
public static final Algorithm ES512
```

PS256
```
public static final Algorithm PS256
```

PS384
```
public static final Algorithm PS384
```

PS512
```
public static final Algorithm PS512
```

ED25519
```
public static final Algorithm ED25519
```

ED448
```
public static final Algorithm ED448
```

RSA1_5
```
public static final Algorithm RSA1_5
```

RSA_OAEP
```
public static final Algorithm RSA_OAEP
```

RSA_OAEP_256

public static final Algorithm RSA_OAEP_256

ECDH_ES
```
public static final Algorithm ECDH_ES
```

ECDH_ES_PLUS_A128KW

public static final Algorithm ECDH_ES_PLUS_A128KW

ECDH_ES_PLUS_A192KW

public static final Algorithm ECDH_ES_PLUS_A192KW

ECDH_ES_PLUS_A256KW

public static final Algorithm ECDH_ES_PLUS_A256KW

A128KW
```
public static final Algorithm A128KW
```

A192KW
```
public static final Algorithm A192KW
```

A256KW
```
public static final Algorithm A256KW
```

A128GCMKW

public static final Algorithm A128GCMKW

A192GCMKW

public static final Algorithm A192GCMKW

A256GCMKW

public static final Algorithm A256GCMKW

PBES2_HS256_PLUS_A128KW

public static final Algorithm PBES2_HS256_PLUS_A128KW

PBES2_HS384_PLUS_A192KW

public static final Algorithm PBES2_HS384_PLUS_A192KW

PBES2_HS512_PLUS_A256KW

public static final Algorithm PBES2_HS512_PLUS_A256KW

Method Detail
- values
```
public static Algorithm[] 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 (Algorithm c : Algorithm.values())
    System.out.println(c);
```
  Returns:
  
  an array containing the constants of this enum type, in the order they are declared
- valueOf
```
public static Algorithm valueOf(java.lang.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:
  
  java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
  
  java.lang.NullPointerException - if the argument is null
- getParamName
```
public java.lang.String getParamName()
```
- getUse
```
public Use getUse()
```
- getFamily
```
public AlgorithmFamily getFamily()
```
- fromString
```
public static Algorithm fromString(java.lang.String param)
```
  Returns the corresponding Algorithm for a parameter.
  
  Parameters:
  
  param - The use parameter.
  
  Returns:
  
  The corresponding algorithm if found, otherwise null.
- fromString
```
public static java.util.List<Algorithm> fromString(java.lang.String[] params,
                                                   Use use)
```
- toString
```
public java.lang.String toString()
```
  Returns a string representation of the object. In this case the parameter name.
  
  Overrides:
  
  toString in class java.lang.Enum<Algorithm>
  
  Returns:
  
  The string representation of the object.

Enum Algorithm

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

RS256

RS384

RS512

ES256

ES256K

ES384

ES512

PS256

PS384

PS512

ED25519

ED448

RSA1_5

RSA_OAEP

RSA_OAEP_256

ECDH_ES

ECDH_ES_PLUS_A128KW

ECDH_ES_PLUS_A192KW

ECDH_ES_PLUS_A256KW

A128KW

A192KW

A256KW

A128GCMKW

A192GCMKW

A256GCMKW

PBES2_HS256_PLUS_A128KW

PBES2_HS384_PLUS_A192KW

PBES2_HS512_PLUS_A256KW

Method Detail

values

valueOf

getParamName

getUse

getFamily

fromString

fromString

toString