SHOW Signed

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.

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

Since:

JDE 4.0.0

See Also:

CMSCompressedDataInputStream

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()
	void	write(byte[] data, int offset, int length)

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.

Since:

JDE 4.0.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

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.

Since:

JDE 4.0.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

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.

Since:

JDE 4.0.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

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.

Overrides:

write in class CMSOutputStream

Since:

JDE 4.0.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

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

Since:

JDE 4.0.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.