Skip navigation links

Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

oracle.iam.passwordmgmt.api
Interface PasswordMgmtService

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 in case of create 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 oracle.iam.identity.usermgmt.impl.UserManagerImpl#resetPassword(String,boolean)
 void resetPassword(java.lang.String userID, java.util.Map controls)
          Resets the password of an user to a randomly generated password.
 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 applicable policy
Used in following scenarios Self Registration Creation of user by Delegated Admin
 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

resetPassword

@Deprecated
void resetPassword(java.lang.String userID)
Deprecated. This method is not longer supported. The preferred way to do this is via oracle.iam.identity.usermgmt.impl.UserManagerImpl#resetPassword(String,boolean)
Resets the password of an user to a randomly generated password. As part of the password reset, a notification is sent to the user regarding the new password
NOTE: The email attribute of the user must be set for reset password to work
Parameters:
userID - the userID of the user whose password is to be reset.
See Also:
oracle.iam.identity.usermgmt.impl.UserManagerImpl#resetPassword(String,boolean)

resetPassword

void resetPassword(java.lang.String userID,
                   java.util.Map controls)
Resets the password of an user to a randomly generated password. As part of the password reset, a notification is sent to the user regarding the new password. It takes a Map of control parameters to perform additional operation along with reset pasword.
NOTE: The email attribute of the user must be set for reset password to work
Parameters:
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.
Supported Control Parameters:
  • SentNotification - Boolean flag whether to send notification or not.
  • SendNotificationTo - Comma separated email address.

validatePasswordAgainstPolicy

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
Parameters:
password - the password to be validated, should not be null
userID - the userID of the user, should not be null
locale - the locale in which validation errors will be translated in case of password validation failure
Returns:
a ValidationResult containing the result of the validation
Throws:
java.lang.NullPointerException - if null userID or password is passed This object contains the validation status (success/failure) and the validation errors, if any

validatePasswordAgainstPolicy

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
Parameters:
password - the password to be validated, should not be null
userID - 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 failure
isUserLogin - Set to true if the userID contains user login and false if the userID contains entity ID.
Returns:
a ValidationResult containing the result of the validation
Throws:
java.lang.NullPointerException - if null userID or password is passed This object contains the validation status (success/failure) and the validation errors, if any

validatePasswordAgainstPolicy

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
Parameters:
password - the password to be validated
userInfo - the user's attributes information. Password validation typically requires firstName, lastName and userID
locale - the locale in which validation errors will be translated in case of password validation failure
Returns:
a ValidationResult object containing the result of the validation.
Throws:
java.lang.NullPointerException - if null password is passed

validatePasswordAgainstDefaultPolicy

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
Parameters:
password - the password to be validated
userInfo - the user's attributes information. Password validation typically requires firstName, lastName and userID
locale - the locale in which validation errors will be translated in case of password validation failure
Returns:
a ValidationResult object containing the result of the validation.
Throws:
java.lang.NullPointerException - if null password is passed

getApplicablePasswordPolicyDescription

PasswordPolicyDescription getApplicablePasswordPolicyDescription(User user)
Returns the description of the password policy applicable to the user in case of create user
Parameters:
userInfo, - UserInfo object
Returns:
the description of the PasswordPolicy

getApplicablePasswordPolicyDescription

PasswordPolicyDescription getApplicablePasswordPolicyDescription(java.lang.String userID)
Returns the description of the password policy applicable to the user
Parameters:
userID - the userID of the existing user
Returns:
the description of the PasswordPolicy

getApplicablePasswordPolicyDescription

PasswordPolicyDescription getApplicablePasswordPolicyDescription(java.lang.String userID,
                                                                 java.util.Locale locale)
Returns the description of the password policy applicable to the user.
Parameters:
userID - the userID of the user
locale - the locale in which password policy description is required.
Returns:
the description of the PasswordPolicy

getSystemDefaultPolicyDescription

PasswordPolicyDescription getSystemDefaultPolicyDescription(java.util.Locale locale)
Gets the system default policy description
Parameters:
locale - locale

create

PasswordPolicyInfo create(PasswordPolicyInfo passwordPolicyInfo)
Create a new Password Policy
Parameters:
passwordPolicyInfo - This VO contains the details of the Password Policy to be created
Returns:
PasswordPolicyInfo The information of the password policy created

getDetails

PasswordPolicyInfo getDetails(java.lang.String passwordPolicyName)
Get the details of specified Password Policy by Name
Parameters:
passwordPolicyName - The unique Name of the required password policy
Returns:
PasswordPolicyInfo The VO containing the details of the recieved policy

update

void update(PasswordPolicyInfo passwordPolicyInfo)
Update the attributes of the Password Policy specified
Parameters:
passwordPolicyInfo - This VO contains the details to be updated for the Password Policy

delete

void delete(java.lang.String plPasswordPolicyName)
Delete the Password Policy
Parameters:
plPasswordPolicyName - The unique Name of the password policy to be deleted
Throws:
java.lang.Exception

search

java.util.List search(SearchCriteria criteria)
Search for the list of policies having a specified search criteria
Parameters:
criteria - This VO contains the search criteria
Returns:
List<PasswordPolicyInfo> A list of the password policies matching the search criteria

getApplicablePasswordPolicyDescription

PasswordPolicyDescription getApplicablePasswordPolicyDescription(java.lang.String userID,
                                                                 java.lang.String appInstance)
                                                                 throws NoSuchPasswordPolicyException
Returns the description of the password policy applicable to the specific account
Parameters:
userID - the userID of the user
appInstance - name the application instance name to be provisioned
Returns:
the description of the PasswordPolicy
Throws:
NoSuchPasswordPolicyException

getApplicablePasswordPolicyDescription

PasswordPolicyDescription getApplicablePasswordPolicyDescription(java.lang.String userID,
                                                                 java.lang.String appInstance,
                                                                 java.util.Locale locale)
                                                                 throws NoSuchPasswordPolicyException
Returns the description of the password policy applicable to the specific account
Parameters:
userID - the userID of the user
appInstance - name the application instance name to be provisioned
locale - the locale in which password policy description is required.
Returns:
the description of the PasswordPolicy
Throws:
NoSuchPasswordPolicyException

validatePasswordAgainstPolicy

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
Parameters:
password - the password to be validated
userInfo - the user's attributes information. Password validation
appInstance - name the application instance name to be provisioned
locale - the locale in which validation errors will be translated in case of password validation failure
Returns:
a ValidationResult object containing the result of the validation.
Throws:
java.lang.NullPointerException - if null password is passed

Skip navigation links

Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

Copyright © 2015, Oracle and/or its affiliates. All rights reserved.