io.jsonwebtoken

Interface CompressionCodecResolver

All Known Implementing Classes:

DefaultCompressionCodecResolver

public interface CompressionCodecResolver

Looks for a JWT calg header, and if found, returns the corresponding CompressionCodec the parser can use to decompress the JWT body.

JJWT's default JwtParser implementation supports both the DEFLATE and GZIP algorithms by default - you do not need to specify a CompressionCodecResolver in these cases.

However, if you want to use a compression algorithm other than DEF or GZIP, you must implement your own CompressionCodecResolver and specify that when building and parsing JWTs.

Since:

0.6.0

Method Summary

Modifier and Type	Method and Description
CompressionCodec	resolveCompressionCodec(Header header) Looks for a JWT calg header, and if found, returns the corresponding CompressionCodec the parser can use to decompress the JWT body.

Method Detail

resolveCompressionCodec

CompressionCodec resolveCompressionCodec(Header header)
                                  throws CompressionException

Looks for a JWT calg header, and if found, returns the corresponding CompressionCodec the parser can use to decompress the JWT body.

Parameters:

header - of the JWT

Returns:

CompressionCodec matching the calg header, or null if there is no calg header.

Throws:

CompressionException - if a calg header value is found and not supported.