JWSAlg (com.authlete:authlete-java-common 2.51 API)

java.lang.Object
- java.lang.Enum<JWSAlg>
- - com.authlete.common.types.JWSAlg

All Implemented Interfaces:

Serializable, Comparable<JWSAlg>
```
public enum JWSAlg
extends Enum<JWSAlg>
```
"alg" (Algorithm) Header Parameter Values for JWS.

See Also:

RFC 7518, 3.1. "alg" (Algorithm) Header Parameter Values for JWS

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ES256` `"ES256"` (7); ECDSA using P-256 and SHA-256.
`ES384` `"ES384"` (8); ECDSA using P-384 and SHA-384.
`ES512` `"ES512"` (9); ECDSA using P-521 and SHA-512.
`HS256` `"HS256"` (1); HMAC using SHA-256.
`HS384` `"HS384"` (2); HMAC using SHA-384.
`HS512` `"HS512"` (3); HMAC using SHA-512.
`NONE` `"none"` (0); No digital signature or MAC performed.
`PS256` `"PS256"` (10); RSASSA-PSS using SHA-256 and MGF1 with SHA-256.
`PS384` `"PS384"` (11); RSASSA-PSS using SHA-384 and MGF1 with SHA-384.
`PS512` `"PS512"` (12); RSASSA-PSS using SHA-512 and MGF1 with SHA-512.
`RS256` `"RS256"` (4); RSASSA-PKCS-v1_5 using SHA-256.
`RS384` `"RS384"` (5); RSASSA-PKCS-v1_5 using SHA-384.
`RS512` `"RS512"` (6); RSASSA-PKCS-v1_5 using SHA-512.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static JWSAlg`	`getByValue(short value)` Find an instance of this enum by a value.
`HashAlg`	`getHashAlg()` Get the hash algorithm used by this signature algorithm.
`String`	`getName()` Get the name of this algorithm.
`short`	`getValue()` Get the integer representation of this enum instance.
`boolean`	`isAsymmetric()` Check if this algorithm is an asymmetric one.
`static boolean`	`isAsymmetric(JWSAlg alg)` Check if the given JWS algorithm is an asymmetric one.
`boolean`	`isSymmetric()` Check if this algorithm is a symmetric one.
`static boolean`	`isSymmetric(JWSAlg alg)` Check if the given JWS algorithm is a symmetric one.
`static JWSAlg`	`parse(String alg)` Convert `String` to `JWSAlg`.
`static JWSAlg[]`	`toArray(int bits)`
`static int`	`toBits(EnumSet<JWSAlg> set)`
`static EnumSet<JWSAlg>`	`toSet(int bits)`
`static EnumSet<JWSAlg>`	`toSet(JWSAlg[] array)`
`String`	`toString()`
`static JWSAlg`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static JWSAlg[]`	`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
```
public static final JWSAlg NONE
```
    "none" (0); No digital signature or MAC performed.
  - HS256
```
public static final JWSAlg HS256
```
    "HS256" (1); HMAC using SHA-256.
  - HS384
```
public static final JWSAlg HS384
```
    "HS384" (2); HMAC using SHA-384.
  - HS512
```
public static final JWSAlg HS512
```
    "HS512" (3); HMAC using SHA-512.
  - RS256
```
public static final JWSAlg RS256
```
    "RS256" (4); RSASSA-PKCS-v1_5 using SHA-256.
  - RS384
```
public static final JWSAlg RS384
```
    "RS384" (5); RSASSA-PKCS-v1_5 using SHA-384.
  - RS512
```
public static final JWSAlg RS512
```
    "RS512" (6); RSASSA-PKCS-v1_5 using SHA-512.
  - ES256
```
public static final JWSAlg ES256
```
    "ES256" (7); ECDSA using P-256 and SHA-256.
  - ES384
```
public static final JWSAlg ES384
```
    "ES384" (8); ECDSA using P-384 and SHA-384.
  - ES512
```
public static final JWSAlg ES512
```
    "ES512" (9); ECDSA using P-521 and SHA-512.
  - PS256
```
public static final JWSAlg PS256
```
    "PS256" (10); RSASSA-PSS using SHA-256 and MGF1 with SHA-256.
  - PS384
```
public static final JWSAlg PS384
```
    "PS384" (11); RSASSA-PSS using SHA-384 and MGF1 with SHA-384.
  - PS512
```
public static final JWSAlg PS512
```
    "PS512" (12); RSASSA-PSS using SHA-512 and MGF1 with SHA-512.
- Method Detail
  - values
```
public static JWSAlg[] 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 (JWSAlg c : JWSAlg.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static JWSAlg 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
  - getName
```
public String getName()
```
    Get the name of this algorithm. One of the values listed in the table in 3.1. "alg" (Algorithm) Header Parameter Values for JWS of RFC 7518 is returned.
    
    Returns:
    
    The name of this algorithm.
    
    Since:
    
    2.17
  - getValue
```
public short getValue()
```
    Get the integer representation of this enum instance.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Enum<JWSAlg>
  - getHashAlg
```
public HashAlg getHashAlg()
```
    Get the hash algorithm used by this signature algorithm.
    
    Returns:
    
    The hash algorithm. NONE returns null.
  - getByValue
```
public static JWSAlg getByValue(short value)
```
    Find an instance of this enum by a value.
    
    Parameters:
    
    value - The integer representation of the instance to find.
    
    Returns:
    
    An instance of this enum, or null if not found.
  - parse
```
public static JWSAlg parse(String alg)
```
    Convert String to JWSAlg.
    
    Parameters:
    
    alg - Algorithm name. For example, "HS256".
    
    Returns:
    
    JWSAlg instance, or null.
  - toBits
```
public static int toBits(EnumSet<JWSAlg> set)
```
  - toArray
```
public static JWSAlg[] toArray(int bits)
```
  - toSet
```
public static EnumSet<JWSAlg> toSet(int bits)
```
  - toSet
```
public static EnumSet<JWSAlg> toSet(JWSAlg[] array)
```
  - isSymmetric
```
public static boolean isSymmetric(JWSAlg alg)
```
    Check if the given JWS algorithm is a symmetric one.
    
    Parameters:
    
    alg - JWS algorithm.
    
    Returns:
    
    true if the given JWS algorithm is symmetric. To be concrete, true is returned when alg is HS256, HS384 or HS512.
    
    Since:
    
    2.12
  - isAsymmetric
```
public static boolean isAsymmetric(JWSAlg alg)
```
    Check if the given JWS algorithm is an asymmetric one.
    
    Parameters:
    
    alg - JWS algorithm.
    
    Returns:
    
    true if the given JWS algorithm is asymmetric. To be concrete, true is returned when alg is RS256, RS384, RS512, PS256, PS384, PS512, ES256, ES384 or ES512.
    
    Since:
    
    2.12
  - isSymmetric
```
public boolean isSymmetric()
```
    Check if this algorithm is a symmetric one.
    
    Returns:
    
    true if this algorithm is symmetric. To be concrete, true is returned when this is is HS256, HS384 or HS512.
    
    Since:
    
    2.16
  - isAsymmetric
```
public boolean isAsymmetric()
```
    Check if this algorithm is an asymmetric one.
    
    Returns:
    
    true if this algorithm is asymmetric. To be concrete, true is returned when this is RS256, RS384, RS512, PS256, PS384, PS512, ES256, ES384 or ES512.
    
    Since:
    
    2.16

Enum JWSAlg

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

NONE

HS256

HS384

HS512

RS256

RS384

RS512

ES256

ES384

ES512

PS256

PS384

PS512

Method Detail

values

valueOf

getName

getValue

toString

getHashAlg

getByValue

parse

toBits

toArray

toSet

toSet

isSymmetric

isAsymmetric

isSymmetric

isAsymmetric