Top Description Inners Fields Constructors Methods
org.bouncycastle.cms

public Class CMSCompressedDataStreamGenerator

extends Object
Class Inheritance
Imports
java.io.IOException, .OutputStream, org.bouncycastle.asn1.ASN1Integer, .ASN1ObjectIdentifier, .BERSequenceGenerator, org.bouncycastle.asn1.cms.CMSObjectIdentifiers, org.bouncycastle.operator.OutputCompressor
General class for generating a compressed CMS message stream.

A simple example of usage. 

     CMSCompressedDataStreamGenerator gen = new CMSCompressedDataStreamGenerator();

     OutputStream cOut = gen.open(outputStream, new ZlibCompressor());

     cOut.write(data);

     cOut.close();

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
CMSCompressedDataStreamGenerator.CmsCompressedOutputStream

Field Summary

Modifier and TypeField and Description
private int
_bufferSize

public static final String
ZLIB

Constructor Summary

AccessConstructor and Description
public
CMSCompressedDataStreamGenerator()

base constructor

Method Summary

Modifier and TypeMethod and Description
public OutputStream

Returns:

an output stream to write the data be compressed to.
open(OutputStream
the stream to encode to.
out, OutputCompressor
the type of compressor to use.
compressor)

Open a compressing output stream with the PKCS#7 content type OID of "data".

public OutputStream

Returns:

an output stream to write the data be compressed to.
open(ASN1ObjectIdentifier
the content type OID.
contentOID, OutputStream
the stream to encode to.
out, OutputCompressor
the type of compressor to use.
compressor)

Open a compressing output stream.

public void
setBufferSize(int
length of octet strings to buffer the data.
bufferSize)

Set the underlying string size for encapsulated data

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

_bufferSizeback to summary
private int _bufferSize
ZLIBback to summary
public static final String ZLIB

Constructor Detail

CMSCompressedDataStreamGeneratorback to summary
public CMSCompressedDataStreamGenerator()

base constructor

Method Detail

openback to summary
public OutputStream open(OutputStream out, OutputCompressor compressor) throws IOException

Open a compressing output stream with the PKCS#7 content type OID of "data".

Parameters
out:OutputStream

the stream to encode to.

compressor:OutputCompressor

the type of compressor to use.

Returns:OutputStream

an output stream to write the data be compressed to.

openback to summary
public OutputStream open(ASN1ObjectIdentifier contentOID, OutputStream out, OutputCompressor compressor) throws IOException

Open a compressing output stream.

Parameters
contentOID:ASN1ObjectIdentifier

the content type OID.

out:OutputStream

the stream to encode to.

compressor:OutputCompressor

the type of compressor to use.

Returns:OutputStream

an output stream to write the data be compressed to.

setBufferSizeback to summary
public void setBufferSize(int bufferSize)

Set the underlying string size for encapsulated data

Parameters
bufferSize:int

length of octet strings to buffer the data.

org.bouncycastle.cms back to summary

private Class CMSCompressedDataStreamGenerator.CmsCompressedOutputStream

extends OutputStream
Class Inheritance

Field Summary

Modifier and TypeField and Description
private BERSequenceGenerator
_cGen

private BERSequenceGenerator
_eiGen

private OutputStream
_out

private BERSequenceGenerator
_sGen

Constructor Summary

AccessConstructor and Description
pack-priv
CmsCompressedOutputStream(OutputStream out, BERSequenceGenerator sGen, BERSequenceGenerator cGen, BERSequenceGenerator eiGen)

Method Summary

Modifier and TypeMethod and Description
public void
close()

Overrides java.io.OutputStream.close.

Implements java.io.Closeable.close.

Closes this output stream and releases any system resources associated with this stream.
public void
write(int
the byte.
b)

Implements abstract java.io.OutputStream.write.

Writes the specified byte to this output stream.
public void
write(byte[]
the data.
bytes, int
the start offset in the data.
off, int
the number of bytes to write.
len)

Overrides java.io.OutputStream.write.

Writes len bytes from the specified byte array starting at offset off to this output stream.
public void
write(byte[]
the data.
bytes)

Overrides java.io.OutputStream.write.

Writes b.length bytes from the specified byte array to this output stream.
Inherited from java.io.OutputStream:
flushnullOutputStream

Field Detail

_cGenback to summary
private BERSequenceGenerator _cGen
_eiGenback to summary
private BERSequenceGenerator _eiGen
_outback to summary
private OutputStream _out
_sGenback to summary
private BERSequenceGenerator _sGen

Constructor Detail

CmsCompressedOutputStreamback to summary
pack-priv CmsCompressedOutputStream(OutputStream out, BERSequenceGenerator sGen, BERSequenceGenerator cGen, BERSequenceGenerator eiGen)

Method Detail

closeback to summary
public void close() throws IOException

Overrides java.io.OutputStream.close.

Implements java.io.Closeable.close.

Doc from java.io.OutputStream.close.

Closes this output stream and releases any system resources associated with this stream. The general contract of close is that it closes the output stream. A closed stream cannot perform output operations and cannot be reopened.

Exceptions
IOException:
if an I/O error occurs.
writeback to summary
public void write(int b) throws IOException

Implements abstract java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

Writes the specified byte to this output stream. The general contract for write is that one byte is written to the output stream. The byte to be written is the eight low-order bits of the argument b. The 24 high-order bits of b are ignored.

Parameters
b:int

the byte.

Exceptions
IOException:
if an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.
writeback to summary
public void write(byte[] bytes, int off, int len) throws IOException

Overrides java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

Writes len bytes from the specified byte array starting at offset off to this output stream. The general contract for write(b, off, len) is that some of the bytes in the array b are written to the output stream in order; element b[off] is the first byte written and b[off+len-1] is the last byte written by this operation.

If b is null, a NullPointerException is thrown.

If off is negative, or len is negative, or off+len is greater than the length of the array b, then an IndexOutOfBoundsException is thrown.

Parameters
bytes:byte[]

the data.

off:int

the start offset in the data.

len:int

the number of bytes to write.

Exceptions
IOException:
if an I/O error occurs. In particular, an IOException is thrown if the output stream is closed.
writeback to summary
public void write(byte[] bytes) throws IOException

Overrides java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

Writes b.length bytes from the specified byte array to this output stream. The general contract for write(b) is that it should have exactly the same effect as the call write(b, 0, b.length).

Parameters
bytes:byte[]

the data.

Exceptions
IOException:
if an I/O error occurs.