io.jsonwebtoken.impl.compression

Class DefaultCompressionCodecResolver

java.lang.Object

io.jsonwebtoken.impl.compression.DefaultCompressionCodecResolver

All Implemented Interfaces:

CompressionCodecResolver

public class DefaultCompressionCodecResolver
extends Object
implements CompressionCodecResolver

Default implementation of CompressionCodecResolver that supports the following:

• If the specified JWT Header does not have a calg header, this implementation does nothing and returns null to the caller, indicating no compression was used.
• If the header has a calg value of DEF, a DeflateCompressionCodec will be returned.
• If the header has a calg value of GZIP, a GzipCompressionCodec will be returned.
• If the header has any other calg value, a CompressionException is thrown to reflect an unrecognized algorithm.

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

See Also:

DeflateCompressionCodec, GzipCompressionCodec

Constructor Summary

Constructors

Constructor and Description
DefaultCompressionCodecResolver()

Method Summary

Methods

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultCompressionCodecResolver

public DefaultCompressionCodecResolver()

Method Detail

resolveCompressionCodec

public CompressionCodec resolveCompressionCodec(Header header)

Description copied from interface: CompressionCodecResolver

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

Specified by:

resolveCompressionCodec in interface CompressionCodecResolver

Parameters:

header - of the JWT

Returns:

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