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 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:
JDE 4.0.0
See Also:
CMSCompressedDataInputStream

Field Summary
 Category: Signed 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
 Category: Signed CMSCompressedDataOutputStream(OutputStream out, int contentType, boolean outer)
          Creates a compressed data output stream using ZLIB_COMPRESSION.
 Category: Signed CMSCompressedDataOutputStream(OutputStream out, int contentType, int compressionType, boolean outer)
          Creates a compressed data output stream.
 
Method Summary
 Category: Signed  void close()
          Closes this output stream and releases any system resources associated with this stream.
 Category: Signed  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.
Since:
JDE 4.0.0
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.
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 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.

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 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.
Method Detail

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

Following copied from class: OutputStream
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.

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

Following copied from class: OutputStream
Parameters:
b - the data.
off - the start offset in the data.
len - 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.



Copyright 1999-2009 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.