io.jsonwebtoken

Interface ProtectedHeader

All Superinterfaces:

Header, Map<String,Object>, X509Accessor

All Known Subinterfaces:

JweHeader, JwsHeader

public interface ProtectedHeader
extends Header, X509Accessor

A JWT header that is integrity protected, either by JWS digital signature or JWE AEAD encryption.

Since:

0.12.0

See Also:

JwsHeader, JweHeader

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields inherited from interface io.jsonwebtoken.Header

ALGORITHM, COMPRESSION_ALGORITHM, CONTENT_TYPE, DEPRECATED_COMPRESSION_ALGORITHM, JWT_TYPE, TYPE

Method Summary

Methods

Modifier and Type	Method and Description
Set<String>	getCritical() Returns the header parameter names that use extensions to the JWT or JWA specification(s) that MUST be understood and supported by the JWT recipient, or null if not present.
PublicJwk<?>	getJwk() Returns the jwk (JSON Web Key) associated with the JWT.
URI	getJwkSetUrl() Returns the jku (JWK Set URL) value that refers to a JWK Set resource containing JSON-encoded Public Keys, or null if not present.
String	getKeyId() Returns the JWT case-sensitive kid (Key ID) header value or null if not present.

Methods inherited from interface io.jsonwebtoken.Header

getAlgorithm, getCompressionAlgorithm, getContentType, getType

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Methods inherited from interface io.jsonwebtoken.security.X509Accessor

getX509Chain, getX509Sha1Thumbprint, getX509Sha256Thumbprint, getX509Url

Method Detail

getJwkSetUrl

URI getJwkSetUrl()

Returns the jku (JWK Set URL) value that refers to a JWK Set resource containing JSON-encoded Public Keys, or null if not present. When present in 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 present in a JweHeader, the first public key in the JWK Set must be the public key used during encryption.

Returns:

a URI that refers to a JWK Set resource for a set of JSON-encoded Public Keys, or null if not present.

See Also:

JWS JWK Set URL, JWE JWK Set URL

getJwk

PublicJwk<?> getJwk()

Returns the jwk (JSON Web Key) associated with the JWT. When present in a JwsHeader, the jwk is the public key complement of the private key used to digitally sign the JWS. When present in 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.

Returns:

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

See Also:

JWS {@code jwk} (JSON Web Key) Header Parameter, JWE {@code jwk} (JSON Web Key) Header Parameter

getKeyId

String getKeyId()

Returns the JWT case-sensitive kid (Key ID) header value or null if not present.

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 is a CaSe-SeNsItIvE string.

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

Returns:

the case-sensitive kid header value or null if not present.

See Also:

JWS Key ID, JWE Key ID

getCritical

Set<String> getCritical()

Returns the header parameter names that use extensions to the JWT or JWA specification(s) that MUST be understood and supported by the JWT recipient, or null if not present.

Returns:

the header parameter names that use extensions to the JWT or JWA specification(s) that MUST be understood and supported by the JWT recipient, or null if not present.

See Also:

JWS {@code crit} (Critical) Header Parameter, JWS {@code crit} (Critical) Header Parameter