Uses of Interface
io.jsonwebtoken.Header

Packages that use Header

Package	Description
io.jsonwebtoken

Uses of Header in io.jsonwebtoken

Classes in io.jsonwebtoken with type parameters of type Header

Modifier and Type	Interface and Description
interface	Jwt<H extends Header,P> An expanded (not compact/serialized) JSON Web Token.

Subinterfaces of Header in io.jsonwebtoken

Modifier and Type	Interface and Description
interface	JweHeader A JWE header.
interface	JwsHeader A JWS header.
interface	ProtectedHeader A JWT header that is integrity protected, either by JWS digital signature or JWE AEAD encryption.

Fields in io.jsonwebtoken with type parameters of type Header

Modifier and Type	Field and Description
static JwtVisitor<Jwt<Header,Claims>>	Jwt.UNSECURED_CLAIMS Visitor implementation that ensures the visited JWT is an unsecured Claims JWT (one not cryptographically signed or encrypted) and rejects all others with an UnsupportedJwtException.
static JwtVisitor<Jwt<Header,byte[]>>	Jwt.UNSECURED_CONTENT Visitor implementation that ensures the visited JWT is an unsecured content JWT (one not cryptographically signed or encrypted) and rejects all others with an UnsupportedJwtException.

Methods in io.jsonwebtoken that return Header

Modifier and Type	Method and Description
Header	ClaimJwtException.getHeader() Returns the header associated with the claims that failed validation.

Methods in io.jsonwebtoken that return types with arguments of type Header

Modifier and Type	Method and Description
Jwt<Header,Claims>	JwtParser.parseClaimsJwt(CharSequence jwt) Deprecated. since 0.12.0 in favor of JwtParser.parseUnsecuredClaims(CharSequence).
Jwt<Header,byte[]>	JwtParser.parseContentJwt(CharSequence jwt) Deprecated. since 0.12.0 in favor of JwtParser.parseUnsecuredContent(CharSequence).
Jwt<Header,Claims>	JwtParser.parseUnsecuredClaims(CharSequence jwt) Parses the jwt argument, expected to be an unsecured Claims JWT.
Jwt<Header,byte[]>	JwtParser.parseUnsecuredContent(CharSequence jwt) Parses the jwt argument, expected to be an unsecured content JWT.

Methods in io.jsonwebtoken with parameters of type Header

Modifier and Type	Method and Description
protected T	LocatorAdapter.doLocate(Header header) Returns an object referenced in the specified unprotected JWT header, or null if the referenced object cannot be found or does not exist.
T	LocatorAdapter.locate(Header header) Inspects the specified header, and delegates to the LocatorAdapter.locate(ProtectedHeader) method if the header is protected (either a JwsHeader or JweHeader), or the LocatorAdapter.doLocate(Header) method if the header is not integrity protected.
T	Locator.locate(Header header) Returns an object referenced in the specified header, or null if the object couldn't be found.
CompressionCodec	CompressionCodecResolver.resolveCompressionCodec(Header header) Deprecated. Looks for a JWT zip header, and if found, returns the corresponding CompressionCodec the parser can use to decompress the JWT body.

Method parameters in io.jsonwebtoken with type arguments of type Header

Modifier and Type	Method and Description
T	JwtHandler.onClaimsJwt(Jwt<Header,Claims> jwt) Deprecated. This method is invoked when a JwtParser determines that the parsed JWT is a Claims JWT.
T	JwtHandlerAdapter.onClaimsJwt(Jwt<Header,Claims> jwt)
T	JwtHandler.onContentJwt(Jwt<Header,byte[]> jwt) Deprecated. This method is invoked when a JwtParser determines that the parsed JWT is an unsecured content JWT.
T	JwtHandlerAdapter.onContentJwt(Jwt<Header,byte[]> jwt)
T	JwtHandlerAdapter.onUnsecuredClaims(Jwt<Header,Claims> jwt)
T	SupportedJwtVisitor.onUnsecuredClaims(Jwt<Header,Claims> jwt) Handles an encountered unsecured Claims JWT - one that is not cryptographically signed nor encrypted, and has a Claims payload.
T	JwtHandlerAdapter.onUnsecuredContent(Jwt<Header,byte[]> jwt)
T	SupportedJwtVisitor.onUnsecuredContent(Jwt<Header,byte[]> jwt) Handles an encountered unsecured content JWT - one that is not cryptographically signed nor encrypted, and has a byte[] array payload.

Constructors in io.jsonwebtoken with parameters of type Header

Constructor and Description
ClaimJwtException(Header header, Claims claims, String message) Creates a new instance with the specified header, claims and exception message.
ClaimJwtException(Header header, Claims claims, String message, Throwable cause) Creates a new instance with the specified header, claims and exception message as a result of encountering the specified cause.
ExpiredJwtException(Header header, Claims claims, String message) Creates a new instance with the specified header, claims, and explanation message.
ExpiredJwtException(Header header, Claims claims, String message, Throwable cause) Creates a new instance with the specified header, claims, explanation message and underlying cause.
IncorrectClaimException(Header header, Claims claims, String claimName, Object claimValue, String message) Creates a new instance with the specified header, claims and explanation message.
IncorrectClaimException(Header header, Claims claims, String claimName, Object claimValue, String message, Throwable cause) Creates a new instance with the specified header, claims, explanation message and underlying cause.
InvalidClaimException(Header header, Claims claims, String claimName, Object claimValue, String message) Creates a new instance with the specified header, claims and explanation message.
InvalidClaimException(Header header, Claims claims, String claimName, Object claimValue, String message, Throwable cause) Creates a new instance with the specified header, claims, explanation message and underlying cause.
MissingClaimException(Header header, Claims claims, String claimName, Object claimValue, String message) Creates a new instance with the specified explanation message.
MissingClaimException(Header header, Claims claims, String claimName, Object claimValue, String message, Throwable cause) Deprecated. since 0.12.0 since it is not used in JJWT's codebase
PrematureJwtException(Header header, Claims claims, String message) Creates a new instance with the specified explanation message.
PrematureJwtException(Header header, Claims claims, String message, Throwable cause) Deprecated. since 0.12.0 since it is not used in JJWT's codebase