io.jsonwebtoken

Interface CompressionCodec

public interface CompressionCodec

Compresses and decompresses byte arrays according to a compression algorithm.

Since:

0.6.0

See Also:

CompressionCodecs.DEFLATE, CompressionCodecs.GZIP

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	compress(byte[] payload) Compresses the specified byte array according to the compression algorithm.
byte[]	decompress(byte[] compressed) Decompresses the specified compressed byte array according to the compression algorithm.
java.lang.String	getAlgorithmName() The compression algorithm name to use as the JWT's zip header value.

Method Detail

getAlgorithmName

java.lang.String getAlgorithmName()

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

Returns:

the compression algorithm name to use as the JWT's zip header value.

compress

byte[] compress(byte[] payload)
                throws CompressionException

Compresses the specified byte array according to the compression algorithm.

Parameters:

payload - bytes to compress

Returns:

compressed bytes

Throws:

CompressionException - if the specified byte array cannot be compressed according to the compression algorithm.

decompress

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

Decompresses the specified compressed byte array according to the compression algorithm. The specified byte array must already be in compressed form according to the algorithm.

Parameters:

compressed - compressed bytes

Returns:

decompressed bytes

Throws:

CompressionException - if the specified byte array cannot be decompressed according to the compression algorithm.