| 
 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object | +--com.iplanet.am.sdk.AMUserPasswordValidation
This class provides a userID and password validation plugin
 mechanism. 
 
 
The methods of this class need to be overridden by the implementation
 plugin modules that validate the userID and/or password for the
 user. The implementation plugin modules will be invoked whenever a
 userID or password value is being added/modified using Identity
 Server console, amadmin command line interface or using SDK
 API's directly.
   
 
The plugins that extend this class can be configured per Organization
 by setting the attribute:
 iplanet-am-admin-console-user-password-validation-class of 
 iPlanetAMAdminConsoleService Service. If a plugin is not 
 configured at an Organization, then the plugin configured at the global level
 will be used. 
 
 
If the validation of the plugin fails, the plugin module can throw an 
 Exception to notify the application to indicate the error in th
 userID or password supplied by the user. The Exception
 mechanism provides a means to notify the plugin specific validation error
 to the user.
| Constructor Summary | |
| AMUserPasswordValidation()Constructs the  AMUserPasswordValidation object | |
| Method Summary | |
|  void | validatePassword(java.lang.String password)Method to validate the Password. | 
|  void | validatePassword(java.lang.String password,
                 java.util.Map envParams)Method to validate the Password. | 
|  void | validateUserID(java.lang.String userID)Method to validate the userID. | 
|  void | validateUserID(java.lang.String userID,
               java.util.Map envParams)/** Method to validate the userID. | 
| Methods inherited from class java.lang.Object | 
| equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
| Constructor Detail | 
public AMUserPasswordValidation()
 AMUserPasswordValidation  object| Method Detail | 
public void validateUserID(java.lang.String userID)
                    throws AMException
userID.userID - the value of the user ID.AMException - if an error occurs in supplying password. The
 operation (add/modify) in progress 
 will be aborted and the application is notified about the error through 
 the exception.
public void validateUserID(java.lang.String userID,
                           java.util.Map envParams)
                    throws AMException
userID.userID - the value of the user ID.envParams - the values of the parameters for which the validation
        is enforced.AMException - if an error occurs in supplying password. The
 operation (add/modify) in progress 
 will be aborted and the application is notified about the error through 
 the exception.
public void validatePassword(java.lang.String password)
                      throws AMException
password - the password valueAMException - if an error occurs in supplying password. The
 operation (add/modify) in progress will be aborted and the application
 is notified about the error through the exception.
public void validatePassword(java.lang.String password,
                             java.util.Map envParams)
                      throws AMException
password - the password valueenvParams - the values of the parameters for which the password
        is validated.AMException - if an error occurs in supplying password. The
 operation (add/modify) in progress will be aborted and the application
 is notified about the error through the exception.| 
 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||