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 hold.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAlgorithm() Getter for the Algorithm "alg" claim defined in the JWT's Header.
java.lang.String	getContentType() Getter for the Content Type "cty" claim defined in the JWT's Header.
Claim	getHeaderClaim(java.lang.String name) Get a Private Claim given it's name.
java.lang.String	getKeyId() Get the value of the "kid" claim, or null if it's not available.
java.lang.String	getType() Getter for the Type "typ" claim defined in the JWT's Header.

Method Detail

getAlgorithm

java.lang.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

java.lang.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

java.lang.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

java.lang.String getKeyId()

Get the value of the "kid" claim, or null if it's not available.

Returns:

the Key ID value or null.

getHeaderClaim

Claim getHeaderClaim(java.lang.String name)

Get a Private Claim given it's name. If the Claim wasn't specified in the Header, a NullClaim will be returned.

Parameters:

name - the name of the Claim to retrieve.

Returns:

a non-null Claim.