|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PasswordMgmtService
Provides common password management functionalities like
Method Summary | |
---|---|
PasswordPolicyDescription |
getApplicablePasswordPolicyDescription(java.lang.String userID) Returns the description of the password policy applicable to the user |
PasswordPolicyDescription |
getApplicablePasswordPolicyDescription(java.lang.String userID, java.util.Locale locale) Returns the description of the password policy applicable to the user. |
PasswordPolicyDescription |
getApplicablePasswordPolicyDescription(User user) Returns the description of the password policy applicable to the user in case of create user |
void |
resetPassword(java.lang.String userID) Resets the password of an user to a randomly generated password. |
ValidationResult |
validatePasswordAgainstPolicy(char[] password, java.lang.String userID, java.util.Locale locale) Validates the given password against the applicable Password Policy Used in following scenarios Validating the password entered by the user while changing his/her password Validating the password entered by a delegated admin while changing the password of the user |
ValidationResult |
validatePasswordAgainstPolicy(char[] password, User user, java.util.Locale locale) Validates the password of a new user against the applicable policy Used in following scenarios Self Registration Creation of user by Delegated Admin |
Method Detail |
---|
void resetPassword(java.lang.String userID)
userID
- the userID of the user whose password is to be reset.ValidationResult validatePasswordAgainstPolicy(char[] password, java.lang.String userID, java.util.Locale locale)
password
- the password to be validated, should not be nulluserID
- the userID of the user, should not be nulllocale
- the locale in which validation errors will be translated in case of password validation failureValidationResult
containing the result of the validationjava.lang.NullPointerException
- if null userID or password is passed This object contains the validation status (success/failure) and the validation errors, if anyValidationResult validatePasswordAgainstPolicy(char[] password, User user, java.util.Locale locale)
password
- the password to be validateduserInfo
- the user's attributes information. Password validation typically requires firstName, lastName and userIDlocale
- the locale in which validation errors will be translated in case of password validation failureValidationResult
object containing the result of the validation.java.lang.NullPointerException
- if null password is passedPasswordPolicyDescription getApplicablePasswordPolicyDescription(User user)
userInfo,
- UserInfo objectPasswordPolicyDescription getApplicablePasswordPolicyDescription(java.lang.String userID)
userID
- the userID of the existing userPasswordPolicyDescription getApplicablePasswordPolicyDescription(java.lang.String userID, java.util.Locale locale)
userID
- the userID of the userlocale
- the locale in which password policy description is required.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |