io.jsonwebtoken

Class Jwts.ZIP

java.lang.Object

io.jsonwebtoken.Jwts.ZIP

Enclosing class:

Jwts

public static final class Jwts.ZIP
extends Object

Constants for JWA (RFC 7518) compression algorithms referenced in the zip header defined in the JSON Web Encryption Compression Algorithms Registry. Each algorithm is available as a (public static final) constant for direct type-safe reference in application code. For example:

 Jwts.builder()
    // ... etc ...
    .compressWith(Jwts.ZIP.DEF)
    .build();

They are also available together as a Registry instance via the get() method.

Since:

0.12.0

See Also:

get()

Field Summary

Fields

Modifier and Type	Field and Description
static CompressionAlgorithm	DEF The JWE-standard DEFLATE compression algorithm with a zip header value of "DEF".
static CompressionAlgorithm	GZIP A commonly used, but NOT JWA-STANDARD gzip compression algorithm with a zip header value of "GZIP".

Method Summary

Methods

Modifier and Type	Method and Description
static Registry<String,CompressionAlgorithm>	get() Returns various useful Compression Algorithms.

Methods inherited from class java.lang.Object

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

Field Detail

DEF

public static final CompressionAlgorithm DEF

The JWE-standard DEFLATE compression algorithm with a zip header value of "DEF".

See Also:

JWE RFC 7516, Section 4.1.3

GZIP

public static final CompressionAlgorithm GZIP

A commonly used, but NOT JWA-STANDARD gzip compression algorithm with a zip header value of "GZIP".

Compatibility Warning

This is not a standard JWE compression algorithm. Be sure to use this only when you are confident that all parties accessing the token support the "GZIP" identifier and associated algorithm.

If you're concerned about compatibility, DEF is the only JWA standards-compliant algorithm.

See Also:

DEF

Method Detail

get

public static Registry<String,CompressionAlgorithm> get()

Returns various useful Compression Algorithms.

Returns:

various standard and non-standard useful compression algorithms.