Package org.passay

Interface ValidationResult

All Known Implementing Classes:
AbstractValidationResult, FailureValidationResult, SuccessValidationResult
public interface ValidationResult
Result of a password validator.

  • 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.

  • Method Details

    • isValid

      boolean isValid()
      Returns whether the result of the rule verification is a valid password.
      Returns:
      valid password for this rule

    • getMetadata

      RuleResultMetadata getMetadata()
      Returns metadata associated with the rule verification.
      Returns:
      rule result metadata

    • getDetails

      List<RuleResultDetail> getDetails()
      Returns any details associated with the rule verification.
      Returns:
      rule result details

    • getMessages

      List<String> getMessages()
      Returns a list of human-readable messages by iterating over the details in a failed rule result.
      Returns:
      list of human-readable messages describing the reason(s) for validation failure.

    • getEntropy

      double getEntropy()
      Returns the calculated entropy of the PasswordData used to produce this validation result, based on the password rules specified.
      Returns:
      entropy estimate