io.jsonwebtoken.CompressionCodecs Maven / Gradle / Ivy

package io.jsonwebtoken;

import io.jsonwebtoken.impl.compression.DeflateCompressionCodec;
import io.jsonwebtoken.impl.compression.GzipCompressionCodec;

/**
 * Provides default implementations of the {@link CompressionCodec} interface.
 *
 * @see #DEFLATE
 * @see #GZIP
 * @since 0.7.0
 */
public final class CompressionCodecs {

    private static final CompressionCodecs INSTANCE = new CompressionCodecs();

    private CompressionCodecs() {} //prevent external instantiation

    /**
     * Codec implementing the JWA standard
     * deflate compression algorithm
     */
    public static final CompressionCodec DEFLATE = new DeflateCompressionCodec();

    /**
     * Codec implementing the gzip compression algorithm.
     * Compatibility Warning
     * This is not a standard JWA compression algorithm.  Be sure to use this only when you are confident
     * that all parties accessing the token support the gzip algorithm.
     * If you're concerned about compatibility, the {@link #DEFLATE DEFLATE} code is JWA standards-compliant.
     */
    public static final CompressionCodec GZIP = new GzipCompressionCodec();

}