net.rim.device.api.crypto.cms
Class CMSCompressedDataOutputStream

java.lang.Object
  java.io.OutputStream
      net.rim.device.api.crypto.cms.CMSOutputStream
          net.rim.device.api.crypto.cms.CMSCompressedDataOutputStream

public final class CMSCompressedDataOutputStream
extends CMSOutputStream

Implements a CMS Compressed data output stream so that outgoing data can be compressed and formatted as per CMS compressed data messages.

See Also:

CMSCompressedDataInputStream

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.0.0

Field Summary
	static int	ZLIB_COMPRESSION A constant representing the ZLIB form of compression.

Fields inherited from class net.rim.device.api.crypto.cms.CMSOutputStream

_contentType, _dataOut, _out, _outer

Constructor Summary
	CMSCompressedDataOutputStream(OutputStream out, int contentType, boolean outer) Creates a compressed data output stream using ZLIB_COMPRESSION.
	CMSCompressedDataOutputStream(OutputStream out, int contentType, int compressionType, boolean outer) Creates a compressed data output stream.

Method Summary
	void	close() Closes this output stream and releases any system resources associated with this stream.
	void	write(byte[] data, int offset, int length) Writes len bytes from the specified byte array starting at offset off to this output stream.

Methods inherited from class net.rim.device.api.crypto.cms.CMSOutputStream

flush, write, write

Methods inherited from class java.lang.Object

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

Field Detail

ZLIB_COMPRESSION

public static final int ZLIB_COMPRESSION

A constant representing the ZLIB form of compression.

See Also:

Constant Field Values

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.0.0

Constructor Detail

CMSCompressedDataOutputStream

public CMSCompressedDataOutputStream(OutputStream out,
                                     int contentType,
                                     boolean outer)

Creates a compressed data output stream using ZLIB_COMPRESSION.

Parameters:

out - The output stream to write data too.

contentType - The type of data being compressed.

outer - A boolean to determine if this is the outer CMS stream, since CMS streams can be nested within themselves. The stream needs to know if it is the "outer" layer so it can do some extra processing. For example, if you wish to sign and then encrypt a message, the CMSSignedDataOutputStream will be the "outer" layer.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.0.0

CMSCompressedDataOutputStream

public CMSCompressedDataOutputStream(OutputStream out,
                                     int contentType,
                                     int compressionType,
                                     boolean outer)

Creates a compressed data output stream.

Parameters:

out - The output stream to write data too.

contentType - The type of data being compressed.

compressionType - an integer constant representing the compression type to use. Note that only ZLIB_COMPRESSION is currently supported.

outer - A boolean to determine if this is the outer CMS stream, since CMS streams can be nested within themselves. The stream needs to know if it is the "outer" layer so it can do some extra processing. For example, if you wish to sign and then encrypt a message, the CMSSignedDataOutputStream will be the "outer" layer.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.0.0

Method Detail

write

public void write(byte[] data,
                  int offset,
                  int length)
           throws IOException

Description copied from class: OutputStream

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.

The write method of OutputStream calls the write method of one argument on each of the bytes to be written out. Subclasses are encouraged to override this method and provide a more efficient implementation.

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.

Specified by:

write in class CMSOutputStream

Parameters:

data - the data.

offset - the start offset in the data.

length - the number of bytes to write.

Throws:

IOException - if an I/O error occurs. In particular, an IOException is thrown if the output stream is closed.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.0.0

close

public void close()
           throws IOException

Description copied from class: OutputStream

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.

The close method of OutputStream does nothing.

Overrides:

close in class CMSOutputStream

Throws:

IOException - if an I/O error occurs.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.0.0