|
Eclipse Platform Release 3.4 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.equinox.security.storage.provider.PasswordProvider
Password provider modules should extend this class. Secure storage will ask modules for passwords used to encrypt entries stored in the secure preferences.
Password provider modules can be thought of as trusted 3rd parties used to provide passwords to open keyrings containing secure preferences. They can do it, for instance, by asking the user to enter password, or integrating with operating system login, or exchanging information with a device such as a smart card reader.
Use org.eclipse.equinox.security.secureStorage extension point to contribute password provider module to the secure storage system.
Field Summary | |
static int |
CREATE_NEW_PASSWORD
Bit mask for the password type field of the getPassword(IPreferencesContainer, int)
method. |
static int |
PASSWORD_CHANGE
Bit mask for the password type field of the getPassword(IPreferencesContainer, int)
method. |
Constructor Summary | |
PasswordProvider()
Constructor. |
Method Summary | |
abstract PBEKeySpec |
getPassword(IPreferencesContainer container,
int passwordType)
This method should return the password used to encrypt entries in the secure preferences. |
boolean |
retryOnError(Exception e,
IPreferencesContainer container)
The framework might call this method if it suspects that the password is invalid (for instance, due to a failed data decryption). |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final int CREATE_NEW_PASSWORD
getPassword(IPreferencesContainer, int)
method. If value at this bit set to 1
, it indicates that a new
password should be created; otherwise this is a request for the password previously
used for this secure storage.
public static final int PASSWORD_CHANGE
getPassword(IPreferencesContainer, int)
method. If value at this bit set to 1
, it indicates that a new password
is requested as a part of the password change operation.
Constructor Detail |
public PasswordProvider()
Method Detail |
public abstract PBEKeySpec getPassword(IPreferencesContainer container, int passwordType)
container
- container of the secure preferencespasswordType
- the collection of bits that describes password type requested. See
CREATE_NEW_PASSWORD
and PASSWORD_CHANGE
. When evaluating value of this
field use bit-wise filters as additional bits might be used in future versions
null
if unable to obtain passwordpublic boolean retryOnError(Exception e, IPreferencesContainer container)
e
- exception that occurred in the secure preferences processingcontainer
- container of the secure preferences
true
if a different password might be provided; false
otherwise. If in doubt, return false
|
Eclipse Platform Release 3.4 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.