Interface CompressionCodec

api/src/main/java/io/jsonwebtoken/CompressionCodec.java:34–70

Compresses and decompresses byte arrays according to a compression algorithm. &quot;zip&quot; identifier CompressionCodec extends Identifiable; the value returned from Identifiable#getId() getId() will be used as the JWT <a href="https://tools.ietf.org/html

 * @deprecated since 0.12.0 in favor of {@link io.jsonwebtoken.io.CompressionAlgorithm} to equal the RFC name for this concept.
 */
@Deprecated
public interface CompressionCodec extends CompressionAlgorithm {

    /**
     * The algorithm name to use as the JWT
     * <a href="https://tools.ietf.org/html/rfc7516#section-4.1.3"><code>zip</code></a> header value.
     *
     * @return the algorithm name to use as the JWT
     * <a href="https://tools.ietf.org/html/rfc7516#section-4.1.3"><code>zip</code></a> header value.
     * @deprecated since 0.12.0 in favor of {@link #getId()} to ensure congruence with
     * all other identifiable algorithms.
     */
    @SuppressWarnings("DeprecatedIsStillUsed")
    @Deprecated
    String getAlgorithmName();

    /**
     * Compresses the specified byte array, returning the compressed byte array result.
     *
     * @param content bytes to compress
     * @return compressed bytes
     * @throws CompressionException if the specified byte array cannot be compressed.
     */
    @Deprecated
    byte[] compress(byte[] content) throws CompressionException;

    /**
     * Decompresses the specified compressed byte array, returning the decompressed byte array result.  The
     * specified byte array must already be in compressed form.
     *
     * @param compressed compressed bytes
     * @return decompressed bytes
     * @throws CompressionException if the specified byte array cannot be decompressed.
     */
    @Deprecated
    byte[] decompress(byte[] compressed) throws CompressionException;
}