com.helger.photon.basic.security.password.constraint

Interface IPasswordConstraint

All Known Implementing Classes:

PasswordConstraintMaxLength, PasswordConstraintMinLength, PasswordConstraintMustContainDigit, PasswordConstraintMustContainLetter, PasswordConstraintMustContainLetterLowerCase, PasswordConstraintMustContainLetterUpperCase, PasswordConstraintMustContainSpecialChar

@MustImplementEqualsAndHashcode
public interface IPasswordConstraint

Base interface for a single password constraint type.

Author:

Philip Helger

Method Summary

Methods

Modifier and Type	Method and Description
void	fillMicroElement(com.helger.commons.microdom.IMicroElement aElement) This method is responsible for filling a micro element for serializing the password constraints.
String	getDescription(Locale aContentLocale) Get a description of this constraint, so that it can be displayed to the user
boolean	isPasswordValid(String sPlainTextPassword) Check if the supplied password matches this constraint

Method Detail

isPasswordValid

boolean isPasswordValid(@Nullable
                      String sPlainTextPassword)

Check if the supplied password matches this constraint

Parameters:

sPlainTextPassword - The plain text password to check. May be null.

Returns:

true if it is valid, false if it is not

getDescription

@Nullable
String getDescription(@Nonnull
                             Locale aContentLocale)

Get a description of this constraint, so that it can be displayed to the user

Parameters:

aContentLocale - The locale to get the description in. Never null.

Returns:

null if no text is present in the provided locale

fillMicroElement

void fillMicroElement(@Nonnull
                    com.helger.commons.microdom.IMicroElement aElement)

This method is responsible for filling a micro element for serializing the password constraints.

Parameters:

aElement - The element to be filled. Never null.