Class AccessTokenHash
- java.lang.Object
-
- com.nimbusds.oauth2.sdk.id.Identifier
-
- com.nimbusds.openid.connect.sdk.claims.HashClaim
-
- com.nimbusds.openid.connect.sdk.claims.AccessTokenHash
-
- All Implemented Interfaces:
Serializable
,Comparable<Identifier>
,net.minidev.json.JSONAware
@Immutable public final class AccessTokenHash extends HashClaim
Access token hash (at_hash
).Related specifications:
- OpenID Connect Core 1.0, section 3.1.3.6.
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.nimbusds.oauth2.sdk.id.Identifier
DEFAULT_BYTE_LENGTH, secureRandom
-
-
Constructor Summary
Constructors Constructor Description AccessTokenHash(String value)
Creates a new access token hash with the specified value.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static AccessTokenHash
compute(AccessToken accessToken, com.nimbusds.jose.JWSAlgorithm alg)
Computes the hash for the specified access token and reference JSON Web Signature (JWS) algorithm.boolean
equals(Object object)
static boolean
isRequiredInIDTokenClaims(ResponseType responseType)
Checks if an access token hash claim must be included in ID tokens for the specified response type.-
Methods inherited from class com.nimbusds.openid.connect.sdk.claims.HashClaim
computeValue, getMessageDigestInstance
-
Methods inherited from class com.nimbusds.oauth2.sdk.id.Identifier
compareTo, getValue, hashCode, toJSONString, toString, toStringList
-
-
-
-
Constructor Detail
-
AccessTokenHash
public AccessTokenHash(String value)
Creates a new access token hash with the specified value.- Parameters:
value
- The access token hash value. Must not benull
.
-
-
Method Detail
-
isRequiredInIDTokenClaims
public static boolean isRequiredInIDTokenClaims(ResponseType responseType)
Checks if an access token hash claim must be included in ID tokens for the specified response type.- Parameters:
responseType
- The OpenID Connect response type. Must not benull
.- Returns:
true
if the access token hash is required, elsefalse
.
-
compute
public static AccessTokenHash compute(AccessToken accessToken, com.nimbusds.jose.JWSAlgorithm alg)
Computes the hash for the specified access token and reference JSON Web Signature (JWS) algorithm.- Parameters:
accessToken
- The access token. Must not benull
.alg
- The reference JWS algorithm. Must not benull
.- Returns:
- The access token hash, or
null
if the JWS algorithm is not supported.
-
equals
public boolean equals(Object object)
- Overrides:
equals
in classIdentifier
-
-