SHOW Signed

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

java.lang.Object
  |
  +--net.rim.device.api.crypto.certificate.x509.SubjectKeyIdentifierKeyStoreIndex

All Implemented Interfaces:

KeyStoreIndex

public class SubjectKeyIdentifierKeyStoreIndex

extends Object

implements KeyStoreIndex

Implements an index to allow you to look up a key store data object by the subject key identifier of 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 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.

Field Summary

static long

ID The id of this index in the key store.

Constructor Summary

SubjectKeyIdentifierKeyStoreIndex() Creates a SubjectKeyIdentifierKeystoreIndex object.

Method Summary

	void	addToIndex(KeyStoreData data, KeyStoreDataMap dataMap) Links the KeyStoreData object passed in with a hash of the subject key identifier from an X509 certificate.
	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 byte array containing a subject key ID ) matches the subject key ID 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 of this index in the key store.

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.

Constructor Detail

SubjectKeyIdentifierKeyStoreIndex

public SubjectKeyIdentifierKeyStoreIndex()

Creates a SubjectKeyIdentifierKeystoreIndex object.

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

addToIndex

public void addToIndex(KeyStoreData data,
                       KeyStoreDataMap dataMap)

Links the KeyStoreData object passed in with a hash of the subject key identifier from an X509 certificate. 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.

Since:

JDE 3.6

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.

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

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.

matches

public boolean matches(KeyStoreData data,
                       Object target)

Determines if the target object ( a byte array containing a subject key ID ) matches the subject key ID contained within the data object.

Specified by:

matches in interface KeyStoreIndex

Parameters:

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

target - A byte array containing a subject key ID to compare against the data.

Returns:

true if the key store data object contains the same subject key ID as the target and false otherwise

Since:

JDE 3.6

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.

getID

public long getID()

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

Specified by:

getID in interface KeyStoreIndex

Following copied from interface: net.rim.device.api.crypto.keystore.KeyStoreIndex

Returns:

A long that is associated with the index.

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.