Enum MacAlgorithm
- java.lang.Object
-
- java.lang.Enum<MacAlgorithm>
-
- org.springframework.security.oauth2.jose.jws.MacAlgorithm
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<MacAlgorithm>
,JwaAlgorithm
,JwsAlgorithm
public enum MacAlgorithm extends java.lang.Enum<MacAlgorithm> implements JwsAlgorithm
An enumeration of the cryptographic algorithms defined by the JSON Web Algorithms (JWA) specification and used by JSON Web Signature (JWS) to create a MAC of the contents of the JWS Protected Header and JWS Payload.
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static MacAlgorithm
from(java.lang.String name)
Attempt to resolve the provided algorithm name to aMacAlgorithm
.java.lang.String
getName()
Returns the algorithm name.static MacAlgorithm
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static MacAlgorithm[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
HS256
public static final MacAlgorithm HS256
HMAC using SHA-256 (Required)
-
HS384
public static final MacAlgorithm HS384
HMAC using SHA-384 (Optional)
-
HS512
public static final MacAlgorithm HS512
HMAC using SHA-512 (Optional)
-
-
Method Detail
-
values
public static MacAlgorithm[] 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 (MacAlgorithm c : MacAlgorithm.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static MacAlgorithm 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 namejava.lang.NullPointerException
- if the argument is null
-
getName
public java.lang.String getName()
Returns the algorithm name.- Specified by:
getName
in interfaceJwaAlgorithm
- Returns:
- the algorithm name
-
from
public static MacAlgorithm from(java.lang.String name)
Attempt to resolve the provided algorithm name to aMacAlgorithm
.- Parameters:
name
- the algorithm name- Returns:
- the resolved
MacAlgorithm
, ornull
if not found
-
-