iaik.cms

Interface InputStreamCompressEngine

All Known Implementing Classes:

ZLIBCompressionInputStream

public interface InputStreamCompressEngine

The InputStreeamCompressEngine is used to wrap a standard InputStream so compression can be applied to the stream. Any class which implements compression should implement this interface so that it can be used by the CMS CompressedContent as the compressing agent.

Implementors can choose to compress the supplied data with any type of compression algorithm by the following means:

  1.  Extend the CompressionProvider class, and override method getInputStreamCompressEngine,
  which is specified as follows:
  
   if(algorithmid.equals(CompressionProvider.zlib_compress))
       return new ZLIBCompressionInputStream(inputstream, CompressMode, blocksize);
   else
      throw new NoSuchAlgorithmException("Algorithm " + algorithmid.getAlgorithm().getName() + " not available!");
  
  2.  Specify the AlgorithmID for the compression algorithm being used.  This AlgorithmID
  should be added into the extension of the CompressionProvider as CompressionProvider is
  an extension of AlgorithmID. 
  
  3.  Write a Compression InputStream class which implements interface
  InputStreamCompressEngine and make sure the getInputStream() method is 
  implemented.
  
 

Field Summary

Fields

Modifier and Type	Field and Description
static int	COMPRESS Indicates that the InputSTream returned will be compressed
static int	DECOMPRESS Indicates that the InputStream returned will be decompressed

Method Summary

Methods

Modifier and Type	Method and Description
java.io.InputStream	getInputStream()

Field Detail

DECOMPRESS

static final int DECOMPRESS

Indicates that the InputStream returned will be decompressed

See Also:

Constant Field Values

COMPRESS

static final int COMPRESS

Indicates that the InputSTream returned will be compressed

See Also:

Constant Field Values

Method Detail

getInputStream

java.io.InputStream getInputStream()

Returns:

the InputSTream which has been wrapped by the implemted compression algorithm.