io.jsonwebtoken

Interface CompressionCodec

All Superinterfaces:

CompressionAlgorithm, Identifiable

Deprecated.

since 0.12.0 in favor of CompressionAlgorithm to equal the RFC name for this concept.

@Deprecated
public interface CompressionCodec
extends CompressionAlgorithm

Compresses and decompresses byte arrays according to a compression algorithm.

"zip" identifier

CompressionCodec extends Identifiable; the value returned from getId() will be used as the JWT zip header value.

Since:

0.6.0

See Also:

Jwts.ZIP.DEF, Jwts.ZIP.GZIP

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	compress(byte[] content) Deprecated.
byte[]	decompress(byte[] compressed) Deprecated.
String	getAlgorithmName() Deprecated. since 0.12.0 in favor of Identifiable.getId() to ensure congruence with all other identifiable algorithms.

Methods inherited from interface io.jsonwebtoken.io.CompressionAlgorithm

compress, decompress

Methods inherited from interface io.jsonwebtoken.Identifiable

getId

Method Detail

getAlgorithmName

@Deprecated
String getAlgorithmName()

Deprecated. since 0.12.0 in favor of Identifiable.getId() to ensure congruence with all other identifiable algorithms.

The algorithm name to use as the JWT zip header value.

Returns:

the algorithm name to use as the JWT zip header value.

compress

@Deprecated
byte[] compress(byte[] content)
                throws CompressionException

Deprecated.

Compresses the specified byte array, returning the compressed byte array result.

Parameters:

content - bytes to compress

Returns:

compressed bytes

Throws:

CompressionException - if the specified byte array cannot be compressed.

decompress

@Deprecated
byte[] decompress(byte[] compressed)
                  throws CompressionException

Deprecated.

Decompresses the specified compressed byte array, returning the decompressed byte array result. The specified byte array must already be in compressed form.

Parameters:

compressed - compressed bytes

Returns:

decompressed bytes

Throws:

CompressionException - if the specified byte array cannot be decompressed.