io.jsonwebtoken

Interface ProtectedHeaderMutator<T extends ProtectedHeaderMutator<T>>

Type Parameters:

T - the mutator subtype, for method chaining

All Superinterfaces:

HeaderMutator<T>, MapMutator<String,Object,T>, X509Mutator<T>

All Known Subinterfaces:

JweHeaderMutator<T>, JwtBuilder.BuilderHeader, Jwts.HeaderBuilder

public interface ProtectedHeaderMutator<T extends ProtectedHeaderMutator<T>>
extends HeaderMutator<T>, X509Mutator<T>

Mutation (modifications) to a Header instance.

Since:

0.12.0

Method Summary

Methods

Modifier and Type	Method and Description
NestedCollection<String,T>	critical() Configures names of header parameters used by JWT or JWA specification extensions that MUST be understood and supported by the JWT recipient.
T	jwk(PublicJwk<?> jwk) Sets the jwk (JSON Web Key) associated with the JWT.
T	jwkSetUrl(URI uri) Sets the jku (JWK Set URL) value that refers to a JWK Set resource containing JSON-encoded Public Keys, or null if not present.
T	keyId(String kid) Sets the JWT case-sensitive kid (Key ID) header value.
T	setAlgorithm(String alg) Deprecated. since 0.12.0 and will be removed before the 1.0 release.
T	setKeyId(String kid) Deprecated. since 0.12.0 in favor of the more modern builder-style keyId(String) method.

Methods inherited from interface io.jsonwebtoken.HeaderMutator

contentType, setCompressionAlgorithm, setContentType, setType, type

Methods inherited from interface io.jsonwebtoken.lang.MapMutator

add, add, delete, empty

Methods inherited from interface io.jsonwebtoken.security.X509Mutator

x509Chain, x509Sha1Thumbprint, x509Sha256Thumbprint, x509Url

Method Detail

critical

NestedCollection<String,T> critical()

Configures names of header parameters used by JWT or JWA specification extensions that MUST be understood and supported by the JWT recipient. When finished, use the collection's and() method to continue header configuration, for example:

 headerBuilder
     .critical().add("headerName").and() // return parent
 // resume header configuration...

Returns:

the NestedCollection to use for crit configuration.

See Also:

JWS crit (Critical) Header Parameter, JWS crit (Critical) Header Parameter

jwk

T jwk(PublicJwk<?> jwk)

Sets the jwk (JSON Web Key) associated with the JWT. When set for a JwsHeader, the jwk is the public key complement of the private key used to digitally sign the JWS. When set for a JweHeader, the jwk is the public key to which the JWE was encrypted, and may be used to determine the private key needed to decrypt the JWE.

Parameters:

jwk - the jwk (JSON Web Key) associated with the header.

Returns:

the header for method chaining

See Also:

JWS jwk (JSON Web Key) Header Parameter, JWE jwk (JSON Web Key) Header Parameter

jwkSetUrl

T jwkSetUrl(URI uri)

Sets the jku (JWK Set URL) value that refers to a JWK Set resource containing JSON-encoded Public Keys, or null if not present. When set for a JwsHeader, the first public key in the JWK Set must be the public key complement of the private key used to sign the JWS. When set for a JweHeader, the first public key in the JWK Set must be the public key used during encryption.

Parameters:

uri - a URI that refers to a JWK Set resource containing JSON-encoded Public Keys

Returns:

the header for method chaining

See Also:

JWS JWK Set URL, JWE JWK Set URL

keyId

T keyId(String kid)

Sets the JWT case-sensitive kid (Key ID) header value. A null value will remove the property from the JSON map.

The keyId header parameter is a hint indicating which key was used to secure a JWS or JWE. This parameter allows originators to explicitly signal a change of key to recipients. The structure of the keyId value is unspecified. Its value MUST be a case-sensitive string.

When used with a JWK, the keyId value is used to match a JWK keyId parameter value.

Parameters:

kid - the case-sensitive JWS kid header value or null to remove the property from the JSON map.

Returns:

the header instance for method chaining.

See Also:

JWS Key ID, JWE Key ID

setKeyId

@Deprecated
T setKeyId(String kid)

Deprecated. since 0.12.0 in favor of the more modern builder-style keyId(String) method.

Deprecated since 0.12.0, delegates to keyId(String).

Parameters:

kid - the case-sensitive JWS kid header value or null to remove the property from the JSON map.

Returns:

the instance for method chaining.

See Also:

JWS Key ID, JWE Key ID

setAlgorithm

@Deprecated
T setAlgorithm(String alg)

Deprecated. since 0.12.0 and will be removed before the 1.0 release.

Deprecated as of 0.12.0, there is no need to set this any longer as the JwtBuilder will always set the alg header as necessary.

Parameters:

alg - the JWS or JWE algorithm alg value or null to remove the property from the JSON map.

Returns:

the instance for method chaining.

Since:

0.1