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

java.lang.Object
  java.io.InputStream
      net.rim.device.api.crypto.cms.CMSInputStream
          net.rim.device.api.crypto.cms.CMSDataInputStream

public final class CMSDataInputStream
extends CMSInputStream

Implements a CMS data input stream.

See Also:

CMSDataOutputStream

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

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

_contentType, _data, _input

Method Summary
	int	available() Returns the number of bytes that can be read (or skipped over) from this input stream without blocking by the next caller of a method for this input stream.
	boolean	isContentComplete() Determines whether the entire content part ( ie. the inner CMS message ) of this stream was in this stream.
	boolean	isEncrypted() Determines if this part, or any nested part, of this CMS message is encrypted.
	boolean	isSigned() Determines if this part, or any nested part, of this CMS message is signed.
	int	read(byte[] buffer, int offset, int length) Reads up to len bytes of data from the input stream into an array of bytes.
	void	setData(InputStream data) Allows the user to set the stream where the data can be found.
	long	skip(long n) Skips over and discards n bytes of data from this input stream.

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

close, getCMSContext, getCMSInputStream, getCMSInputStream, getCMSInputStream, getCMSInputStream, getCMSInputStream, getCMSInputStream, getCMSInputStream, getContentType, read, read

Methods inherited from class java.io.InputStream

mark, markSupported, reset

Methods inherited from class java.lang.Object

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

Method Detail

isSigned

public boolean isSigned()

Description copied from class: CMSInputStream

Determines if this part, or any nested part, of this CMS message is signed.

Specified by:

isSigned in class CMSInputStream

Returns:

A boolean that represents whether the message part is signed.

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

isEncrypted

public boolean isEncrypted()

Description copied from class: CMSInputStream

Determines if this part, or any nested part, of this CMS message is encrypted.

Specified by:

isEncrypted in class CMSInputStream

Returns:

A boolean that represents whether the message part is encrypted.

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

read

public int read(byte[] buffer,
                int offset,
                int length)
         throws IOException

Description copied from class: InputStream

Reads up to len bytes of data from the input stream into an array of bytes. An attempt is made to read as many as len bytes, but a smaller number may be read, possibly zero. The number of bytes actually read is returned as an integer.

This method blocks until input data is available, end of file is detected, or an exception is thrown.

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.

If len is zero, then no bytes are read and 0 is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at end of file, the value -1 is returned; otherwise, at least one byte is read and stored into b.

The first byte read is stored into element b[off], the next one into b[off+1], and so on. The number of bytes read is, at most, equal to len. Let k be the number of bytes actually read; these bytes will be stored in elements b[off] through b[off+k-1], leaving elements b[off+k] through b[off+len-1] unaffected.

In every case, elements b[0] through b[off] and elements b[off+len] through b[b.length-1] are unaffected.

If the first byte cannot be read for any reason other than end of file, then an IOException is thrown. In particular, an IOException is thrown if the input stream has been closed.

The read(b, off, len) method for class InputStream simply calls the method read() repeatedly. If the first such call results in an IOException, that exception is returned from the call to the read(b, off, len) method. If any subsequent call to read() results in a IOException, the exception is caught and treated as if it were end of file; the bytes read up to that point are stored into b and the number of bytes read before the exception occurred is returned. Subclasses are encouraged to provide a more efficient implementation of this method.

Specified by:

read in class CMSInputStream

Parameters:

buffer - the buffer into which the data is read.

offset - the start offset in array b at which the data is written.

length - the maximum number of bytes to read.

Returns:

the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached.

Throws:

IOException - if an I/O error occurs.

See Also:

InputStream.read()

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

available

public int available()
              throws IOException

Description copied from class: InputStream

Returns the number of bytes that can be read (or skipped over) from this input stream without blocking by the next caller of a method for this input stream. The next caller might be the same thread or or another thread.

The available method for class InputStream always returns 0.

This method should be overridden by subclasses.

Overrides:

available in class CMSInputStream

Returns:

the number of bytes that can be read from this input stream without blocking.

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

skip

public long skip(long n)
          throws IOException

Description copied from class: InputStream

Skips over and discards n bytes of data from this input stream. The skip method may, for a variety of reasons, end up skipping over some smaller number of bytes, possibly 0. This may result from any of a number of conditions; reaching end of file before n bytes have been skipped is only one possibility. The actual number of bytes skipped is returned. If n is negative, no bytes are skipped.

The skip method of InputStream creates a byte array and then repeatedly reads into it until n bytes have been read or the end of the stream has been reached. Subclasses are encouraged to provide a more efficient implementation of this method.

Overrides:

skip in class CMSInputStream

Parameters:

n - the number of bytes to be skipped.

Returns:

the actual number of bytes skipped.

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

setData

public void setData(InputStream data)
             throws IOException,
                    CMSException,
                    CryptoTokenException,
                    KeyStoreCancelException,
                    CryptoUnsupportedOperationException,
                    UnsupportedCryptoSystemException,
                    InvalidCryptoSystemException,
                    InvalidKeyException,
                    InvalidKeyEncodingException

Allows the user to set the stream where the data can be found. This method does nothing for this particular implementation.

You would call this function in the case that the contents of the message is detached from the actual CMS encoding. For example, in a clear signed SMIME message, the text ( what is signed ) is in a different MIME part then the CMS encoding. You could use this function to give CMS an input stream that points to the MIME part containing the text of the message.

Specified by:

setData in class CMSInputStream

Parameters:

data - The input stream containing the data.

Throws:

IOException - Thrown if an IO error occurs.

CMSException - Thrown if a cms error occurs.

CryptoTokenException - Thrown if an error occurs with a crypto token or the crypto token is invalid.

KeyStoreCancelException - Thrown if the user fails to enter a password or the password is invalid.

CryptoUnsupportedOperationException - Thrown if a call is made to an unsupported operation.

UnsupportedCryptoSystemException - Thrown if the specified crypto system is invalid.

InvalidCryptoSystemException - Thrown if the specified crypto system is invalid.

InvalidKeyException - Thrown if the specified key is invalid.

InvalidKeyEncodingException - Thrown if the key is improperly formatted.

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

isContentComplete

public boolean isContentComplete()

Determines whether the entire content part ( ie. the inner CMS message ) of this stream was in this stream.

Specified by:

isContentComplete in class CMSInputStream

Returns:

True since an CMSDataInputStream has no content, then this is vacuously true.

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