io.jsonwebtoken.impl.compression

Class AbstractCompressionAlgorithm

java.lang.Object

io.jsonwebtoken.impl.compression.AbstractCompressionAlgorithm

All Implemented Interfaces:

CompressionCodec, Identifiable, CompressionAlgorithm

Direct Known Subclasses:

DeflateCompressionAlgorithm, GzipCompressionAlgorithm

public abstract class AbstractCompressionAlgorithm
extends Object
implements CompressionAlgorithm, CompressionCodec

Abstract class that asserts arguments and wraps IOException with CompressionException.

Since:

0.6.0

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractCompressionAlgorithm(String id)

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	compress(byte[] content)
OutputStream	compress(OutputStream out)
byte[]	decompress(byte[] compressed) Asserts the compressed bytes is not null and calls doDecompress
InputStream	decompress(InputStream is)
protected abstract OutputStream	doCompress(OutputStream out)
protected byte[]	doDecompress(byte[] compressed) Implement this method to do the actual work of decompressing the compressed bytes.
protected abstract InputStream	doDecompress(InputStream is)
String	getAlgorithmName()
String	getId()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractCompressionAlgorithm

protected AbstractCompressionAlgorithm(String id)

Method Detail

getId

public String getId()

Specified by:

getId in interface Identifiable

getAlgorithmName

public String getAlgorithmName()

Specified by:

getAlgorithmName in interface CompressionCodec

compress

public final OutputStream compress(OutputStream out)
                            throws CompressionException

Specified by:

compress in interface CompressionAlgorithm

Throws:

CompressionException

doCompress

protected abstract OutputStream doCompress(OutputStream out)
                                    throws IOException

Throws:

IOException

decompress

public final InputStream decompress(InputStream is)
                             throws CompressionException

Specified by:

decompress in interface CompressionAlgorithm

Throws:

CompressionException

doDecompress

protected abstract InputStream doDecompress(InputStream is)
                                     throws IOException

Throws:

IOException

compress

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

Specified by:

compress in interface CompressionCodec

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 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