Package org.passay

Class AbstractValidationResult

java.lang.Object

org.passay.AbstractValidationResult

All Implemented Interfaces:

ValidationResult

Direct Known Subclasses:

FailureValidationResult, SuccessValidationResult

public abstract class AbstractValidationResult
extends Object
implements ValidationResult

Base class for validation results.

Field Summary

Fields

Modifier and Type	Field	Description
private final double	entropy	Entropy of the password used for validation.
private final RuleResultMetadata	metadata	Metadata produced by a password rule.
private final boolean	valid	Whether password rule was successful.

Constructor Summary

Constructors

Constructor	Description
AbstractValidationResult(boolean valid, double entropy, RuleResultMetadata metadata)	Creates a new abstract validation result.
AbstractValidationResult(boolean valid, RuleResultMetadata metadata)	Creates a new abstract validation result.

Method Summary

Modifier and Type	Method	Description
List<RuleResultDetail>	getDetails()	Returns any details associated with the rule verification.
double	getEntropy()	Returns the calculated entropy of the PasswordData used to produce this validation result, based on the password rules specified.
List<String>	getMessages()	Returns a list of human-readable messages by iterating over the details in a failed rule result.
RuleResultMetadata	getMetadata()	Returns metadata associated with the rule verification.
boolean	isValid()	Returns whether the result of the rule verification is a valid password.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

valid

private final boolean valid

Whether password rule was successful.

entropy

private final double entropy

Entropy of the password used for validation.

metadata

private final RuleResultMetadata metadata

Metadata produced by a password rule.

Constructor Details

AbstractValidationResult

public AbstractValidationResult(boolean valid,
 RuleResultMetadata metadata)

Creates a new abstract validation result.

Parameters:

valid - whether validation was successful

metadata - metadata associated by the rule with the password

AbstractValidationResult

public AbstractValidationResult(boolean valid,
 double entropy,
 RuleResultMetadata metadata)

Creates a new abstract validation result.

Parameters:

valid - whether validation was successful

entropy - calculated entropy of the password

metadata - metadata associated by the rule with the password

Method Details

isValid

public boolean isValid()

Description copied from interface: ValidationResult

Returns whether the result of the rule verification is a valid password.

Specified by:

isValid in interface ValidationResult

Returns:

valid password for this rule

getEntropy

public double getEntropy()

Description copied from interface: ValidationResult

Returns the calculated entropy of the PasswordData used to produce this validation result, based on the password rules specified.

Specified by:

getEntropy in interface ValidationResult

Returns:

entropy estimate

getMetadata

public RuleResultMetadata getMetadata()

Description copied from interface: ValidationResult

Returns metadata associated with the rule verification.

Specified by:

getMetadata in interface ValidationResult

Returns:

rule result metadata

getDetails

public List<RuleResultDetail> getDetails()

Description copied from interface: ValidationResult

Returns any details associated with the rule verification.

Specified by:

getDetails in interface ValidationResult

Returns:

rule result details

getMessages

public List<String> getMessages()

Description copied from interface: ValidationResult

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

Specified by:

getMessages in interface ValidationResult

Returns:

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

toString

public String toString()

Overrides:

toString in class Object