Package org.passay

Class SourceRule

  • All Implemented Interfaces:
    Rule
    Direct Known Subclasses:
    DigestSourceRule

    public class SourceRule
    extends Object
    implements Rule
    Rule for determining if a password matches a password from a different source. Useful for when separate systems cannot have matching passwords. If no source password reference has been set, then passwords will meet this rule. See PasswordData.setPasswordReferences(List)
    Author:
    Middleware Services
    • Field Detail

      • reportAllFailures

        protected boolean reportAllFailures
        Whether to report all source matches or just the first.
    • Constructor Detail

      • SourceRule

        public SourceRule()
        Creates a new source rule.
      • SourceRule

        public SourceRule​(boolean reportAll)
        Creates a new source rule.
        Parameters:
        reportAll - whether to report all matches or just the first
    • Method Detail

      • 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​(String password,
                                  PasswordData.Reference reference)
        Determines whether a password matches a source password.
        Parameters:
        password - candidate password
        reference - reference password
        Returns:
        true if passwords match, false otherwise.
      • createRuleResultDetailParameters

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