io.jsonwebtoken

Interface HeaderMutator<T extends HeaderMutator<T>>

Type Parameters:

T - the mutator subtype, for method chaining

All Superinterfaces:

MapMutator<String,Object,T>

All Known Subinterfaces:

JweHeaderMutator<T>, JwtBuilder.BuilderHeader, Jwts.HeaderBuilder, ProtectedHeaderMutator<T>

public interface HeaderMutator<T extends HeaderMutator<T>>
extends MapMutator<String,Object,T>

Mutation (modifications) to a Header instance.

Since:

0.12.0

Method Summary

Methods

Modifier and Type	Method and Description
T	contentType(String cty) Sets the compact cty (Content Type) header parameter value, used by applications to declare the IANA MediaType of the JWT payload.
T	setCompressionAlgorithm(String zip) Deprecated. since 0.12.0 and will be removed before the 1.0 release.
T	setContentType(String cty) Deprecated. since 0.12.0 in favor of the more modern builder-style contentType(String).
T	setType(String typ) Deprecated. since 0.12.0 in favor of the more modern builder-style type(String) method. This method will be removed before the 1.0 release.
T	type(String typ) Sets the JWT typ (Type) header value.

Methods inherited from interface io.jsonwebtoken.lang.MapMutator

add, add, delete, empty

Method Detail

type

T type(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 instance for method chaining.

contentType

T contentType(String cty)

Sets the compact cty (Content Type) header parameter value, used by applications to declare the IANA MediaType of the JWT payload. A null value will remove the property from the JSON map.

Compact Media Type Identifier

This method will automatically remove any application/ prefix from the cty string if possible according to the rules defined in the last paragraph of RFC 7517, Section 4.1.10:

     To keep messages compact in common situations, it is RECOMMENDED that
     producers omit an "application/" prefix of a media type value in a
     "cty" Header Parameter when no other '/' appears in the media type
     value.  A recipient using the media type value MUST treat it as if
     "application/" were prepended to any "cty" value not containing a
     '/'.  For instance, a "cty" value of "example" SHOULD be used to
     represent the "application/example" media type, whereas the media
     type "application/example;part="1/2"" cannot be shortened to
     "example;part="1/2"".

JJWT performs the reverse during JWT parsing: Header.getContentType() will automatically prepend the application/ prefix if the parsed cty value does not contain a '/' character (as mandated by the RFC language above). This ensures application developers can use and read standard IANA Media Type identifiers without needing JWT-specific prefix conditional logic in application code.

Parameters:

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

Returns:

the instance for method chaining.

setType

@Deprecated
T setType(String typ)

Deprecated. since 0.12.0 in favor of the more modern builder-style type(String) method. This method will be removed before the 1.0 release.

Deprecated since of 0.12.0, delegates to type(String).

Parameters:

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

Returns:

the instance for method chaining.

See Also:

type(String)

setContentType

@Deprecated
T setContentType(String cty)

Deprecated. since 0.12.0 in favor of the more modern builder-style contentType(String).

Deprecated as of 0.12.0, delegates to contentType(String).

Parameters:

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

Returns:

the instance for method chaining.

See Also:

contentType(String)

setCompressionAlgorithm

@Deprecated
T setCompressionAlgorithm(String zip)

Deprecated. since 0.12.0 and will be removed before the 1.0 release.

Deprecated as of 0.12.0, there is no need to set this any longer as the JwtBuilder will always set the zip header as necessary.

Parameters:

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

Returns:

the instance for method chaining.

Since:

0.6.0