SignatureAlgorithm (JSON Web Token support for the JVM 0.4 API)

java.lang.Object
- java.lang.Enum<SignatureAlgorithm>
- - io.jsonwebtoken.SignatureAlgorithm

All Implemented Interfaces:

Serializable, Comparable<SignatureAlgorithm>
```
public enum SignatureAlgorithm
extends Enum<SignatureAlgorithm>
```
Type-safe representation of standard JWT signature algorithm names as defined in the JSON Web Algorithms specification.

Since:

0.1

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ES256` JWA algorithm name for `ECDSA using P-256 and SHA-256`.
`ES384` JWA algorithm name for `ECDSA using P-384 and SHA-384`.
`ES512` JWA algorithm name for `ECDSA using P-512 and SHA-512`.
`HS256` JWA algorithm name for `HMAC using SHA-256`
`HS384` JWA algorithm name for `HMAC using SHA-384`
`HS512` JWA algorithm name for `HMAC using SHA-512`
`NONE` JWA name for `No digital signature or MAC performed`
`PS256` JWA algorithm name for `RSASSA-PSS using SHA-256 and MGF1 with SHA-256`.
`PS384` JWA algorithm name for `RSASSA-PSS using SHA-384 and MGF1 with SHA-384`.
`PS512` JWA algorithm name for `RSASSA-PSS using SHA-512 and MGF1 with SHA-512`.
`RS256` JWA algorithm name for `RSASSA-PKCS-v1_5 using SHA-256`
`RS384` JWA algorithm name for `RSASSA-PKCS-v1_5 using SHA-384`
`RS512` JWA algorithm name for `RSASSA-PKCS-v1_5 using SHA-512`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static SignatureAlgorithm`	`forName(String value)` Looks up and returns the corresponding `SignatureAlgorithm` enum instance based on a case-insensitive name comparison.
`String`	`getDescription()` Returns the JWA algorithm description.
`String`	`getJcaName()` Returns the name of the JCA algorithm used to compute the signature.
`String`	`getValue()` Returns the JWA algorithm name constant.
`boolean`	`isEllipticCurve()` Returns `true` if the enum instance represents an Elliptic Curve signature algorithm, `false` otherwise.
`boolean`	`isHmac()` Returns `true` if the enum instance represents an HMAC signature algorithm, `false` otherwise.
`boolean`	`isJdkStandard()` Returns `true` if the algorithm is supported by standard JDK distributions or `false` if the algorithm implementation is not in the JDK and must be provided by a separate runtime JCA Provider (like BouncyCastle for example).
`boolean`	`isRsa()` Returns `true` if the enum instance represents an RSA public/private key pair signature algorithm, `false` otherwise.
`static SignatureAlgorithm`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static SignatureAlgorithm[]`	`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, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - NONE
```
public static final SignatureAlgorithm NONE
```
    JWA name for No digital signature or MAC performed
  - HS256
```
public static final SignatureAlgorithm HS256
```
    JWA algorithm name for HMAC using SHA-256
  - HS384
```
public static final SignatureAlgorithm HS384
```
    JWA algorithm name for HMAC using SHA-384
  - HS512
```
public static final SignatureAlgorithm HS512
```
    JWA algorithm name for HMAC using SHA-512
  - RS256
```
public static final SignatureAlgorithm RS256
```
    JWA algorithm name for RSASSA-PKCS-v1_5 using SHA-256
  - RS384
```
public static final SignatureAlgorithm RS384
```
    JWA algorithm name for RSASSA-PKCS-v1_5 using SHA-384
  - RS512
```
public static final SignatureAlgorithm RS512
```
    JWA algorithm name for RSASSA-PKCS-v1_5 using SHA-512
  - ES256
```
public static final SignatureAlgorithm ES256
```
    JWA algorithm name for ECDSA using P-256 and SHA-256. This is not a JDK standard algorithm and requires that a JCA provider like BouncyCastle be in the runtime classpath. BouncyCastle will be used automatically if found in the runtime classpath.
  - ES384
```
public static final SignatureAlgorithm ES384
```
    JWA algorithm name for ECDSA using P-384 and SHA-384. This is not a JDK standard algorithm and requires that a JCA provider like BouncyCastle be in the runtime classpath. BouncyCastle will be used automatically if found in the runtime classpath.
  - ES512
```
public static final SignatureAlgorithm ES512
```
    JWA algorithm name for ECDSA using P-512 and SHA-512. This is not a JDK standard algorithm and requires that a JCA provider like BouncyCastle be in the runtime classpath. BouncyCastle will be used automatically if found in the runtime classpath.
  - PS256
```
public static final SignatureAlgorithm PS256
```
    JWA algorithm name for RSASSA-PSS using SHA-256 and MGF1 with SHA-256. This is not a JDK standard algorithm and requires that a JCA provider like BouncyCastle be in the runtime classpath. BouncyCastle will be used automatically if found in the runtime classpath.
  - PS384
```
public static final SignatureAlgorithm PS384
```
    JWA algorithm name for RSASSA-PSS using SHA-384 and MGF1 with SHA-384. This is not a JDK standard algorithm and requires that a JCA provider like BouncyCastle be in the runtime classpath. BouncyCastle will be used automatically if found in the runtime classpath.
  - PS512
```
public static final SignatureAlgorithm PS512
```
    JWA algorithm name for RSASSA-PSS using SHA-512 and MGF1 with SHA-512. This is not a JDK standard algorithm and requires that a JCA provider like BouncyCastle be in the classpath. BouncyCastle will be used automatically if found in the runtime classpath.
- Method Detail
  - values
```
public static SignatureAlgorithm[] 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 (SignatureAlgorithm c : SignatureAlgorithm.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static SignatureAlgorithm 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
  - getValue
```
public String getValue()
```
    Returns the JWA algorithm name constant.
    
    Returns:
    
    the JWA algorithm name constant.
  - getDescription
```
public String getDescription()
```
    Returns the JWA algorithm description.
    
    Returns:
    
    the JWA algorithm description.
  - getJcaName
```
public String getJcaName()
```
    Returns the name of the JCA algorithm used to compute the signature.
    
    Returns:
    
    the name of the JCA algorithm used to compute the signature.
  - isJdkStandard
```
public boolean isJdkStandard()
```
    Returns true if the algorithm is supported by standard JDK distributions or false if the algorithm implementation is not in the JDK and must be provided by a separate runtime JCA Provider (like BouncyCastle for example).
    
    Returns:
    
    true if the algorithm is supported by standard JDK distributions or false if the algorithm implementation is not in the JDK and must be provided by a separate runtime JCA Provider (like BouncyCastle for example).
  - isHmac
```
public boolean isHmac()
```
    Returns true if the enum instance represents an HMAC signature algorithm, false otherwise.
    
    Returns:
    
    true if the enum instance represents an HMAC signature algorithm, false otherwise.
  - isRsa
```
public boolean isRsa()
```
    Returns true if the enum instance represents an RSA public/private key pair signature algorithm, false otherwise.
    
    Returns:
    
    true if the enum instance represents an RSA public/private key pair signature algorithm, false otherwise.
  - isEllipticCurve
```
public boolean isEllipticCurve()
```
    Returns true if the enum instance represents an Elliptic Curve signature algorithm, false otherwise.
    
    Returns:
    
    true if the enum instance represents an Elliptic Curve signature algorithm, false otherwise.
  - forName
```
public static SignatureAlgorithm forName(String value)
                                  throws SignatureException
```
    Looks up and returns the corresponding SignatureAlgorithm enum instance based on a case-insensitive name comparison.
    
    Parameters:
    
    value - The case-insensitive name of the SignatureAlgorithm instance to return
    
    Returns:
    
    the corresponding SignatureAlgorithm enum instance based on a case-insensitive name comparison.
    
    Throws:
    
    SignatureException - if the specified value does not match any SignatureAlgorithm name.

Enum SignatureAlgorithm

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

getValue

getDescription

getJcaName

isJdkStandard

isHmac

isRsa

isEllipticCurve

forName