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

Class PasswordConstraintList

java.lang.Object

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

All Implemented Interfaces:

com.helger.commons.ICloneable<IPasswordConstraintList>, IPasswordConstraintList

@NotThreadSafe
public class PasswordConstraintList
extends Object
implements IPasswordConstraintList

The default implementation of IPasswordConstraintList.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
PasswordConstraintList()
PasswordConstraintList(IPasswordConstraint... aPasswordConstraints)
PasswordConstraintList(IPasswordConstraintList aOther)
PasswordConstraintList(Iterable<? extends IPasswordConstraint> aPasswordConstraints)

Method Summary

Methods

Modifier and Type	Method and Description
PasswordConstraintList	addConstraint(IPasswordConstraint aPasswordConstraint) Added a password constraint.
boolean	equals(Object o)
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()
PasswordConstraintList	getClone()
int	getConstraintCount()
List<String>	getInvalidPasswordDescriptions(String sPlainTextPassword, Locale aContentLocale) Check if the passed password is valid.
boolean	hasConstraints()
int	hashCode()
boolean	isPasswordValid(String sPlainTextPassword) Check if the passed plaintext password is valid.
com.helger.commons.state.EChange	removeConstraint(IPasswordConstraint aPasswordConstraint) Remove the passed constraint.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PasswordConstraintList

public PasswordConstraintList()

PasswordConstraintList

public PasswordConstraintList(@Nonnull
                      IPasswordConstraintList aOther)

PasswordConstraintList

public PasswordConstraintList(@Nullable
                      IPasswordConstraint... aPasswordConstraints)

PasswordConstraintList

public PasswordConstraintList(@Nullable
                      Iterable<? extends IPasswordConstraint> aPasswordConstraints)

Method Detail

hasConstraints

public boolean hasConstraints()

Specified by:

hasConstraints in interface IPasswordConstraintList

Returns:

true if at least one constraint is present

getConstraintCount

@Nonnegative
public int getConstraintCount()

Specified by:

getConstraintCount in interface IPasswordConstraintList

Returns:

The number of contained constraints. Always ≥ 0.

getAllPasswordConstraints

@Nonnull
@ReturnsMutableCopy
public List<IPasswordConstraint> getAllPasswordConstraints()

Specified by:

getAllPasswordConstraints in interface IPasswordConstraintList

Returns:

A list of all contained password constraints. Never null.

addConstraint

@Nonnull
public PasswordConstraintList addConstraint(@Nonnull
                                           IPasswordConstraint aPasswordConstraint)

Added a password constraint.

Parameters:

aPasswordConstraint - The constraint to be added. May not be null.

Returns:

this

removeConstraint

@Nonnull
public com.helger.commons.state.EChange removeConstraint(@Nullable
                                                        IPasswordConstraint aPasswordConstraint)

Remove the passed constraint.

Parameters:

aPasswordConstraint - The constraint to be removed. May be null.

Returns:

EChange.

isPasswordValid

public boolean isPasswordValid(@Nullable
                      String sPlainTextPassword)

Description copied from interface: IPasswordConstraintList

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

Specified by:

isPasswordValid in interface IPasswordConstraintList

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
public List<String> getInvalidPasswordDescriptions(@Nullable
                                                                     String sPlainTextPassword,
                                                                     @Nonnull
                                                                     Locale aContentLocale)

Description copied from interface: IPasswordConstraintList

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

Specified by:

getInvalidPasswordDescriptions in interface IPasswordConstraintList

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
public List<String> getAllPasswordConstraintDescriptions(@Nonnull
                                                                           Locale aContentLocale)

Description copied from interface: IPasswordConstraintList

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

Specified by:

getAllPasswordConstraintDescriptions in interface IPasswordConstraintList

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.

getClone

@Nonnull
public PasswordConstraintList getClone()

Specified by:

getClone in interface com.helger.commons.ICloneable<IPasswordConstraintList>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object