com.iplanet.am.sdk
Class AMUserPasswordValidation
java.lang.Object
|
+--com.iplanet.am.sdk.AMUserPasswordValidation
- public class AMUserPasswordValidation
- extends java.lang.Object
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 CLI 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 the userID or
password supplied by the user. The Exception mechanism provides a means to
notify the plugin specific validation error to the user.
Method Summary |
void |
validatePassword(java.lang.String password)
Method to validate the Password. |
void |
validateUserID(java.lang.String userID)
Method to validate the userID. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
AMUserPasswordValidation
public AMUserPasswordValidation()
validateUserID
public void validateUserID(java.lang.String userID)
throws AMException
- Method to validate the userID.
- Parameters:
userID
- the value of the userID- Throws:
AMException
- an expection that needs to be thrown to report an
error in the supplied password. The operation (add/modify) in progress
will be aborted and the application is notified about the error through
the exception.
validatePassword
public void validatePassword(java.lang.String password)
throws AMException
- Method to validate the Password.
- Parameters:
password
- the password value- Throws:
AMException
- an expection that needs to be thrown to report an
error in the supplied password. The operation (add/modify) in progress
will be aborted and the application is notified about the error through
the exception.