Uses of Class
org.forgerock.json.jose.jwk.JWK

Packages that use JWK

Package	Description
org.forgerock.json.jose.builders	Classes and interfaces for builder to build JWTs using a fluent API.
org.forgerock.json.jose.jwe	Classes and interfaces for JWT encryption and JWEs.
org.forgerock.json.jose.jwk	Classes and interfaces for creating and manipulating JWKs.
org.forgerock.json.jose.jwk.store	This package contains classes to manage a JWKs URI.
org.forgerock.json.jose.jws	Classes and interfaces for JWT signing and JWS'.
org.forgerock.secrets.jwkset	Secret store backend for retrieving keys from a local or remote JWK Set.

Uses of JWK in org.forgerock.json.jose.builders

Methods in org.forgerock.json.jose.builders with parameters of type JWK

Modifier and Type	Method	Description
JweHeaderBuilder<B>	JweHeaderBuilder.epk(JWK epk)	Sets the Ephemeral Public Key header parameter for this JWE.
B	JwtSecureHeaderBuilder.jwk(JWK jwk)	Sets the JSON Web Key header parameter for this JWS.

Uses of JWK in org.forgerock.json.jose.jwe

Methods in org.forgerock.json.jose.jwe that return JWK

Modifier and Type	Method	Description
JWK	JweHeader.getEphemeralPublicKey()	Gets the Ephemeral Public Key header parameter for this JWE.

Methods in org.forgerock.json.jose.jwe with parameters of type JWK

Modifier and Type	Method	Description
void	JweHeader.setEphemeralPublicKey(JWK ephemeralPublicKey)	Sets the Ephemeral Public Key header parameter for this JWE.

Uses of JWK in org.forgerock.json.jose.jwk

Subclasses of JWK in org.forgerock.json.jose.jwk

Modifier and Type	Class	Description
class	EcJWK	This class implements an Elliptical Curve Json Web Key storage and manipulation class.
class	OctJWK	Creates an Octet JWK.
class	OkpJWK	An Octet Key-Pair (OKP) JWK as defined in RFC 8037.
class	RsaJWK	Implements a RsaJWK.

Methods in org.forgerock.json.jose.jwk that return JWK

Modifier and Type	Method	Description
abstract JWK	JWK.Builder.build()	Builds the JWK.
JWK	JWKSet.findJwk(String kid)	Search for a JWK that matches the kid.
JWK	JWKSet.findJwk(Algorithm algorithm, String keyUse)	Search for a JWK that matches the algorithm and the key usage.
static JWK	JWK.parse(String json)	Parses a String into the proper JWK type.
static JWK	JWK.parse(JsonValue jwk)	Parses a JsonValue into the proper JWK type.

Methods in org.forgerock.json.jose.jwk that return types with arguments of type JWK

Modifier and Type	Method	Description
Optional<JWK>	JWKSet.findJwk(Predicate<JWK> predicate)	Return a JWK that matches the JWK predicate.
Stream<JWK>	JWKSet.findJwks(Predicate<JWK> predicate)	Return a stream of JWK that matches the JWK predicate.
List<JWK>	JWKSet.getJWKsAsList()	Get the JWKs in the set.
Optional<JWK>	JWK.toPublicJwk()	For asymmetric keys, get the public JWK representation of this JWK.

Method parameters in org.forgerock.json.jose.jwk with type arguments of type JWK

Modifier and Type	Method	Description
Optional<JWK>	JWKSet.findJwk(Predicate<JWK> predicate)	Return a JWK that matches the JWK predicate.
Stream<JWK>	JWKSet.findJwks(Predicate<JWK> predicate)	Return a stream of JWK that matches the JWK predicate.

Constructors in org.forgerock.json.jose.jwk with parameters of type JWK

Constructor	Description
JWKSet(JWK jwk)	Construct a JWKSet from a single JWK.

Constructor parameters in org.forgerock.json.jose.jwk with type arguments of type JWK

Constructor	Description
JWKSet(List<JWK> jwkList)	Construct a JWKSet from a List of JWKs.

Uses of JWK in org.forgerock.json.jose.jwk.store

Methods in org.forgerock.json.jose.jwk.store that return JWK

Modifier and Type	Method	Description
JWK	JwksStore.findJwk(String kid)	Deprecated. Use JwksStore.findJwkAsync(String) instead.
JWK	JwksStore.findJwk(Algorithm algorithm, String keyUse)	Deprecated. Use JwksStore.findJwkAsync(String) instead.

Methods in org.forgerock.json.jose.jwk.store that return types with arguments of type JWK

Modifier and Type	Method	Description
Promise<JWK,FailedToLoadJWKException>	JwksStore.findJwkAsync(String kid)	Search asynchronously for a JWK that matches the kid.
Promise<JWK,FailedToLoadJWKException>	JwksStore.findJwkAsync(Predicate<JWK> predicate)	Return the JWK matching the keyID with the algorithm and keyUse.
Promise<JWK,FailedToLoadJWKException>	JwksStore.findJwkAsync(Algorithm algorithm, String keyUse)	Search asynchronously for a JWK that matches the algorithm and the key usage.

Method parameters in org.forgerock.json.jose.jwk.store with type arguments of type JWK

Modifier and Type	Method	Description
Promise<JWK,FailedToLoadJWKException>	JwksStore.findJwkAsync(Predicate<JWK> predicate)	Return the JWK matching the keyID with the algorithm and keyUse.

Uses of JWK in org.forgerock.json.jose.jws

Methods in org.forgerock.json.jose.jws that return JWK

Modifier and Type	Method	Description
JWK	JwtSecureHeader.getJsonWebKey()	Gets the JSON Web Key header parameter for this JWS.

Methods in org.forgerock.json.jose.jws with parameters of type JWK

Modifier and Type	Method	Description
SigningHandler	SigningManager.newSigningHandler(JWK jwk)	Returns a signing handler from the given JSON Web Key (JWK) which will be used to sign a JWT.
SigningHandler	SigningManager.newSigningHandler(JWK jwk, Purpose<SigningKey> purpose)	Returns a signing handler from the given JSON Web Key (JWK) which will be used to sign a JWT.
SigningHandler	SigningManager.newSigningHandler(JWK jwk, Purpose<SigningKey> purpose, Instant expiry)	Returns a signing handler from the given JSON Web Key (JWK) which will be used to sign a JWT.
SigningHandler	SigningManager.newVerificationHandler(JWK jwk)	Returns the signing handler from the given JSON Web Key (JWK) which will be used to verify the JWT.
SigningHandler	SigningManager.newVerificationHandler(JWK jwk, Purpose<VerificationKey> purpose)	Returns a signing handler from the given JSON Web Key (JWK) which will be used to verify a JWT.
SigningHandler	SigningManager.newVerificationHandler(JWK jwk, Purpose<VerificationKey> purpose, Instant expiry)	Returns a signing handler from the given JSON Web Key (JWK) which will be used to verify a JWT.
void	JwtSecureHeader.setJsonWebKey(JWK jsonWebKey)	Sets the JSON Web Key header parameter for this JWS.

Uses of JWK in org.forgerock.secrets.jwkset

Methods in org.forgerock.secrets.jwkset that return JWK

Modifier and Type	Method	Description
JWK	JwkKeyFormat.export(CryptoKey key, Key rawKey)