net.rim.device.api.crypto.keystore
Class PrivateKeysKeyStoreIndex

java.lang.Object
  net.rim.device.api.crypto.keystore.PrivateKeysKeyStoreIndex

All Implemented Interfaces:

KeyStoreIndex

public class PrivateKeysKeyStoreIndex
extends Object
implements KeyStoreIndex

Implements an index to allow you to look up a key store data object based on whether a private key or symmetric key is specified in the key store data.

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:

BlackBerry API 3.6.0

Field Summary
	static long	ID The long representing this index.

Constructor Summary
	PrivateKeysKeyStoreIndex() Creates an issuer key store data comparator.

Method Summary
	void	addToIndex(KeyStoreData data, Certificate certificate, KeyStoreDataMap dataMap)
	void	addToIndex(KeyStoreData data, KeyStoreDataMap dataMap) 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.

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 long representing this index.

See Also:

Constant Field Values

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 Detail

PrivateKeysKeyStoreIndex

public PrivateKeysKeyStoreIndex()

Creates an issuer key store data comparator.

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

addToIndex

public void addToIndex(KeyStoreData data,
                       Certificate certificate,
                       KeyStoreDataMap dataMap)

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

addToIndex

public void addToIndex(KeyStoreData data,
                       KeyStoreDataMap dataMap)

Description copied from interface: KeyStoreIndex

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.

Specified by:

addToIndex in interface KeyStoreIndex

Parameters:

data - The KeyStoreData object where one is going to construct the hashes from.

dataMap - 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

public int getHash(Object target)

Description copied from interface: KeyStoreIndex

Returns the int representing the target object passed into the KeyStoreDataComparator.

Specified by:

getHash in interface KeyStoreIndex

Parameters:

target - The object to return the representing int from.

Returns:

An integer representing the target object passed into this method.

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

public long getID()

Description copied from interface: KeyStoreIndex

Returns the long associated with this index class for use inside the keystore.

Note that this long has to be unique.

Specified by:

getID in 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.

Since:

BlackBerry API 3.6.0

matches

public boolean matches(KeyStoreData data,
                       Object target)

Description copied from interface: KeyStoreIndex

This method will return true if the target is the KeyStoreData object that is found using the index.

Specified by:

matches in interface KeyStoreIndex

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