SHOW Signed

net.rim.device.api.crypto
Class KeyPair

java.lang.Object
  |
  +--net.rim.device.api.crypto.KeyPair

All Implemented Interfaces:

Persistable, net.rim.vm.Persistable

Direct Known Subclasses:

DHKeyPair, DSAKeyPair, ECKeyPair, KEAKeyPair, RSAKeyPair

public abstract class KeyPair

extends Object

implements Persistable

The KeyPair class generically defines all key pairs (such as ECKeyPair, DSAKeyPair, etc.) that are used in the Crypto API.

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.

Since:

JDE 3.6.0

Constructor Summary

KeyPair(PublicKey publicKey, PrivateKey privateKey) Creates a new KeyPair object.

Method Summary

	boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
	CryptoSystem	getCryptoSystem() Returns the crypto system associated with the keys.
	PrivateKey	getPrivateKey() Returns the private key associated with this key pair.
	PublicKey	getPublicKey() Returns the public key associated with this key pair.
	int	hashCode() Returns a hash code value for the object.
	abstract void	verify() Performs certain integrity checks on the key pair parameters.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KeyPair

public KeyPair(PublicKey publicKey,
               PrivateKey privateKey)
        throws InvalidKeyPairException

Creates a new KeyPair object.

Parameters:

publicKey - The publicKey object that represents the public key in the key pair.

privateKey - The privatekey object that represents the private key in the key pair.

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.

Method Detail

getPublicKey

public PublicKey getPublicKey()

Returns the public key associated with this key pair.

Returns:

The PublicKey associated with the key pair.

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.

getPrivateKey

public PrivateKey getPrivateKey()

Returns the private key associated with this key pair.

Returns:

The PrivateKey associated with the key pair.

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.

getCryptoSystem

public CryptoSystem getCryptoSystem()

Returns the crypto system associated with the keys.

Returns:

The CryptoSystem used to create the key pair.

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.

verify

public abstract void verify()
                     throws InvalidKeyException,
                            InvalidCryptoSystemException,
                            InvalidKeyPairException,
                            CryptoTokenException,
                            CryptoUnsupportedOperationException

Performs certain integrity checks on the key pair parameters.

These checks are useful to prevent certain types of attacks that involve modifying the parameters and then using a signed message to calculate the private key parameters.

Throws:

InvalidKeyException - Thrown when one or both of the keys are of an invalid format.

InvalidCryptoSystemException - Thrown if the specified crypto system is invalid.

InvalidKeyPairException - Thrown when the keys are not related.

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.

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.

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:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the Object.equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hashtables.

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 Java^TM programming language.)

Overrides:

hashCode in class Object

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.

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:

• It is reflexive: for any reference value x, x.equals(x) should return true.
• It is symmetric: for any reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the object is modified.
• For any non-null reference value x, x.equals(null) should return false.

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

Since:

JDE 4.0.2

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.