StateHash (Nimbus OAuth 2.0 SDK with OpenID Connect 1.0 extensions v6.21)

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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static StateHash`	`compute(State state, com.nimbusds.jose.JWSAlgorithm alg)`	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, 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
```
public static StateHash compute(State state,
                                com.nimbusds.jose.JWSAlgorithm alg)
```
    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.
  - equals
```
public boolean equals(Object object)
```
    Overrides:
    
    equals in class Identifier