io.jsonwebtoken.security

Interface X509Builder<T extends X509Builder<T>>

Type Parameters:

T - the mutator subtype, for method chaining

All Superinterfaces:

X509Mutator<T>

All Known Subinterfaces:

AsymmetricJwkBuilder<K,J,T>, EcPrivateJwkBuilder, EcPublicJwkBuilder, JwtBuilder.BuilderHeader, Jwts.HeaderBuilder, OctetPrivateJwkBuilder<K,L>, OctetPublicJwkBuilder<A,B>, PrivateJwkBuilder<K,L,J,M,T>, PublicJwkBuilder<K,L,J,M,P,T>, RsaPrivateJwkBuilder, RsaPublicJwkBuilder

public interface X509Builder<T extends X509Builder<T>>
extends X509Mutator<T>

Additional X.509-specific builder methods for constructing an associated JWT Header or JWK, enabling method chaining.

Since:

0.12.0

Method Summary

Methods

Modifier and Type	Method and Description
T	x509Sha1Thumbprint(boolean enable) If the enable argument is true, compute the SHA-1 thumbprint of the first X509Certificate in the configured x509CertificateChain, and set the resulting value as the X509Mutator.x509Sha1Thumbprint(byte[]) parameter.
T	x509Sha256Thumbprint(boolean enable) If the enable argument is true, compute the SHA-256 thumbprint of the first X509Certificate in the configured x509CertificateChain, and set the resulting value as the X509Mutator.x509Sha256Thumbprint(byte[]) parameter.

Methods inherited from interface io.jsonwebtoken.security.X509Mutator

x509Chain, x509Sha1Thumbprint, x509Sha256Thumbprint, x509Url

Method Detail

x509Sha1Thumbprint

T x509Sha1Thumbprint(boolean enable)

If the enable argument is true, compute the SHA-1 thumbprint of the first X509Certificate in the configured x509CertificateChain, and set the resulting value as the X509Mutator.x509Sha1Thumbprint(byte[]) parameter.

If no chain has been configured, or enable is false, the builder will not compute nor add a x5t value.

Parameters:

enable - whether to compute the SHA-1 thumbprint on the first available X.509 Certificate and set the resulting value as the x5t value.

Returns:

the builder for method chaining.

x509Sha256Thumbprint

T x509Sha256Thumbprint(boolean enable)

If the enable argument is true, compute the SHA-256 thumbprint of the first X509Certificate in the configured x509CertificateChain, and set the resulting value as the X509Mutator.x509Sha256Thumbprint(byte[]) parameter.

If no chain has been configured, or enable is false, the builder will not compute nor add a x5t#S256 value.

Parameters:

enable - whether to compute the SHA-256 thumbprint on the first available X.509 Certificate and set the resulting value as the x5t#S256 value.

Returns:

the builder for method chaining.