Package com.nimbusds.jose.jwk

Class ThumbprintURI

java.lang.Object

com.nimbusds.jose.jwk.ThumbprintURI

@Immutable
public class ThumbprintURI
extends Object

JSON Web Key (JWK) thumbprint URI.

Example SHA-256 thumbprint URI:

 urn:ietf:params:oauth:jwk-thumbprint:sha-256:NzbLsXh8uDCcd-6MNwXF4W_7noWXFZAfHkxZsRGC9Xs
 

See draft-ietf-oauth-jwk-thumbprint-uri-01

Version:

2024-04-20

Author:

Vladimir Dzhuvinov

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PREFIX	The URI prefix of JWK thumbprints.

Constructor Summary

Constructors

Constructor	Description
ThumbprintURI(String hashAlg, Base64URL thumbprint)	Creates a new JWK thumbprint URI.

Method Summary

Modifier and Type	Method	Description
static ThumbprintURI	compute(JWK jwk)	Computes the SHA-256 JWK thumbprint URI for the specified JWK.
boolean	equals(Object o)
String	getAlgorithmString()	Returns the hash algorithm string.
Base64URL	getThumbprint()	Returns the underlying thumbprint value.
int	hashCode()
static ThumbprintURI	parse(String s)	Parses a JWK thumbprint URI from the specified URI string.
static ThumbprintURI	parse(URI uri)	Parses a JWK thumbprint URI from the specified URI.
String	toString()
URI	toURI()	Returns the URI representation.

Methods inherited from class java.lang.Object

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

Field Details

PREFIX

public static final String PREFIX

The URI prefix of JWK thumbprints.

See Also:

• Constant Field Values

Constructor Details

ThumbprintURI

public ThumbprintURI(String hashAlg,
 Base64URL thumbprint)

Creates a new JWK thumbprint URI.

Parameters:

hashAlg - The hash algorithm. Must not be null.

thumbprint - The thumbprint value. Must not be null.

Method Details

getAlgorithmString

public String getAlgorithmString()

Returns the hash algorithm string.

Returns:

The hash algorithm string.

getThumbprint

public Base64URL getThumbprint()

Returns the underlying thumbprint value.

Returns:

The thumbprint value.

toURI

public URI toURI()

Returns the URI representation.

Returns:

The URI representation.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compute

public static ThumbprintURI compute(JWK jwk)
                             throws JOSEException

Computes the SHA-256 JWK thumbprint URI for the specified JWK.

Parameters:

jwk - The JWK. Must not be null.

Returns:

The SHA-256 JWK thumbprint URI.

Throws:

JOSEException - If the SHA-256 hash algorithm is not supported.

parse

public static ThumbprintURI parse(URI uri)
                           throws ParseException

Parses a JWK thumbprint URI from the specified URI.

Parameters:

uri - The URI. Must not be null.

Returns:

The JWK thumbprint URI.

Throws:

ParseException - If the URI is illegal.

parse

public static ThumbprintURI parse(String s)
                           throws ParseException

Parses a JWK thumbprint URI from the specified URI string.

Parameters:

s - The URI string. Must not be null.

Returns:

The JWK thumbprint URI.

Throws:

ParseException - If the URI string is illegal.