net.rim.device.api.crypto.certificate
Class CertificateKeyStoreIndex

java.lang.Object
  net.rim.device.api.crypto.certificate.CertificateKeyStoreIndex

All Implemented Interfaces:

KeyStoreIndex

public class CertificateKeyStoreIndex
extends Object
implements KeyStoreIndex

Implements an index to allow you to look up a key store data object by the certificate in the data blob.

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 4.0.0

Field Summary
	static long	ID The long representing this index.

Constructor Summary
	CertificateKeyStoreIndex() Creates an CertificateKeyStoreIndex object.

Method Summary
	void	addToIndex(KeyStoreData data, KeyStoreDataMap dataMap) Links the KeyStoreData object passed in with a hash of the certificate from the data object passed in.
	int	getHash(Object target) Returns a hash representing the target object passed in.
	long	getID() Returns a unique ID that represents this index within the key store.
	boolean	matches(KeyStoreData data, Object target) Determines if the target object (a Certificate) matches the certificate 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 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 4.0.0

Constructor Detail

CertificateKeyStoreIndex

public CertificateKeyStoreIndex()

Creates an CertificateKeyStoreIndex object.

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 4.0.0

Method Detail

addToIndex

public void addToIndex(KeyStoreData data,
                       KeyStoreDataMap dataMap)

Links the KeyStoreData object passed in with a hash of the certificate from the data object passed in. The dataMap is used by the key store to find the appropriate records when doing searches based on this index.

Specified by:

addToIndex in interface KeyStoreIndex

Parameters:

data - The KeyStoreData object containing the certificate.

dataMap - The data map where the link is added.

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 4.0.0

getHash

public int getHash(Object target)

Returns a hash representing the target object passed in.

Specified by:

getHash in interface KeyStoreIndex

Parameters:

target - The object to generate the hash on. Must be a Certificate.

Returns:

An integer representing the hash of the target object passed into this method.

Throws:

IllegalArgumentException - if the specified target parameter is not a Certificate.

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 4.0.0

matches

public boolean matches(KeyStoreData data,
                       Object target)

Determines if the target object (a Certificate) matches the certificate contained within the data object.

Specified by:

matches in interface KeyStoreIndex

Parameters:

data - The key store data to compare against the target.

target - A Certificate to compare against the data.

Returns:

true if the key store data object contains the same certificate as the target and 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 4.0.0

getID

public long getID()

Returns a unique ID that represents this index within the key store.

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 4.0.0