Package com.auth0.jwt.interfaces
Interface Header
- All Known Subinterfaces:
DecodedJWT
public interface Header
The Header class represents the 1st part of the JWT, where the Header value is held.
-
Method Summary
Modifier and TypeMethodDescriptionGetter for the Algorithm "alg" claim defined in the JWT's Header.Getter for the Content Type "cty" claim defined in the JWT's Header.getHeaderClaim
(String name) Get a Private Claim given it's name.getKeyId()
Get the value of the "kid" claim, or null if it's not available.getType()
Getter for the Type "typ" claim defined in the JWT's Header.
-
Method Details
-
getAlgorithm
String getAlgorithm()Getter for the Algorithm "alg" claim defined in the JWT's Header. If the claim is missing it will return null.- Returns:
- the Algorithm defined or null.
-
getType
String getType()Getter for the Type "typ" claim defined in the JWT's Header. If the claim is missing it will return null.- Returns:
- the Type defined or null.
-
getContentType
String getContentType()Getter for the Content Type "cty" claim defined in the JWT's Header. If the claim is missing it will return null.- Returns:
- the Content Type defined or null.
-
getKeyId
String getKeyId()Get the value of the "kid" claim, or null if it's not available.- Returns:
- the Key ID value or null.
-
getHeaderClaim
Get a Private Claim given it's name. If the Claim wasn't specified in the Header, a 'null claim' will be returned. All the methods of that claim will returnnull
.- Parameters:
name
- the name of the Claim to retrieve.- Returns:
- a non-null Claim.
-