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.

See Also:

MSCAPI_PrivateKeyDecoder

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 3.6.0

Constructor Summary
	MSCAPI_PublicKeyDecoder() Creates a new MSCAPI_PublicKeyDecoder object.

Method Summary
	protected PublicKey	decodeKey(InputStream input, String algorithm) Decodes the given key using the specified algorithm.
	protected PublicKey	decodeKey(InputStream input, CryptoSystem defaultCryptoSystem, String defaultKeyAlgorithm) Decodes the passed in key.
	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.

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 3.6.0

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.

Specified by:

decodeKey in class PublicKeyDecoder

Parameters:

input - The public key to decode, passed in as an input stream.

defaultCryptoSystem - A cryptoSystem containing the parameters to use in making this key.

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

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 3.6.0

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.

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 3.6.0

getEncodingAlgorithm

public String getEncodingAlgorithm()

Returns the encoding algorithm used, "MSCAPI".

This method will always return the String "MSCAPI".

Specified by:

getEncodingAlgorithm in class PublicKeyDecoder

Returns:

A String representing the name of the encoding algorithm.

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 3.6.0

getKeyAlgorithms

public String[] getKeyAlgorithms()

Returns the key algorithm encoded.

Specified by:

getKeyAlgorithms in class PublicKeyDecoder

Returns:

An array of Strings representing the key algorithm.

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 3.6.0