Package org.passay.rule

Class HistoryRule

java.lang.Object
org.passay.rule.HistoryRule
All Implemented Interfaces:
Rule
Direct Known Subclasses:
DigestHistoryRule
public class HistoryRule extends Object implements Rule
Rule for determining if a password matches one of any previous password a user has chosen. If no historical password reference has been set, then passwords will meet this rule. See PasswordData.getPasswordReferences().

  • Field Details

    • ERROR_CODE

      public static final String ERROR_CODE
      Error code for history violation.
      See Also:

    • reportAllFailures

      protected final boolean reportAllFailures
      Whether to report all history matches or just the first.

  • Constructor Details

    • HistoryRule

      public HistoryRule()
      Creates a new history rule.

    • HistoryRule

      public HistoryRule(boolean reportAll)
      Creates a new history rule.
      Parameters:
      reportAll - whether to report all matches or just the first

  • Method Details

    • getReportAllFailures

      public boolean getReportAllFailures()
      Returns whether to report all matches or just the first.
      Returns:
      whether to report all matches or just the first

    • validate

      public RuleResult validate(PasswordData passwordData)
      Description copied from interface: Rule
      Validates the supplied password data per the requirements of this rule.
      Specified by:
      validate in interface Rule
      Parameters:
      passwordData - to verify (not null).
      Returns:
      details on password verification

    • matches

      protected boolean matches(UnicodeString password, Reference reference)
      Determines whether a password matches an historical password.
      Parameters:
      password - candidate password
      reference - reference password
      Returns:
      true if passwords match, false otherwise.

    • createRuleResultDetailParameters

      protected Map<String,Object> createRuleResultDetailParameters(int size)
      Creates the parameter data for the rule result detail.
      Parameters:
      size - of the history list
      Returns:
      map of parameter name to value

    • toString

      public String toString()
      Overrides:
      toString in class Object