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

Interface IPasswordConstraintList

All Superinterfaces:

com.helger.commons.ICloneable<IPasswordConstraintList>

All Known Implementing Classes:

PasswordConstraintList

public interface IPasswordConstraintList
extends com.helger.commons.ICloneable<IPasswordConstraintList>

This interface defines a list of password constraints.

Author:

Philip Helger

Method Summary

Methods

Modifier and Type	Method and Description
List<String>	getAllPasswordConstraintDescriptions(Locale aContentLocale) Get a list of all password constraint descriptions in the specified locale (e.g. for hinting a user)
List<IPasswordConstraint>	getAllPasswordConstraints()
int	getConstraintCount()
List<String>	getInvalidPasswordDescriptions(String sPlainTextPassword, Locale aContentLocale) Check if the passed password is valid.
boolean	hasConstraints()
boolean	isPasswordValid(String sPlainTextPassword) Check if the passed plaintext password is valid.

Methods inherited from interface com.helger.commons.ICloneable

getClone

Method Detail

hasConstraints

boolean hasConstraints()

Returns:

true if at least one constraint is present

getConstraintCount

@Nonnegative
int getConstraintCount()

Returns:

The number of contained constraints. Always ≥ 0.

getAllPasswordConstraints

@Nonnull
@ReturnsMutableCopy
List<IPasswordConstraint> getAllPasswordConstraints()

Returns:

A list of all contained password constraints. Never null.

isPasswordValid

boolean isPasswordValid(@Nullable
                      String sPlainTextPassword)

Check if the passed plaintext password is valid. Breaks after the first unfulfilled constrained

Parameters:

sPlainTextPassword - The password to check. May be null.

Returns:

true if no constraint was unfulfilled (meaning that if no constrained is defined, every password is valid).

getInvalidPasswordDescriptions

@Nonnull
@ReturnsMutableCopy
List<String> getInvalidPasswordDescriptions(@Nullable
                                                                     String sPlainTextPassword,
                                                                     @Nonnull
                                                                     Locale aContentLocale)

Check if the passed password is valid. The descriptions of all failed constraints are returned.

Parameters:

sPlainTextPassword - The password to check. May be null.

aContentLocale - The content locale to be used to determine the descriptions.

Returns:

A non-null but empty list if no constraint was unfulfilled (meaning that if no constrained is defined, every password is valid). If the returned list is not empty than the password is invalid.

getAllPasswordConstraintDescriptions

@Nonnull
@ReturnsMutableCopy
List<String> getAllPasswordConstraintDescriptions(@Nonnull
                                                                           Locale aContentLocale)

Get a list of all password constraint descriptions in the specified locale (e.g. for hinting a user)

Parameters:

aContentLocale - The locale to be used for text resolving.

Returns:

A non-null list with all constraint descriptions. If the returned list is empty, it means that no constraint is defined.