io.jsonwebtoken.impl.compression

Class AbstractCompressionCodec

java.lang.Object

io.jsonwebtoken.impl.compression.AbstractCompressionCodec

All Implemented Interfaces:

CompressionCodec

Direct Known Subclasses:

DeflateCompressionCodec, GzipCompressionCodec

public abstract class AbstractCompressionCodec
extends Object
implements CompressionCodec

Abstract class that asserts arguments and wraps IOException with CompressionException.

Since:

0.6.0

Constructor Summary

Constructors

Constructor and Description
AbstractCompressionCodec()

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	compress(byte[] payload) Asserts that payload is not null and calls doCompress
byte[]	decompress(byte[] compressed) Asserts the compressed bytes is not null and calls doDecompress
protected abstract byte[]	doCompress(byte[] payload) Implement this method to do the actual work of compressing the payload
protected abstract byte[]	doDecompress(byte[] compressed) Implement this method to do the actual work of decompressing the compressed bytes.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.jsonwebtoken.CompressionCodec

getAlgorithmName

Constructor Detail

AbstractCompressionCodec

public AbstractCompressionCodec()

Method Detail

doCompress

protected abstract byte[] doCompress(byte[] payload)
                              throws IOException

Implement this method to do the actual work of compressing the payload

Parameters:

payload - the bytes to compress

Returns:

the compressed bytes

Throws:

IOException - if the compression causes an IOException

compress

public final byte[] compress(byte[] payload)

Asserts that payload is not null and calls doCompress

Specified by:

compress in interface CompressionCodec

Parameters:

payload - bytes to compress

Returns:

compressed bytes

Throws:

CompressionException - if doCompress throws an IOException

decompress

public final byte[] decompress(byte[] compressed)

Asserts the compressed bytes is not null and calls doDecompress

Specified by:

decompress in interface CompressionCodec

Parameters:

compressed - compressed bytes

Returns:

decompressed bytes

Throws:

CompressionException - if doDecompress throws an IOException

doDecompress

protected abstract byte[] doDecompress(byte[] compressed)
                                throws IOException

Implement this method to do the actual work of decompressing the compressed bytes.

Parameters:

compressed - compressed bytes

Returns:

decompressed bytes

Throws:

IOException - if the decompression runs into an IO problem