io.jsonwebtoken.io

Interface CompressionAlgorithm

All Superinterfaces:

Identifiable

All Known Subinterfaces:

CompressionCodec

public interface CompressionAlgorithm
extends Identifiable

Compresses and decompresses byte streams.

"zip" identifier

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

Custom Implementations

A custom implementation of this interface may be used when creating a JWT by calling the JwtBuilder.compressWith(CompressionAlgorithm) method.

To ensure that parsing is possible, the parser must be aware of the implementation by adding it to the JwtParserBuilder.zip() collection during parser construction.

Since:

0.12.0

See Also:

Jwts.ZIP#DEF, Jwts.ZIP#GZIP, JSON Web Encryption Compression Algorithms Registry

Method Summary

Methods

Modifier and Type	Method and Description
OutputStream	compress(OutputStream out) Wraps the specified OutputStream to ensure any stream bytes are compressed as they are written.
InputStream	decompress(InputStream in) Wraps the specified InputStream to ensure any stream bytes are decompressed as they are read.

Methods inherited from interface io.jsonwebtoken.Identifiable

getId

Method Detail

compress

OutputStream compress(OutputStream out)

Wraps the specified OutputStream to ensure any stream bytes are compressed as they are written.

Parameters:

out - the stream to wrap for compression

Returns:

the stream to use for writing

decompress

InputStream decompress(InputStream in)

Wraps the specified InputStream to ensure any stream bytes are decompressed as they are read.

Parameters:

in - the stream to wrap for decompression

Returns:

the stream to use for reading