CMSContext (BlackBerry JDE 5.0.0 API Reference)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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

java.lang.Object
  net.rim.device.api.crypto.cms.CMSContext

public final class CMSContext
extends Object
extends Object

Implements a "two stage" method of processing CMS messages. The CMSContext holds the partially initialized CMSInputStream, from a getCMSContext call, until a further call in CMSInputStream to getCMSInputStream, finishes the processing.

See Also:: CMSInputStream
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 Summary
	`CMSEntityIdentifier[]`	`getEncryptionRecipients()` Returns an array of the recipients found in the upper most encryption layer in this message.
	`CMSEntityIdentifier[]`	`getSigners()` Returns an array of the signers found in the upper most signed layer in this message.
	`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.

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Method Detail

getEncryptionRecipients

public CMSEntityIdentifier[] getEncryptionRecipients()
                                              throws CMSParsingException

Returns an array of the recipients found in the upper most encryption layer in this message. If no encryption layer is found, null is returned.

Returns:: an array of CMSEntityIdentifiers representing the upper most encryption layer recipients
Throws:: CMSParsingException - if there is a formatting problem
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

getSigners

public CMSEntityIdentifier[] getSigners()
                                 throws CMSParsingException

Returns an array of the signers found in the upper most signed layer in this message. If no signed layer is found, null is returned.

Returns:: an array of CMSEntityIdentifiers representing the upper most signed layer signers
Throws:: CMSParsingException - if there is a formatting problem
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

isSigned

public boolean isSigned()

Determines if this part, or any nested part, of this CMS message is signed. Note that since the user has not entered their password yet, this boolean may be false when actually, an inner part of the message is signed. This may happen if the outer layer is encrypted and the inner layer is signed. Since the user hasn't entered their password to decrypt the message, we won't know that the inner part is signed.

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()

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

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