Package org.passay

Class PasswordValidator

java.lang.Object

org.passay.PasswordValidator

All Implemented Interfaces:

Rule

public class PasswordValidator
extends Object
implements Rule

The central component for evaluating multiple password rules against a candidate password.

Author:

Middleware Services

Constructor Summary

Constructors

Constructor	Description
PasswordValidator(List<? extends Rule> rules)	Creates a new password validator with a PropertiesMessageResolver.
PasswordValidator(MessageResolver resolver, List<? extends Rule> rules)	Creates a new password validator.
PasswordValidator(MessageResolver resolver, Rule... rules)	See PasswordValidator(MessageResolver, List).
PasswordValidator(Rule... rules)	See PasswordValidator(List).

Method Summary

Modifier and Type	Method	Description
double	estimateEntropy(PasswordData passwordData)	Calculates the entropy of the given PasswordData based on the specified password rules specified.
MessageResolver	getMessageResolver()	Returns the message resolver for this validator.
List<String>	getMessages(RuleResult result)	Returns a list of human-readable messages by iterating over the details in a failed rule result.
List<? extends Rule>	getRules()	Returns the password rules for this validator.
String	toString()
RuleResult	validate(PasswordData passwordData)	Validates the supplied password data against the rules in this validator.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PasswordValidator

public PasswordValidator(Rule... rules)

See PasswordValidator(List).

Parameters:

rules - to validate

PasswordValidator

public PasswordValidator(List<? extends Rule> rules)

Creates a new password validator with a PropertiesMessageResolver.

Parameters:

rules - to validate

PasswordValidator

public PasswordValidator(MessageResolver resolver,
                         Rule... rules)

See PasswordValidator(MessageResolver, List).

Parameters:

resolver - message resolver.

rules - to validate

PasswordValidator

public PasswordValidator(MessageResolver resolver,
                         List<? extends Rule> rules)

Creates a new password validator.

Parameters:

resolver - message resolver.

rules - to validate

Method Detail

getRules

public List<? extends Rule> getRules()

Returns the password rules for this validator.

Returns:

unmodifiable list of password rules

getMessageResolver

public MessageResolver getMessageResolver()

Returns the message resolver for this validator.

Returns:

message resolver

validate

public RuleResult validate(PasswordData passwordData)

Validates the supplied password data against the rules in this validator.

Specified by:

validate in interface Rule

Parameters:

passwordData - to validate

Returns:

rule result

estimateEntropy

public double estimateEntropy(PasswordData passwordData)

Calculates the entropy of the given PasswordData based on the specified password rules specified. It's important to note that this method does NOT take into account IllegalRegexRule or AllowedRegexRule as the regular expressions driving the rules may be negative matches.

Parameters:

passwordData - to estimate entropy for

Returns:

entropy estimate

Throws:

IllegalArgumentException - for unknown PasswordData.Origin or if the required CharacterRule instances are unavailable in the passwordRules of this validator instance.

See Also:

PDF Publication

getMessages

public List<String> getMessages(RuleResult result)

Returns a list of human-readable messages by iterating over the details in a failed rule result.

Parameters:

result - failed rule result.

Returns:

list of human-readable messages describing the reason(s) for validation failure.

toString

public String toString()

Overrides:

toString in class Object