net.rim.device.api.crypto
Class KEAPublicKey

java.lang.Object
  extended by net.rim.device.api.crypto.KEAPublicKey
All Implemented Interfaces:
KEAKey, Key, PublicKey, Persistable

public final class KEAPublicKey
extends Object
implements KEAKey, PublicKey, Persistable

Represents a public key in a Key Exchange Algorithm (KEA) system.

A description of the KEA algorithm can be found at KEA.

See Also:
KEACryptoSystem, KEAPrivateKey
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
Category: Signed KEAPublicKey(KEACryptoSystem cryptoSystem, byte[] data)
          Constructs a KEAPublicKey object under the given crypto system using the given data as the public key's mathematical representation.
Category: Signed KEAPublicKey(KEACryptoSystem cryptoSystem, CryptoTokenPublicKeyData cryptoTokenData)
          Constructs a KEAPublicKey object under the given crypto system associated with the specified crypto token data.
 
Method Summary
Category: Signed  boolean equals(Object obj)
          Indicates whether some other object is "equal to" this one.
Category: Signed  String getAlgorithm()
          Returns a string containing the name of the algorithm associated with this key ("KEA").
Category: Signed  CryptoSystem getCryptoSystem()
          Returns the crypto system associated with the key.
Category: Signed  CryptoTokenPublicKeyData getCryptoTokenData()
          Returns the crypto token data associated with the key.
Category: Signed  KEACryptoSystem getKEACryptoSystem()
          Returns the KEA crypto system associated with the key.
Category: Signed  KEACryptoToken getKEACryptoToken()
          Returns the KEA crypto token associated with the key.
Category: Signed  byte[] getPublicKeyData()
          Returns a copy of the public key data.
Category: Signed  int hashCode()
          Returns a hash code value for the object.
Category: Signed  void verify()
          Checks the integrity of the associated CryptoSystem, and then performs integrity checks on the public key parameters.
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
 



Constructor Detail

KEAPublicKey

public KEAPublicKey(KEACryptoSystem cryptoSystem,
                    byte[] data)
             throws InvalidKeyException,
                    CryptoTokenException,
                    CryptoUnsupportedOperationException
Constructs a KEAPublicKey object under the given crypto system using the given data as the public key's mathematical representation.

Parameters:
cryptoSystem - A KEACryptoSystem that contains parameters for KEA computations.
data - The keying material that is to be used for the public key operations.
Throws:
InvalidKeyException - Thrown if the key data is invalid.
CryptoTokenException - Thrown if an error occurs with the crypto token of the crypto token is invalid.
CryptoUnsupportedOperationException - Thrown if a call is made to an unsupported operation.
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

KEAPublicKey

public KEAPublicKey(KEACryptoSystem cryptoSystem,
                    CryptoTokenPublicKeyData cryptoTokenData)
Constructs a KEAPublicKey object under the given crypto system associated with the specified crypto token data.

Parameters:
cryptoSystem - A KEACryptoSystem that contains parameters for the KEA computations.
cryptoTokenData - The public key data associated with the crypto token.
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.1.0


Method Detail

getAlgorithm

public String getAlgorithm()
Returns a string containing the name of the algorithm associated with this key ("KEA").

This method will always return the String "KEA".

Specified by:
getAlgorithm in interface Key
Returns:
A String representing the name of the 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

getKEACryptoSystem

public KEACryptoSystem getKEACryptoSystem()
Returns the KEA crypto system associated with the key.

Specified by:
getKEACryptoSystem in interface KEAKey
Returns:
The KEACryptoSystem object associated with the key.
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

getCryptoSystem

public CryptoSystem getCryptoSystem()
Returns the crypto system associated with the key.

Specified by:
getCryptoSystem in interface PublicKey
Returns:
The CryptoSystem object associated with the key.
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

verify

public void verify()
            throws InvalidKeyException,
                   InvalidCryptoSystemException,
                   CryptoTokenException,
                   CryptoUnsupportedOperationException
Checks the integrity of the associated CryptoSystem, and then performs integrity checks on the public key parameters. The CryptoSystem is checked via its verify() method, and then the following are verified:

Specified by:
verify in interface PublicKey
Throws:
InvalidKeyException - Thrown if the public key parameters are invalid.
InvalidCryptoSystemException - Thrown if the crypto system parameters are invalid.
CryptoTokenException - Thrown when an error occurs with the crypto token.
CryptoUnsupportedOperationException - Thrown when a call is made to an unsupported operation.
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

getPublicKeyData

public byte[] getPublicKeyData()
                        throws CryptoTokenException,
                               CryptoUnsupportedOperationException
Returns a copy of the public key data.

Returns:
A byte array containing the public key data.
Throws:
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.
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

getKEACryptoToken

public KEACryptoToken getKEACryptoToken()
Returns the KEA crypto token associated with the key.

Returns:
The KEACryptoToken object associated with the key.
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

getCryptoTokenData

public CryptoTokenPublicKeyData getCryptoTokenData()
Returns the crypto token data associated with the key.

Returns:
The CryptoTokenPublicKeyData object associated with the key.
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

hashCode

public int hashCode()
Description copied from class: Object
Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable.

The general contract of hashCode is:

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the JavaTM programming language.)

Overrides:
hashCode in class Object
Returns:
a hash code value for this object.
See Also:
Object.equals(java.lang.Object), Hashtable
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

equals

public boolean equals(Object obj)
Description copied from class: Object
Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation:

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any reference values x and y, this method returns true if and only if x and y refer to the same object (x==y has the value true).

Overrides:
equals in class Object
Parameters:
obj - the reference object with which to compare.
Returns:
true if this object is the same as the obj argument; false otherwise.
See Also:
Boolean.hashCode(), Hashtable
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





Copyright 1999-2011 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Java is a trademark of Oracle America Inc. in the US and other countries.
Legal