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:

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

Since:

JDE 3.6.0

See Also:

MSCAPI_PrivateKeyDecoder

Constructor Summary

MSCAPI_PublicKeyDecoder() Creates a new MSCAPI_PublicKeyDecoder object.

Method Summary

	protected PublicKey	decodeKey(InputStream input, CryptoSystem defaultCryptoSystem, String defaultKeyAlgorithm)
	protected PublicKey	decodeKey(InputStream input, String algorithm) Decodes the given key using the specified algorithm.
	String	getEncodingAlgorithm() Returns the encoding algorithm used, "MSCAPI".
	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:

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

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

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

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:

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

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:

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

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:

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