Package com.nimbusds.jose.jwk
Class KeyType
- java.lang.Object
-
- com.nimbusds.jose.jwk.KeyType
-
- All Implemented Interfaces:
Serializable
@Immutable public final class KeyType extends Object implements Serializable
Key type. Represents thekty
parameter in a JSON Web Key (JWK). This class is immutable.Includes constants for the following standard key types:
Additional key types can be defined using the constructor.
- Version:
- 2017-08-23
- Author:
- Vladimir Dzhuvinov, Justin Richer
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description KeyType(String value, Requirement req)
Creates a new key type with the specified value and implementation requirement.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(Object object)
OverridesObject.equals()
.static KeyType
forAlgorithm(Algorithm alg)
Infers the key type for the specified JOSE algorithm.Requirement
getRequirement()
Gets the implementation requirement of this key type.String
getValue()
Gets the value of this key type.int
hashCode()
OverridesObject.hashCode()
.static KeyType
parse(String s)
Parses a key type from the specifiedkty
parameter value.String
toJSONString()
Returns the JSON string representation of this key type.String
toString()
Returns the string representation of this key type.
-
-
-
Constructor Detail
-
KeyType
public KeyType(String value, Requirement req)
Creates a new key type with the specified value and implementation requirement.- Parameters:
value
- The key type value. Values are case sensitive. Must not benull
.req
- The implementation requirement,null
if not known.
-
-
Method Detail
-
getValue
public String getValue()
Gets the value of this key type. Values are case sensitive.- Returns:
- The key type.
-
getRequirement
public Requirement getRequirement()
Gets the implementation requirement of this key type.- Returns:
- The implementation requirement,
null
if not known.
-
hashCode
public int hashCode()
OverridesObject.hashCode()
.
-
toString
public String toString()
Returns the string representation of this key type.- Overrides:
toString
in classObject
- Returns:
- The string representation.
- See Also:
getValue()
-
toJSONString
public String toJSONString()
Returns the JSON string representation of this key type.- Returns:
- The JSON string representation.
-
parse
public static KeyType parse(String s)
Parses a key type from the specifiedkty
parameter value.- Parameters:
s
- The string to parse. Must not benull
.- Returns:
- The key type (matching standard key type constant, else a newly created one).
-
forAlgorithm
public static KeyType forAlgorithm(Algorithm alg)
Infers the key type for the specified JOSE algorithm.- Parameters:
alg
- The JOSE algorithm. May benull
.- Returns:
- The key type,
null
if it couldn't be inferred.
-
-