io.jsonwebtoken.impl

Class DefaultHeader<T extends Header<T>>

java.lang.Object

io.jsonwebtoken.impl.JwtMap

io.jsonwebtoken.impl.DefaultHeader<T>

All Implemented Interfaces:

Header<T>, Map<String,Object>

Direct Known Subclasses:

DefaultJwsHeader

public class DefaultHeader<T extends Header<T>>
extends JwtMap
implements Header<T>

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

COMPRESSION_ALGORITHM, CONTENT_TYPE, DEPRECATED_COMPRESSION_ALGORITHM, JWT_TYPE, TYPE

Constructor Summary

Constructors

Constructor and Description
DefaultHeader()
DefaultHeader(Map<String,Object> map)

Method Summary

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 compressionAlgorithm) 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 class io.jsonwebtoken.impl.JwtMap

clear, containsKey, containsValue, entrySet, equals, get, getDate, getString, hashCode, isEmpty, keySet, put, putAll, remove, setDate, setValue, size, toDate, toString, values

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Constructor Detail

DefaultHeader

public DefaultHeader()

DefaultHeader

public DefaultHeader(Map<String,Object> map)

Method Detail

getType

public String getType()

Description copied from interface: Header

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

Specified by:

getType in interface Header<T extends Header<T>>

Returns:

the typ header value or null if not present.

setType

public T setType(String typ)

Description copied from interface: Header

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

Specified by:

setType in interface Header<T extends Header<T>>

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

public String getContentType()

Description copied from interface: Header

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.

Specified by:

getContentType in interface Header<T extends Header<T>>

Returns:

the typ header parameter value or null if not present.

setContentType

public T setContentType(String cty)

Description copied from interface: Header

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.

Specified by:

setContentType in interface Header<T extends Header<T>>

Parameters:

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

getCompressionAlgorithm

public String getCompressionAlgorithm()

Description copied from interface: Header

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

Specified by:

getCompressionAlgorithm in interface Header<T extends Header<T>>

Returns:

the calg header parameter value or null if not present.

setCompressionAlgorithm

public T setCompressionAlgorithm(String compressionAlgorithm)

Description copied from interface: Header

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 Specified by:

setCompressionAlgorithm in interface Header<T extends Header<T>>

Parameters:

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