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

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

public final class KeyStoreManager
extends Object

Coordinates all administrative tasks associated with each key store.

Ensures that any revoked certificates are propogated throughout all of the keystores and that if the passphrase is changed it will be changed for all of the keystores.

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 Summary
	void	certificateAdded(Certificate certificate) This method is called by the KeyStore when a new certificate is added to the KeyStore collection.
	static KeyStoreManager	getInstance() This method returns an instance of the KeyStoreManager.
	KeyStore	getKeyStore(KeyStoreData data) This method will search through all of the KeyStores currently registered with the KeyStoreManager to see if the KeyStoreData object is a member of that KeyStore.
	void	register(String className, long id, CodeSigningKey key, KeyStore keyStore) Registers a key store.
	void	register(KeyStore keyStore) Registers a key store with the key store manager.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static KeyStoreManager getInstance()

This method returns an instance of the KeyStoreManager.

Returns:

The KeyStoreManager 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 3.6.0

register

public void register(KeyStore keyStore)

Registers a key store with the key store manager.

If you are registering a PersistableRIMKeyStore then use the other register method.

This is useful for when the KeyStore password is changed on the device. The KeyStoreManager will inform each of the registered keystores what the old password was and what the new password is. Registration is currently mandatory for all keystores. If you develop your own keystore please ensure that you register with the KeyStoreManager.

Parameters:

keyStore - The key store to be registered.

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

register

public void register(String className,
                     long id,
                     CodeSigningKey key,
                     KeyStore keyStore)
              throws KeyStoreRegisterException

Registers a key store.

This method is used to register key stores that need to be persistable. That is, keystores that extend or mimic the PersistableRIMKeyStore. This method will test to make sure that your KeyStore is persistable.

Parameters:

className - The class name of the PersistableRIMKeyStoreFactory.

id - A long representing which key store this is. It has to be unique.

key - a CodeSigningKey which can be used to prevent unauthorized access to your keystore.

keyStore - The key store to register.

Throws:

KeyStoreRegisterException - Thrown if the class could not be correctly instantiated.

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

getKeyStore

public KeyStore getKeyStore(KeyStoreData data)

This method will search through all of the KeyStores currently registered with the KeyStoreManager to see if the KeyStoreData object is a member of that KeyStore. If so, then it will return that KeyStore. Otherwise it will return null.

Returns:

the KeyStore that contains the KeyStoreData or null if no KeyStore is found.

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

certificateAdded

public void certificateAdded(Certificate certificate)

This method is called by the KeyStore when a new certificate is added to the KeyStore collection.

Parameters:

certificate - The certificate that was added to the 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