net.rim.device.api.crypto.keystore
Interface KeyStoreIndex
- All Known Implementing Classes:
- CertificateHashKeyStoreIndex, CertificateKeyStoreIndex, IssuerKeyStoreIndex, SerialNumberIssuerKeyStoreIndex, SubjectKeyStoreIndex, SubjectKeyIdentifierKeyStoreIndex, X509PublicKeyHashKeyStoreIndex, AssociatedDataKeyStoreIndex, LabelKeyStoreIndex, PrivateKeysKeyStoreIndex, PublicKeyKeyStoreIndex
public interface KeyStoreIndex
Specifies the information that the key store
will be indexed on.
NOTE: It is the responsibility of the developer
to create and implement this interface for each index
they want in the key store.
It is worthwhile to note that there are already several
indices implemented in the KeyStore and other applications
at RIM that may be available for you to call before you
attempt to implement your own index.
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.
- See Also:
KeyStore,
KeyStoreData- 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 Summary |
|
void |
addToIndex(KeyStoreData data,
KeyStoreDataMap map)
This method is called by the index to add the alias values or integers
that are going to be used to link to the key store data object that was
passed into this method. |
|
int |
getHash(Object target)
Returns the int representing the target object passed
into the KeyStoreDataComparator. |
|
long |
getID()
Returns the long associated with this index
class for use inside the keystore. |
|
boolean |
matches(KeyStoreData data,
Object target)
This method will return true if the target is the KeyStoreData object
that is found using the index. |
addToIndex
void addToIndex(KeyStoreData data,
KeyStoreDataMap map)
- This method is called by the index to add the alias values or integers
that are going to be used to link to the key store data object that was
passed into this method.
- Parameters:
data - The KeyStoreData object where one is going to construct the
hashes from.map - The object that is going to be used to add the hashes to the key store.- 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
getHash
int getHash(Object target)
throws IllegalArgumentException
- Returns the int representing the target object passed
into the
KeyStoreDataComparator.
- Parameters:
target - The object to return the representing int from.
- Returns:
- An integer representing the target object passed into
this method.
- Throws:
IllegalArgumentException - Thrown if the specified target parameter 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
matches
boolean matches(KeyStoreData data,
Object target)
- This method will return true if the target is the
KeyStoreData object
that is found using the index.
- Parameters:
data - The key store data to be found.target - The information that used to find the key store data.
- Returns:
- true if the key store data object equals the target, false otherwise.
- 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
getID
long getID()
- Returns the long associated with this index
class for use inside the keystore.
Note that this long has to be unique.
- 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.
- 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