SHOW Signed
 

net.rim.device.api.crypto.certificate.x509
Class X509PublicKeyHashKeyStoreIndex

java.lang.Object
  |
  +--net.rim.device.api.crypto.certificate.x509.X509PublicKeyHashKeyStoreIndex
All Implemented Interfaces:
KeyStoreIndex

public class X509PublicKeyHashKeyStoreIndex
extends Object
implements KeyStoreIndex

Provides indexing functionality for Key Stores based upon the hash of the encoded public key bytes of an X.509 certificate (as found in the public key field of the raw certificate, without DER tags). The hash algorithm can be specified.

Note that this index only applies to X.509 certificates.

For more information on using a keystore index, see Using the keystore index. This quick tutorial provides overview information as well as an example on how to use an index within a keystore.

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

Field Summary
 Category: Signed static long ID
          The ID representing this index in the key store.
 
Constructor Summary
 Category: Signed X509PublicKeyHashKeyStoreIndex()
          Creates a public key hash index for the key store based on a SHA1 Digest.
 Category: Signed X509PublicKeyHashKeyStoreIndex(Digest digest)
          Creates a public key hash index for the key store based on the specified digest algorithm.
 
Method Summary
 Category: Signed  void addToIndex(KeyStoreData data, KeyStoreDataMap dataMap)
          Links the KeyStoreData object passed in with a hash of the public key from an X509 certificate.
 Category: Signed  int getHash(Object target)
          Returns a hash representing the target object passed in.
 Category: Signed  long getID()
          Returns a unique ID that represents this index within the key store.
 Category: Signed  boolean matches(KeyStoreData data, Object target)
          Determines if the target object ( a byte array containing a public key ) matches the public key contained within the data object.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ID

public static final long ID
The ID representing this index in the key store.
Since:
JDE 3.6.0
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.
Constructor Detail

X509PublicKeyHashKeyStoreIndex

public X509PublicKeyHashKeyStoreIndex()
Creates a public key hash index for the key store based on a SHA1 Digest.

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

X509PublicKeyHashKeyStoreIndex

public X509PublicKeyHashKeyStoreIndex(Digest digest)
Creates a public key hash index for the key store based on the specified digest algorithm.

Parameters:
digest - The specified digest algorithm to use for hashing.
Since:
JDE 3.6.0
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.
Method Detail

addToIndex

public void addToIndex(KeyStoreData data,
                       KeyStoreDataMap dataMap)
Links the KeyStoreData object passed in with a hash of the public key from an X509 certificate. The dataMap is used by the key store to find the appropriate records when doing searches based on this index.

Parameters:
data - The KeyStoreData object containing the certificate.
dataMap - The data map where the link is added.
Since:
JDE 3.6.0
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.

getHash

public int getHash(Object target)
Returns a hash representing the target object passed in.

Parameters:
target - The object to generate the hash on. Must be a byte array.
Returns:
An integer representing the hash of the target object passed into this method.
Throws:
IllegalArgumentException - if the specified target parameter is not a byte array.
Since:
JDE 3.6.0
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.

getID

public long getID()
Returns a unique ID that represents this index within the key store.
Since:
JDE 3.6.0

Following copied from interface: KeyStoreIndex
Returns:
A long that is associated with the index.
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.

matches

public boolean matches(KeyStoreData data,
                       Object target)
Determines if the target object ( a byte array containing a public key ) matches the public key contained within the data object.

Parameters:
data - The key store data to compare against the target.
target - A byte array containing a public key hash to compare against the data.
Returns:
true if the key store data object contains the same public key hash as the target and false otherwise.
Since:
JDE 3.6.0
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.



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.