io.jsonwebtoken

Interface Header<T extends Header<T>>

All Superinterfaces:

Map<String,Object>

All Known Subinterfaces:

JwsHeader<T>

All Known Implementing Classes:

DefaultHeader, DefaultJwsHeader

public interface Header<T extends Header<T>>
extends Map<String,Object>

A JWT JOSE header.

This is ultimately a JSON map and any values can be added to it, but JWT JOSE standard names are provided as type-safe getters and setters for convenience.

Because this interface extends Map<String, Object>, if you would like to add your own properties, you simply use map methods, for example:

 header.put("headerParamName", "headerParamValue");
 

Creation

It is easiest to create a Header instance by calling one of the JWTs.header() factory methods.

Since:

0.1

Nested Class Summary

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

Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPRESSION_ALGORITHM JWT Compression Algorithm header parameter name: "zip"
static String	CONTENT_TYPE JWT Content Type header parameter name: "cty"
static String	DEPRECATED_COMPRESSION_ALGORITHM Deprecated. use COMPRESSION_ALGORITHM instead.
static String	JWT_TYPE JWT Type (typ) value: "JWT"
static String	TYPE JWT Type header parameter name: "typ"

Method Summary

Methods

Modifier and Type	Method and Description
String	getCompressionAlgorithm() Returns the JWT calg (Compression Algorithm) header value or null if not present.
String	getContentType() Returns the cty (Content Type) header value or null if not present.
String	getType() Returns the typ (type) header value or null if not present.
T	setCompressionAlgorithm(String calg) Sets the JWT calg (Compression Algorithm) header parameter value.
T	setContentType(String cty) Sets the JWT cty (Content Type) header parameter value.
T	setType(String typ) Sets the JWT typ (Type) header value.

Methods inherited from interface java.util.Map

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

Field Detail

JWT_TYPE

static final String JWT_TYPE

JWT Type (typ) value: "JWT"

See Also:

Constant Field Values

TYPE

static final String TYPE

JWT Type header parameter name: "typ"

See Also:

Constant Field Values

CONTENT_TYPE

static final String CONTENT_TYPE

JWT Content Type header parameter name: "cty"

See Also:

Constant Field Values

COMPRESSION_ALGORITHM

static final String COMPRESSION_ALGORITHM

JWT Compression Algorithm header parameter name: "zip"

See Also:

Constant Field Values

DEPRECATED_COMPRESSION_ALGORITHM

@Deprecated
static final String DEPRECATED_COMPRESSION_ALGORITHM

Deprecated. use COMPRESSION_ALGORITHM instead.

JJWT legacy/deprecated compression algorithm header parameter name: "calg"

See Also:

Constant Field Values

Method Detail

getType

String getType()

Returns the typ (type) header value or null if not present.

Returns:

the typ header value or null if not present.

setType

T setType(String typ)

Sets the JWT typ (Type) header value. A null value will remove the property from the JSON map.

Parameters:

typ - the JWT JOSE typ header value or null to remove the property from the JSON map.

Returns:

the Header instance for method chaining.

getContentType

String getContentType()

Returns the cty (Content Type) header value or null if not present.

In the normal case where nested signing or encryption operations are not employed (i.e. a compact serialization JWT), the use of this header parameter is NOT RECOMMENDED. In the case that nested signing or encryption is employed, this Header Parameter MUST be present; in this case, the value MUST be JWT, to indicate that a Nested JWT is carried in this JWT. While media type names are not case-sensitive, it is RECOMMENDED that JWT always be spelled using uppercase characters for compatibility with legacy implementations. See JWT Appendix A.2 for an example of a Nested JWT.

Returns:

the typ header parameter value or null if not present.

setContentType

T setContentType(String cty)

Sets the JWT cty (Content Type) header parameter value. A null value will remove the property from the JSON map.

In the normal case where nested signing or encryption operations are not employed (i.e. a compact serialization JWT), the use of this header parameter is NOT RECOMMENDED. In the case that nested signing or encryption is employed, this Header Parameter MUST be present; in this case, the value MUST be JWT, to indicate that a Nested JWT is carried in this JWT. While media type names are not case-sensitive, it is RECOMMENDED that JWT always be spelled using uppercase characters for compatibility with legacy implementations. See JWT Appendix A.2 for an example of a Nested JWT.

Parameters:

cty - the JWT JOSE cty header value or null to remove the property from the JSON map.

getCompressionAlgorithm

String getCompressionAlgorithm()

Returns the JWT calg (Compression Algorithm) header value or null if not present.

Returns:

the calg header parameter value or null if not present.

Since:

0.6.0

setCompressionAlgorithm

T setCompressionAlgorithm(String calg)

Sets the JWT calg (Compression Algorithm) header parameter value. A null value will remove the property from the JSON map.

The compression algorithm is NOT part of the JWT specification and must be used carefully since, is not expected that other libraries (including previous versions of this one) be able to deserialize a compressed JTW body correctly.

Parameters:

calg - the JWT compression algorithm calg value or null to remove the property from the JSON map.

Since:

0.6.0