net.rim.device.api.crypto
Class DHKeyPair

java.lang.Object
  extended by net.rim.device.api.crypto.KeyPair
      extended by net.rim.device.api.crypto.DHKeyPair
All Implemented Interfaces:
Persistable

public final class DHKeyPair
extends KeyPair
implements Persistable

Holds a Diffie-Hellman public and private key.

Diffie-Hellman ( DH ) is defined in PKCS #3 and various other spots.

See Also:
DHPublicKey, DHPrivateKey, DHCryptoSystem
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 DHKeyPair(DHCryptoSystem cryptoSystem)
          Creates a new DHKeyPair object with the given crypto system.
Category: Signed DHKeyPair(DHPublicKey publicKey, DHPrivateKey privateKey)
          Creates a new DHKeyPair object with the given public and private keys.
 
Method Summary
Category: Signed  boolean equals(Object obj)
          Indicates whether some other object is "equal to" this one.
Category: Signed  DHCryptoSystem getDHCryptoSystem()
          Returns the DH crypto system associated with the keys.
Category: Signed  DHPrivateKey getDHPrivateKey()
          Returns the DH private key associated with this key pair.
Category: Signed  DHPublicKey getDHPublicKey()
          Returns the DH public key associated with this key pair.
Category: Signed  int hashCode()
          Returns a hash code value for the object.
Category: Signed  void verify()
          Checks the integrity of the associated PublicKey and PrivateKey, and then performs an integrity check on the private and public key parameters.
 
Methods inherited from class net.rim.device.api.crypto.KeyPair
getCryptoSystem, getPrivateKey, getPublicKey, isVerified, setKeyPair, verified
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
 



Constructor Detail

DHKeyPair

public DHKeyPair(DHCryptoSystem cryptoSystem)
          throws CryptoTokenException,
                 CryptoUnsupportedOperationException
Creates a new DHKeyPair object with the given crypto system.

Parameters:
cryptoSystem - The crypto system associated with the key pair.
Throws:
CryptoTokenException - Thrown if an error occurs with the crypto token or the specified 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

DHKeyPair

public DHKeyPair(DHPublicKey publicKey,
                 DHPrivateKey privateKey)
          throws InvalidKeyPairException
Creates a new DHKeyPair object with the given public and private keys.

Parameters:
publicKey - The DH public key to use.
privateKey - The DH private key to use.
Throws:
InvalidKeyPairException - Thrown if the specified key pair is invalid.
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

getDHPublicKey

public DHPublicKey getDHPublicKey()
Returns the DH public key associated with this key pair.

Returns:
The DH public 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

getDHPrivateKey

public DHPrivateKey getDHPrivateKey()
Returns the DH private key associated with this key pair.

Returns:
The DH private 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

getDHCryptoSystem

public DHCryptoSystem getDHCryptoSystem()
Returns the DH crypto system associated with the keys.

Returns:
The DH crypto system.
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,
                   InvalidKeyPairException,
                   CryptoTokenException,
                   CryptoUnsupportedOperationException
Checks the integrity of the associated PublicKey and PrivateKey, and then performs an integrity check on the private and public key parameters. The PublicKey and PrivateKey are checked via their verify() methods, and then the following is verified:

Specified by:
verify in class KeyPair
Throws:
InvalidKeyException - Thrown if the public or private key parameters are invalid.
InvalidCryptoSystemException - Thrown if the crypto system parameters are invalid.
InvalidKeyPairException - Thrown when the keys are not related.
CryptoTokenException - Thrown if an error occurs with the crypto token or the specified 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

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 KeyPair
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 KeyPair
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-2010 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. All Rights Reserved.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark of Sun Microsystems, Inc.