SHOW Signed SHOW CryptoExtensionAPI

net.rim.device.api.crypto.encoder
Class MSCAPI_PublicKeyDecoder

java.lang.Object
  |
  +--net.rim.device.api.crypto.encoder.PublicKeyDecoder
        |
        +--net.rim.device.api.crypto.encoder.MSCAPI_PublicKeyDecoder

public class MSCAPI_PublicKeyDecoder
extends PublicKeyDecoder

Implements the public key decoder for Microsoft Crypto api keys.

Category:
CryptoExtensionAPI: This element is part of the Crypto Extension API. These APIs are intended for parties interested in extending the security provider frameworks, such as integrating a new security medium.
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 3.6.0
See Also:
MSCAPI_PrivateKeyDecoder

Constructor Summary
 Category: CryptoExtensionAPI Category: Signed MSCAPI_PublicKeyDecoder()
          Creates a new MSCAPI_PublicKeyDecoder object.
 
Method Summary
 Category: CryptoExtensionAPI Category: Signed protected  PublicKey decodeKey(InputStream input, CryptoSystem defaultCryptoSystem, String defaultKeyAlgorithm)
          Decodes the passed in key.
 Category: CryptoExtensionAPI Category: Signed protected  PublicKey decodeKey(InputStream input, String algorithm)
          Decodes the given key using the specified algorithm.
 Category: CryptoExtensionAPI Category: Signed  String getEncodingAlgorithm()
          Returns the encoding algorithm used, "MSCAPI".
 Category: CryptoExtensionAPI Category: Signed  String[] getKeyAlgorithms()
          Returns the key algorithm encoded.
 
Methods inherited from class net.rim.device.api.crypto.encoder.PublicKeyDecoder
decode, decode, decode, decode, getDecoder, register
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MSCAPI_PublicKeyDecoder

public MSCAPI_PublicKeyDecoder()
Creates a new MSCAPI_PublicKeyDecoder object.

This is the default constructor.

Since:
JDE 3.6.0
Category:
CryptoExtensionAPI: This element is part of the Crypto Extension API. These APIs are intended for parties interested in extending the security provider frameworks, such as integrating a new security medium.
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

decodeKey

protected PublicKey decodeKey(InputStream input,
                              CryptoSystem defaultCryptoSystem,
                              String defaultKeyAlgorithm)
                       throws NoSuchAlgorithmException,
                              InvalidKeyEncodingException,
                              InvalidKeyException,
                              InvalidCryptoSystemException,
                              UnsupportedCryptoSystemException,
                              CryptoTokenException,
                              CryptoUnsupportedOperationException,
                              IOException
Description copied from class: PublicKeyDecoder
Decodes the passed in key.

Overrides:
decodeKey in class PublicKeyDecoder
Since:
JDE 3.6.0

Following copied from class: PublicKeyDecoder
Parameters:
encodedKey - The public key to decode, passed in as an input stream.
cryptoSystem - A cryptoSystem containing the parameters to use in making this key.
keyAlgorithm - The type of key.
Returns:
The decoded public key.
Throws:
NoSuchAlgorithmException - Thrown if the specified algorithm is invalid.
InvalidKeyEncodingException - Thrown if the key is improperly formatted.
InvalidKeyException - Thrown if the specified key is invalid.
InvalidCryptoSystemException - Thrown if the specified crypto system is invalid.
UnsupportedCryptoSystemException - Thrown if the specified crypto system is unsupported.
CryptoTokenException - Thrown if an error occurs with the crypto token or the crypto token is invalid.
CryptoUnsupportedOperationException - Thrown if a call is made to an unsupported operation.
IOException - Thrown when an I/O error occurs.
Category:
CryptoExtensionAPI: This element is part of the Crypto Extension API. These APIs are intended for parties interested in extending the security provider frameworks, such as integrating a new security medium.
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.

decodeKey

protected PublicKey decodeKey(InputStream input,
                              String algorithm)
                       throws NoSuchAlgorithmException,
                              InvalidKeyEncodingException,
                              InvalidKeyException,
                              InvalidCryptoSystemException,
                              UnsupportedCryptoSystemException,
                              CryptoTokenException,
                              CryptoUnsupportedOperationException,
                              IOException
Decodes the given key using the specified algorithm.

Generally Implemented by subclasses to finish decoding the key.

Parameters:
input - The input stream containing the key data.
algorithm - A String representing the algorithm used to encode the key.
Returns:
The decoded public key.
Throws:
NoSuchAlgorithmException - Thrown if the specified algorithm is invalid.
InvalidKeyEncodingException - Thrown if the key is improperly formatted.
InvalidKeyException - Thrown if the specified key is invalid.
InvalidCryptoSystemException - Thrown if the specified crypto system is invalid.
UnsupportedCryptoSystemException - Thrown if the specified crypto system is unsupported.
CryptoTokenException - Thrown if an error occurs with the crypto token or the crypto token is invalid.
CryptoUnsupportedOperationException - Thrown if a call is made to an unsupported operation.
IOException - Thrown when an I/O error occurs.
Since:
JDE 3.6.0
Category:
CryptoExtensionAPI: This element is part of the Crypto Extension API. These APIs are intended for parties interested in extending the security provider frameworks, such as integrating a new security medium.
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.

getEncodingAlgorithm

public String getEncodingAlgorithm()
Returns the encoding algorithm used, "MSCAPI".

This method will always return the String "MSCAPI".

Overrides:
getEncodingAlgorithm in class PublicKeyDecoder
Returns:
A String representing the name of the encoding algorithm.
Since:
JDE 3.6.0
Category:
CryptoExtensionAPI: This element is part of the Crypto Extension API. These APIs are intended for parties interested in extending the security provider frameworks, such as integrating a new security medium.
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.

getKeyAlgorithms

public String[] getKeyAlgorithms()
Returns the key algorithm encoded.

Overrides:
getKeyAlgorithms in class PublicKeyDecoder
Returns:
An array of Strings representing the key algorithm.
Since:
JDE 3.6.0
Category:
CryptoExtensionAPI: This element is part of the Crypto Extension API. These APIs are intended for parties interested in extending the security provider frameworks, such as integrating a new security medium.
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-2007 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.