io.jsonwebtoken.security

Interface PrivateJwkBuilder<K extends PrivateKey,L extends PublicKey,J extends PublicJwk<L>,M extends PrivateJwk<K,L,J>,T extends PrivateJwkBuilder<K,L,J,M,T>>

Type Parameters:

K - the type of Java PrivateKey provided by the created private JWK.

L - the type of Java PublicKey paired with the private key.

M - the type of PrivateJwk created

J - the type of PublicJwk paired with the created private JWK.

T - the type of the builder, for subtype method chaining

All Superinterfaces:

AsymmetricJwkBuilder<K,M,T>, Builder<M>, JwkBuilder<K,M,T>, KeyOperationPolicied<T>, MapMutator<String,Object,T>, SecurityBuilder<M,T>, X509Builder<T>, X509Mutator<T>

All Known Subinterfaces:

EcPrivateJwkBuilder, OctetPrivateJwkBuilder<K,L>, RsaPrivateJwkBuilder

public interface PrivateJwkBuilder<K extends PrivateKey,L extends PublicKey,J extends PublicJwk<L>,M extends PrivateJwk<K,L,J>,T extends PrivateJwkBuilder<K,L,J,M,T>>
extends AsymmetricJwkBuilder<K,M,T>

An AsymmetricJwkBuilder that creates PrivateJwk instances.

Since:

0.12.0

See Also:

publicKey(PublicKey)

Method Summary

Methods

Modifier and Type	Method and Description
T	publicKey(L publicKey) Allows specifying of the PublicKey associated with the builder's existing PrivateKey, offering a reasonable performance enhancement when building the final private JWK.

Methods inherited from interface io.jsonwebtoken.security.AsymmetricJwkBuilder

publicKeyUse

Methods inherited from interface io.jsonwebtoken.security.JwkBuilder

algorithm, id, idFromThumbprint, idFromThumbprint, operations

Methods inherited from interface io.jsonwebtoken.lang.MapMutator

add, add, delete, empty

Methods inherited from interface io.jsonwebtoken.security.SecurityBuilder

provider, random

Methods inherited from interface io.jsonwebtoken.lang.Builder

build

Methods inherited from interface io.jsonwebtoken.security.KeyOperationPolicied

operationPolicy

Methods inherited from interface io.jsonwebtoken.security.X509Builder

x509Sha1Thumbprint, x509Sha256Thumbprint

Methods inherited from interface io.jsonwebtoken.security.X509Mutator

x509Chain, x509Sha1Thumbprint, x509Sha256Thumbprint, x509Url

Method Detail

publicKey

T publicKey(L publicKey)

Allows specifying of the PublicKey associated with the builder's existing PrivateKey, offering a reasonable performance enhancement when building the final private JWK. Application developers should prefer to use this method when possible when building private JWKs.

As discussed in the PrivateJwk documentation, the JWK and JWA specifications require private JWKs to contain both private key and public key data. If a public key is not provided via this publicKey method, the builder implementation must go through the work to derive the PublicKey instance based on the PrivateKey to obtain the necessary public key information.

Calling this method with the PrivateKey's matching PublicKey instance eliminates the need for the builder to do that work.

Parameters:

publicKey - the PublicKey that matches the builder's existing PrivateKey.

Returns:

the builder for method chaining.