RIM Device Java Library: Class CombinedKeyStore

This class allows a developer to combine several keystores into what looks like one keystore.

This is useful when you have several keystores that might contain the key you are looking for. You can combine these keystores temporarily and search through them.

Note: It should be noted that some operations do not make sense to operate on a collection of keystores. For example, the set method would add a new key to a keystore. It does not make sense to add the new key automatically to all of the keystores. So, the concept of a preferred keystore exists to enable those kinds of operations to be performed on one of the keystores. Any operation that only operates on a preferred key store is denoted as such. Ensure that you check the javadocs for each function you are calling so you know exactly what operations are being performed.

Field Summary

Fields inherited from interface net.rim.device.api.crypto.keystore.KeyStore

SECURITY_LEVEL_HIGH, SECURITY_LEVEL_LOW, SECURITY_LEVEL_MEDIUM, SECURITY_LEVEL_NOT_APPLICABLE

Constructor Summary
	`CombinedKeyStore(KeyStore[] keyStores)` Initializes the combined keystore with an array of underlying keystores.
	`CombinedKeyStore(KeyStore[] keyStores, int preferredKeyStore)` Initializes the combined keystore with an array of underlying keystores.

Method Summary
	`void`	`addCollectionListener(Object listener)` This method is called when the developer wants to listen in on when records are added and removed to/from a particular keystore.
	`boolean`	`addIndex(KeyStoreIndex index)` Adds an index to all of the information currently in the key store.
	`void`	`addIndices(KeyStoreIndex[] indices)` Adds an array of indices to all of the information currently in the key store.
	`void`	`addKeyStores(KeyStore[] keyStores)` Allows for the addition of more keystores to the combined key store.
	`void`	`changePreferredKeyStore(int newPreferredKeyStore)` Allows you to change the preferred key store.
	`boolean`	`checkTicket(KeyStoreTicket ticket)` Calls the `checkTicket` method on the preferred key store.
	`Enumeration`	`elements()` Returns an enumeration of the KeyStoreData that are stored in the KeyStore.
	`Enumeration`	`elements(boolean backingKeyStore)` Returns an enumeration of the KeyStoreData that are stored in the KeyStore.
	`Enumeration`	`elements(long index)` Returns an enumeration of the elements (KeyStoreData) inside the key store according to the index provided with the parameter.
	`Enumeration`	`elements(long index, boolean backingKeyStore)` Returns an enumeration of the elements (KeyStoreData) inside the key store according to the index provided with the parameter.
	`Enumeration`	`elements(long index, Object associatedData)` Returns an array of keystore information that contains the certificates, keys and other data associated with this alias.
	`Enumeration`	`elements(long index, Object associatedData, boolean backingKeyStore)` Returns an array of keystore information that contains the certificates, keys and other data associated with this alias.
	`boolean`	`exists(long index, Object associatedData)` Returns a boolean denoting whether an object exists with the given alias and the given index class.
	`boolean`	`existsIndex(long index)` Returns a boolean denoting whether this index already exists in the key store.
	`KeyStore`	`getBackingKeyStore()` This method returns the backing keystore for the preferred keystore currently set in the combined keystore.
	`KeyStore`	`getKeyStore(int index)` This method returns the KeyStore associated with the index specified as the only parameter.
	`String`	`getName()` Returns the name of the preferred key store.
	`int`	`getNumKeyStores()` This method returns the number of keystores that are currently contained in the CombinedKeyStore.
	`KeyStoreTicket`	`getTicket()` Calls the `getTicket` method on the preferred key store.
	`KeyStoreTicket`	`getTicket(String prompt)` Calls the `getTicket` method on the preferred key store.
	`boolean`	`isMember(byte[] certificateEncoding)` Returns a boolean dictating whether or not this certificate is contained inside the KeyStore.
	`boolean`	`isMember(Certificate certificate)` Returns a boolean dictating whether or not this certificate is contained inside the KeyStore.
	`boolean`	`isMember(Key key)` Returns a boolean dictating whether or not this key is contained inside the KeyStore.
	`boolean`	`isMember(KeyStoreData data)` Returns a boolean dictating whether or not this `KeyStoreData` is contained inside the KeyStore.
	`void`	`removeCollectionListener(Object listener)` This method is called when the developer wants to remove the listener from this keystore.
	`void`	`removeIndex(long index)` Removes an index from all of the keystores in the combined keystore.
	`void`	`removeKey(KeyStoreData data, KeyStoreTicket ticket)` Remove the key from the preferred keystore.
	`void`	`removeKeyStore(int index)` Allows you to remove a keystore from the combined keystore.
	`KeyStoreData`	`set(AssociatedData[] associatedData, String label, Certificate certificate, CertificateStatus certStatus, KeyStoreTicket ticket)` Sets a new key into the preferred keystore.
	`KeyStoreData`	`set(AssociatedData[] associatedData, String label, PrivateKey privateKey, String privateKeyEncodingAlgorithm, int securityLevel, Certificate certificate, CertificateStatus certStatus, KeyStoreTicket ticket)` Sets a new key into the preferred keystore.
	`KeyStoreData`	`set(AssociatedData[] associatedData, String label, PrivateKey privateKey, String privateKeyEncodingAlgorithm, int securityLevel, KeyStoreTicket ticket)` Sets a new key into the preferred keystore.
	`KeyStoreData`	`set(AssociatedData[] associatedData, String label, PrivateKey privateKey, String privateKeyEncodingAlgorithm, int securityLevel, PublicKey publicKey, long keyUsage, KeyStoreTicket ticket)` Sets a new key into the preferred keystore.
	`KeyStoreData`	`set(AssociatedData[] associatedData, String label, PublicKey publicKey, long keyUsage, KeyStoreTicket ticket)` Sets a new key into the preferred keystore.
	`KeyStoreData`	`set(AssociatedData[] associatedData, String label, SymmetricKey symmetricKey, String symmetricKeyEncodingAlgorithm, int securityLevel, KeyStoreTicket ticket)` Sets a new key into the preferred keystore.
	`int`	`size()` Returns the number of elements inside the key store.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

CombinedKeyStore

public CombinedKeyStore(KeyStore[] keyStores)

Initializes the combined keystore with an array of underlying keystores.

You can also add to this array later on if desired. It should be noted that by default the preferred keystore will be the first keystore given in the array unless otherwise specified.

Parameters:: keyStores - The array of keystores that you want as part of the combined keystore.
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.

CombinedKeyStore

public CombinedKeyStore(KeyStore[] keyStores,
                        int preferredKeyStore)

Initializes the combined keystore with an array of underlying keystores.

You can also add to this array later on if desired.

Parameters:: keyStores - The array of keystores that you want as part of the combined keystore.; preferredKeyStore - An integer representing the index within the array of keystores that will be considered the preferred keystore. The preferred keystore will be the keystore that new keys are added to and other operations that are not obviously made for multiple key stores. (i.e. anything that causes a change in the state of a keystore). Remember that arrays are indexed at zero. Hence, if you want the very first keystore to be the preferred keystore it would have an index of 0.
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.