SignatureAlgorithm

java.lang.Object
- java.lang.Enum<SignatureAlgorithm>
- - com.fr.cert.token.SignatureAlgorithm

所有已实现的接口:

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

从以下版本开始:

0.1

枚举常量概要

枚举常量
枚举常量和说明
`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`

方法概要

方法
限定符和类型	方法和说明
`static SignatureAlgorithm`	`forName(java.lang.String value)` Looks up and returns the corresponding `SignatureAlgorithm` enum instance based on a case-insensitive name comparison.
`java.lang.String`	`getDescription()` Returns the JWA algorithm description.
`java.lang.String`	`getFamilyName()` Returns the cryptographic family name of the signature algorithm.
`java.lang.String`	`getJcaName()` Returns the name of the JCA algorithm used to compute the signature.
`java.lang.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(java.lang.String name)` 返回带有指定名称的该类型的枚举常量。
`static SignatureAlgorithm[]`	`values()` 按照声明该枚举类型的常量的顺序, 返回包含这些常量的数组。

从类继承的方法 java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

从类继承的方法 java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

枚举常量详细资料
- 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.

方法详细资料

values
```
public static SignatureAlgorithm[] values()
```
按照声明该枚举类型的常量的顺序, 返回包含这些常量的数组。该方法可用于迭代常量, 如下所示:
```
for (SignatureAlgorithm c : SignatureAlgorithm.values())
    System.out.println(c);
```
返回:
按照声明该枚举类型的常量的顺序返回的包含这些常量的数组

valueOf
```
public static SignatureAlgorithm valueOf(java.lang.String name)
```
返回带有指定名称的该类型的枚举常量。字符串必须与用于声明该类型的枚举常量的标识符完全匹配。(不允许有多余的空格字符。)

参数:
name - 要返回的枚举常量的名称。

返回:
返回带有指定名称的枚举常量

抛出:

java.lang.IllegalArgumentException - 如果该枚举类型没有带有指定名称的常量

java.lang.NullPointerException - 如果参数为空值

getValue
```
public java.lang.String getValue()
```
Returns the JWA algorithm name constant.

返回:
the JWA algorithm name constant.

getDescription
```
public java.lang.String getDescription()
```
Returns the JWA algorithm description.

返回:
the JWA algorithm description.

getFamilyName

public java.lang.String getFamilyName()

Returns the cryptographic family name of the signature algorithm. The value returned is according to the following table:

Crypto Family
SignatureAlgorithm	Family Name
HS256	HMAC
HS384	HMAC
HS512	HMAC
RS256	RSA
RS384	RSA
RS512	RSA
PS256	RSA
PS384	RSA
PS512	RSA
ES256	Elliptic Curve
ES384	Elliptic Curve
ES512	Elliptic Curve

返回:: Returns the cryptographic family name of the signature algorithm.
从以下版本开始:: 0.5

getJcaName
```
public java.lang.String getJcaName()
```
Returns the name of the JCA algorithm used to compute the signature.

返回:
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).

返回:
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.

返回:
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.

返回:
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.

返回:
true if the enum instance represents an Elliptic Curve signature algorithm, false otherwise.

forName
```
public static SignatureAlgorithm forName(java.lang.String value)
                                  throws SignatureException
```
Looks up and returns the corresponding SignatureAlgorithm enum instance based on a case-insensitive name comparison.

参数:
value - The case-insensitive name of the SignatureAlgorithm instance to return

返回:
the corresponding SignatureAlgorithm enum instance based on a case-insensitive name comparison.

抛出:

SignatureException - if the specified value does not match any SignatureAlgorithm name.

枚举 SignatureAlgorithm

枚举常量概要

方法概要

从类继承的方法 java.lang.Enum

从类继承的方法 java.lang.Object

枚举常量详细资料

NONE

HS256

HS384

HS512

RS256

RS384

RS512

ES256

ES384

ES512

PS256

PS384

PS512

方法详细资料

values

valueOf

getValue

getDescription

getFamilyName

getJcaName

isJdkStandard

isHmac

isRsa

isEllipticCurve

forName