|
|||||||||
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 | |
---|---|
PasswordPolicyInfo |
create(PasswordPolicyInfo passwordPolicyInfo) Create a new Password Policy |
void |
delete(java.lang.String plPasswordPolicyName) Delete the Password Policy |
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(java.lang.String userID, java.lang.String appInstance) Returns the description of the password policy applicable to the specific account |
PasswordPolicyDescription |
getApplicablePasswordPolicyDescription(java.lang.String userID, java.lang.String appInstance, java.util.Locale locale) Returns the description of the password policy applicable to the specific account |
PasswordPolicyDescription |
getApplicablePasswordPolicyDescription(User user) Returns the description of the password policy applicable to the user |
PasswordPolicyInfo |
getDetails(java.lang.String passwordPolicyName) Get the details of specified Password Policy by Name |
PasswordPolicyDescription |
getSystemDefaultPolicyDescription(java.util.Locale locale) Gets the system default policy description |
void |
resetPassword(java.lang.String userID) Deprecated. This method is not longer supported. The preferred way to do this is via UserManager.resetPassword(String,boolean) |
void |
resetPassword(java.lang.String userID, java.util.Map controls) Deprecated. This method is not longer supported. The preferred way to do this is via UserManager.resetPassword(String,boolean,Map) |
java.util.List |
search(SearchCriteria criteria) Search for the list of policies having a specified search criteria |
void |
update(PasswordPolicyInfo passwordPolicyInfo) Update the attributes of the Password Policy specified. |
ValidationResult |
validatePasswordAgainstDefaultPolicy(char[] password, User user, java.util.Locale locale) Validates the password of a new user against the default policy Used in following scenarios Self Registration Creation of user by Delegated Admin |
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, java.lang.String userID, java.util.Locale locale, boolean isUserLogin) Validates the given password against the applicable Password Policy Used in the 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 default policy, if user.getEntityId() is null Validates the password of a existing user against the applicable policy, if user.getEntityId() is not null |
ValidationResult |
validatePasswordAgainstPolicy(char[] password, User user, java.lang.String appInstance, java.util.Locale locale) Validates the password of a new account against the applicable policy |
Method Detail |
---|
@Deprecated
void resetPassword(java.lang.String userID)
UserManager.resetPassword(String,boolean)
userID
- the userID of the user whose password is to be reset.UserManager.resetPassword(String,boolean)
@Deprecated
void resetPassword(java.lang.String userID,
java.util.Map controls)
UserManager.resetPassword(String,boolean,Map)
userID
- the userID of the user whose password is to be reset.controls
- This Map contains control parameters used for performing additional opreration along with reset password.UserManager.resetPassword(String,boolean,Map)
ValidationResult validatePasswordAgainstPolicy(char[] password, java.lang.String userID, java.util.Locale locale)
password
- the password to be validated, should not be nulluserID
- the User Login 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, java.lang.String userID, java.util.Locale locale, boolean isUserLogin)
password
- the password to be validated, should not be nulluserID
- The id of the user whose password is to be changed. The isUserLogin flag will decide where userID contains the user login or the entity ID.locale
- the locale in which validation errors will be translated in case of password validation failureisUserLogin
- Set to true if the userID contains user login and false if the userID contains entity ID.ValidationResult
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 validateduser
- the user's attributes information. Password validation typically requires firstName, lastName and user login. User ID to be set for existing users.locale
- 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 passedValidationResult validatePasswordAgainstDefaultPolicy(char[] password, User user, java.util.Locale locale)
password
- the password to be validateduser
- the user's attributes information. Password validation typically requires firstName, lastName and user loginlocale
- 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 user login of the existing userPasswordPolicyDescription getApplicablePasswordPolicyDescription(java.lang.String userID, java.util.Locale locale)
userID
- the user login of the userlocale
- the locale in which password policy description is required.PasswordPolicyDescription getSystemDefaultPolicyDescription(java.util.Locale locale)
locale
- localePasswordPolicyInfo create(PasswordPolicyInfo passwordPolicyInfo)
passwordPolicyInfo
- This VO contains the details of the Password Policy to be createdPasswordPolicyInfo getDetails(java.lang.String passwordPolicyName)
passwordPolicyName
- The unique Name of the required password policyvoid update(PasswordPolicyInfo passwordPolicyInfo)
passwordPolicyInfo
- This VO contains the details to be updated for the Password Policyvoid delete(java.lang.String plPasswordPolicyName)
plPasswordPolicyName
- The unique Name of the password policy to be deletedjava.lang.Exception
java.util.List search(SearchCriteria criteria)
criteria
- This VO contains the search criteriaPasswordPolicyDescription getApplicablePasswordPolicyDescription(java.lang.String userID, java.lang.String appInstance) throws NoSuchPasswordPolicyException
userID
- the userID of the userappInstance
- name the application instance name to be provisionedNoSuchPasswordPolicyException
PasswordPolicyDescription getApplicablePasswordPolicyDescription(java.lang.String userID, java.lang.String appInstance, java.util.Locale locale) throws NoSuchPasswordPolicyException
userID
- the userID of the userappInstance
- name the application instance name to be provisionedlocale
- the locale in which password policy description is required.NoSuchPasswordPolicyException
ValidationResult validatePasswordAgainstPolicy(char[] password, User user, java.lang.String appInstance, java.util.Locale locale)
password
- the password to be validateduserInfo
- the user's attributes information. Password validationappInstance
- name the application instance name to be provisionedlocale
- 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 passed
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |