SHOW Signed

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

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

All Implemented Interfaces:

KeyStoreIndex

public class SubjectKeyStoreIndex

extends Object

implements KeyStoreIndex

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

Since:

JDE 3.6.0

Field Summary

static long

ID The long representing this index.

Constructor Summary

SubjectKeyStoreIndex() Creates a SubjectKeyStoreIndex object.

Method Summary

	void	addToIndex(KeyStoreData data, KeyStoreDataMap dataMap) Links the KeyStoreData object passed in with a hash of the subject 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 DistinguishedName containing a subject ) matches the subject 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.

Since:

JDE 3.6.0

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

SubjectKeyStoreIndex

public SubjectKeyStoreIndex()

Creates a SubjectKeyStoreIndex object.

Since:

JDE 3.6.0

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

dataMap - The data map where the link is added.

Since:

JDE 3.7.0

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

Returns:

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

Throws:

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

Since:

JDE 3.7.0

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 DistinguishedName containing a subject ) matches the subject contained within the data object.

Specified by:

matches in interface KeyStoreIndex

Parameters:

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

target - A DistinguishedName containing the subject to compare against the data.

Returns:

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

Since:

JDE 3.7.0

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

Since:

JDE 3.6.0

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.