SHOW Signed SHOW CryptoExtensionAPI
 

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

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

public class X509_PublicKeyDecoder
extends PublicKeyDecoder

Implements the public key decoder for X509.

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 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:
JDE 3.6.0

Constructor Summary
 Category: CryptoExtensionAPI Category: Signed X509_PublicKeyDecoder()
          Creates a new X509_PublicKeyDecoder object.
 
Method Summary
 Category: CryptoExtensionAPI Category: Signed protected  PublicKey decodeKey(ASN1InputByteArray parameters, String algorithm, byte[] subjectPublicKey, CryptoSystem cryptoSystem)
          e Decodes the specified public key.
 Category: CryptoExtensionAPI Category: Signed protected  PublicKey decodeKey(InputStream encodedKey, CryptoSystem cryptoSystem, String keyAlgorithm)
          Decodes the passed in key.
 Category: CryptoExtensionAPI Category: Signed protected  String getEncodingAlgorithm()
          Returns the encoding algorithm used, "X509".
 Category: CryptoExtensionAPI Category: Signed protected  String[] getKeyAlgorithms()
          Returns the key algorithm that was 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

X509_PublicKeyDecoder

public X509_PublicKeyDecoder()
Creates a new X509_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 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.
Method Detail

decodeKey

protected PublicKey decodeKey(ASN1InputByteArray parameters,
                              String algorithm,
                              byte[] subjectPublicKey,
                              CryptoSystem cryptoSystem)
                       throws NoSuchAlgorithmException,
                              InvalidKeyException,
                              InvalidKeyEncodingException,
                              ASN1EncodingException,
                              CryptoTokenException,
                              CryptoUnsupportedOperationException,
                              InvalidCryptoSystemException,
                              UnsupportedCryptoSystemException
e Decodes the specified public key.

Implemented by a subclass to finish decoding the key.

Parameters:
parameters - An ASN1 byte array containing the parameters for the encoding.
algorithm - A String representing the algorithm used to encode the data.
subjectPublicKey - The subject public key data.
cryptoSystem - The crypto system associated with the key.
Returns:
The encoded public key.
Throws:
NoSuchAlgorithmException - Thrown if the specified algorithm cannot be found.
InvalidKeyException - Thrown if the specified key is invalid.
InvalidKeyEncodingException - Thrown if the specified key is improperly formatted.
ASN1EncodingException - Thrown if the paramters byte array is improperly formatted.
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.
InvalidCryptoSystemException - Thrown if the specified crypto system is invalid.
UnsupportedCryptoSystemException - Thrown if the specified crypto system is unsupported.
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 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.

decodeKey

protected PublicKey decodeKey(InputStream encodedKey,
                              CryptoSystem cryptoSystem,
                              String keyAlgorithm)
                       throws NoSuchAlgorithmException,
                              InvalidKeyException,
                              InvalidKeyEncodingException,
                              IOException,
                              CryptoTokenException,
                              CryptoUnsupportedOperationException,
                              InvalidCryptoSystemException,
                              UnsupportedCryptoSystemException
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 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.

getEncodingAlgorithm

protected String getEncodingAlgorithm()
Returns the encoding algorithm used, "X509".
Overrides:
getEncodingAlgorithm in class PublicKeyDecoder
Since:
JDE 3.6.0

Following copied from class: PublicKeyDecoder
Returns:
A String representing the name of the encoding algorithm
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 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.

getKeyAlgorithms

protected String[] getKeyAlgorithms()
Returns the key algorithm that was encoded.
Overrides:
getKeyAlgorithms in class PublicKeyDecoder
Since:
JDE 3.6.0

Following copied from class: PublicKeyDecoder
Returns:
An array of Strings that represent the names of the key algorithms.
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 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.



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