Package com.nimbusds.openid.connect.sdk.claims

Class StateHash

java.lang.Object

com.nimbusds.oauth2.sdk.id.Identifier

com.nimbusds.openid.connect.sdk.claims.HashClaim

com.nimbusds.openid.connect.sdk.claims.StateHash

All Implemented Interfaces:

Serializable, Comparable<Identifier>, net.minidev.json.JSONAware

@Immutable
public class StateHash
extends HashClaim

State hash (s_hash).

Related specifications:

• Financial Services – Financial API - Part 2: Read and Write API Security Profile, section 5.1.

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
StateHash(String value)	Creates a new state hash with the specified value.

Method Summary

Modifier and Type	Method	Description
static StateHash	compute(State state, com.nimbusds.jose.JWSAlgorithm alg)	Deprecated. Use compute(State, JWSAlgorithm, Curve) instead.
static StateHash	compute(State state, com.nimbusds.jose.JWSAlgorithm alg, com.nimbusds.jose.jwk.Curve crv)	Computes the hash for the specified state and reference JSON Web Signature (JWS) algorithm.
boolean	equals(Object object)

Methods inherited from class com.nimbusds.openid.connect.sdk.claims.HashClaim

computeValue, computeValue, getMessageDigestInstance, getMessageDigestInstance

Methods inherited from class com.nimbusds.oauth2.sdk.id.Identifier

compareTo, getValue, hashCode, toJSONString, toString, toStringList

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StateHash

public StateHash(String value)

Creates a new state hash with the specified value.

Parameters:

value - The state hash value. Must not be null.

Method Detail

compute

@Deprecated
public static StateHash compute(State state,
                                com.nimbusds.jose.JWSAlgorithm alg)

Deprecated.

Use compute(State, JWSAlgorithm, Curve) instead.

Computes the hash for the specified state and reference JSON Web Signature (JWS) algorithm.

Parameters:

state - The state. Must not be null.

alg - The reference JWS algorithm. Must not be null.

Returns:

The state hash, or null if the JWS algorithm is not supported.

compute

public static StateHash compute(State state,
                                com.nimbusds.jose.JWSAlgorithm alg,
                                com.nimbusds.jose.jwk.Curve crv)

Computes the hash for the specified state and reference JSON Web Signature (JWS) algorithm.

Parameters:

state - The state. Must not be null.

alg - The reference JWS algorithm. Must not be null.

crv - The JWK curve used with the JWS algorithm, null if not applicable.

Returns:

The state hash, or null if the JWS algorithm is not supported.

equals

public boolean equals(Object object)

Overrides:

equals in class Identifier