SHOW Signed

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

java.lang.Object
  |
  +--java.io.InputStream
        |
        +--net.rim.device.api.crypto.cms.CMSInputStream
              |
              +--net.rim.device.api.crypto.cms.CMSSignedReceiptInputStream

public final class CMSSignedReceiptInputStream
extends CMSInputStream

A CMSSignedReceiptInputStream allows the user to read in a signed receipt and process it properly.

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:
CMSSignedReceiptOutputStream

Fields inherited from class net.rim.device.api.crypto.cms.CMSInputStream
_contentType, _data, _input
 
Method Summary
 Category: Signed  OID getReceiptContentType()
          Returns the content type of the original email this receipt covers.
 Category: Signed  byte[] getSignature()
          Returns the encoding of the signature from the original message this receipt covers.
 Category: Signed  byte[] getSignedContentIdentifier()
          Returns the signed content identifier of this receipt.
 Category: Signed  boolean isContentComplete()
          Determines whether the entire content part ( ie. the inner CMS message ) of this stream was in this stream.
 Category: Signed  boolean isEncrypted()
          Determines if this part, or any nested part, of this CMS message is encrypted.
 Category: Signed  boolean isSigned()
          Determines if this part, or any nested part, of this CMS message is signed.
 Category: Signed  int read(byte[] data, int offset, int length)
          Reads up to len bytes of data from the input stream into an array of bytes.
 Category: Signed  void setData(InputStream data)
          Allows the user to set the stream where the compressed data can be found.
 
Methods inherited from class net.rim.device.api.crypto.cms.CMSInputStream
available, close, getCMSContext, getCMSInputStream, getCMSInputStream, getCMSInputStream, getCMSInputStream, getCMSInputStream, getCMSInputStream, getCMSInputStream, getContentType, read, read, skip
 
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

getReceiptContentType

public OID getReceiptContentType()
Returns the content type of the original email this receipt covers.

Returns:
An OID representing the original content type
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.

getSignedContentIdentifier

public byte[] getSignedContentIdentifier()
Returns the signed content identifier of this receipt.

Returns:
A byte[] representing the signed content identifier
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.

getSignature

public byte[] getSignature()
Returns the encoding of the signature from the original message this receipt covers.

Returns:
A byte[] representing the encoding of the signature.
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.

isEncrypted

public boolean isEncrypted()
Description copied from class: CMSInputStream
Determines if this part, or any nested part, of this CMS message is encrypted.

Overrides:
isEncrypted in class CMSInputStream
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.

isSigned

public boolean isSigned()
Description copied from class: CMSInputStream
Determines if this part, or any nested part, of this CMS message is signed.

Overrides:
isSigned in class CMSInputStream
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.

read

public int read(byte[] data,
                int offset,
                int length)
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.

Overrides:
read in class CMSInputStream
Since:
JDE 4.0.2
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.

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 compressed data can be found.

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.

Overrides:
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.
Since:
JDE 4.0.2
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.

isContentComplete

public boolean isContentComplete()
Determines whether the entire content part ( ie. the inner CMS message ) of this stream was in this stream.
Overrides:
isContentComplete in class CMSInputStream
Returns:
True since an CMSSignedReceiptInputStream has no content, then this is vacuously true.
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.


Copyright 1999-2004 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.