com.webmethods.portal.service.dir

Interface ISystemPasswordComplexityPolicy

public interface ISystemPasswordComplexityPolicy

Interface that can be implemented to provide password complexity enforcement for users in the system directory service

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ISystemPasswordComplexityPolicy.InvalidPasswordException Exception class used to indicate password complexity violations.

Method Summary

Modifier and Type	Method and Description
void	checkPasswordForExistingUser(IDirPrincipal user, String candidatePassword) Check the candidate password to make sure the value satisfies the complexity requirements.
void	checkPasswordForNewUser(String candidatePassword) Check the candidate password to make sure the value satisfies the complexity requirements.
long	getPasswordExpirationDuration(IDirPrincipal user) Return how long a password is valid (in milliseconds) before it expires.
String	getPasswordPatternText() Returns a description of the expected pattern a password must have.

Method Detail

checkPasswordForNewUser

void checkPasswordForNewUser(String candidatePassword)
                      throws ISystemPasswordComplexityPolicy.InvalidPasswordException

Check the candidate password to make sure the value satisfies the complexity requirements. If the password is not complex enough, this method should throw an ISystemPasswordComplexityPolicy.InvalidPasswordException with the reason. If no exception is thrown the password is valid.

Parameters:

candidatePassword - the password to check

Throws:

ISystemPasswordComplexityPolicy.InvalidPasswordException - if the password is not valid

checkPasswordForExistingUser

void checkPasswordForExistingUser(IDirPrincipal user,
                                  String candidatePassword)
                           throws ISystemPasswordComplexityPolicy.InvalidPasswordException

Check the candidate password to make sure the value satisfies the complexity requirements. If the password is not complex enough, this method should throw an ISystemPasswordComplexityPolicy.InvalidPasswordException with the reason. If no exception is thrown the password is valid.

Parameters:

user - the user whose password is being checked.

candidatePassword - the password to check

Throws:

ISystemPasswordComplexityPolicy.InvalidPasswordException - if the password is not valid

getPasswordExpirationDuration

long getPasswordExpirationDuration(IDirPrincipal user)

Return how long a password is valid (in milliseconds) before it expires. The user will not be able to login after this time duration has expired and the user must be reset by an administrator or a custom reset password page.

Parameters:

user - the user to get the expiration value for.

Returns:

return -1 for no password expiration, or the duration (in ms)

getPasswordPatternText

String getPasswordPatternText()

Returns a description of the expected pattern a password must have. This text is displayed on the create user and update user pages of the UI.

Returns:

password descriptive text.