Uses of Interface
org.passay.rule.Rule

Packages that use Rule

Package	Description
org.passay
org.passay.entropy
org.passay.generate
org.passay.rule

Uses of Rule in org.passay

Fields in org.passay with type parameters of type Rule

Modifier and Type	Field	Description
static final BiFunction<List<? extends Rule>,PasswordData,Entropy>	DefaultPasswordValidator.DEFAULT_ENTROPY_PROVIDER	Calculates the entropy of the given PasswordData based on the password rules specified.
private final BiFunction<List<? extends Rule>,PasswordData,Entropy>	DefaultPasswordValidator.entropyProvider	Entropy provider.
static final BiFunction<List<? extends Rule>,PasswordData,Entropy>	DefaultPasswordValidator.NO_ENTROPY_PROVIDER	Entropy provider that returns -1.
private final List<Rule>	DefaultPasswordValidator.passwordRules	Password rules.

Methods in org.passay that return types with arguments of type Rule

Modifier and Type	Method	Description
BiFunction<List<? extends Rule>,PasswordData,Entropy>	DefaultPasswordValidator.getEntropyProvider()
BiFunction<List<? extends Rule>,PasswordData,Entropy>	PasswordValidator.getEntropyProvider()	Returns the entropy provider for this validator.
List<? extends Rule>	DefaultPasswordValidator.getRules()
List<? extends Rule>	PasswordValidator.getRules()	Returns the password rules for this validator.

Constructors in org.passay with parameters of type Rule

Modifier	Constructor	Description
	DefaultPasswordValidator(boolean failFast, BiFunction<List<? extends Rule>,PasswordData,Entropy> entropyProvider, Rule... rules)	Creates a new default password validator.
	DefaultPasswordValidator(boolean failFast, MessageResolver resolver, BiFunction<List<? extends Rule>,PasswordData,Entropy> entropyProvider, Rule... rules)	Creates a new default password validator.
	DefaultPasswordValidator(boolean failFast, MessageResolver resolver, Rule... rules)	Creates a new default password validator.
	DefaultPasswordValidator(boolean failFast, Rule... rules)	Creates a new default password validator.
	DefaultPasswordValidator(BiFunction<List<? extends Rule>,PasswordData,Entropy> entropyProvider, Rule... rules)	Creates a new default password validator.
	DefaultPasswordValidator(MessageResolver resolver, BiFunction<List<? extends Rule>,PasswordData,Entropy> entropyProvider, Rule... rules)	Creates a new default password validator.
	DefaultPasswordValidator(MessageResolver resolver, Rule... rules)	Creates a new default password validator.
	DefaultPasswordValidator(Rule... rules)	Creates a new default password validator.

Constructor parameters in org.passay with type arguments of type Rule

Modifier	Constructor	Description
	DefaultPasswordValidator(boolean failFast, BiFunction<List<? extends Rule>,PasswordData,Entropy> entropyProvider, List<? extends Rule> rules)	Creates a new default password validator.
	DefaultPasswordValidator(boolean failFast, BiFunction<List<? extends Rule>,PasswordData,Entropy> entropyProvider, List<? extends Rule> rules)	Creates a new default password validator.
	DefaultPasswordValidator(boolean failFast, BiFunction<List<? extends Rule>,PasswordData,Entropy> entropyProvider, Rule... rules)	Creates a new default password validator.
	DefaultPasswordValidator(boolean failFast, List<? extends Rule> rules)	Creates a new default password validator.
	DefaultPasswordValidator(boolean failFast, MessageResolver resolver, BiFunction<List<? extends Rule>,PasswordData,Entropy> entropyProvider, List<? extends Rule> rules)	Creates a new default password validator.
	DefaultPasswordValidator(boolean failFast, MessageResolver resolver, BiFunction<List<? extends Rule>,PasswordData,Entropy> entropyProvider, List<? extends Rule> rules)	Creates a new default password validator.
	DefaultPasswordValidator(boolean failFast, MessageResolver resolver, BiFunction<List<? extends Rule>,PasswordData,Entropy> entropyProvider, Rule... rules)	Creates a new default password validator.
	DefaultPasswordValidator(boolean failFast, MessageResolver resolver, List<? extends Rule> rules)	Creates a new default password validator.
	DefaultPasswordValidator(BiFunction<List<? extends Rule>,PasswordData,Entropy> entropyProvider, List<? extends Rule> rules)	Creates a new default password validator.
	DefaultPasswordValidator(BiFunction<List<? extends Rule>,PasswordData,Entropy> entropyProvider, List<? extends Rule> rules)	Creates a new default password validator.
	DefaultPasswordValidator(BiFunction<List<? extends Rule>,PasswordData,Entropy> entropyProvider, Rule... rules)	Creates a new default password validator.
	DefaultPasswordValidator(List<? extends Rule> rules)	Creates a new default password validator.
	DefaultPasswordValidator(MessageResolver resolver, BiFunction<List<? extends Rule>,PasswordData,Entropy> entropyProvider, List<? extends Rule> rules)	Creates a new default password validator.
	DefaultPasswordValidator(MessageResolver resolver, BiFunction<List<? extends Rule>,PasswordData,Entropy> entropyProvider, List<? extends Rule> rules)	Creates a new default password validator.
	DefaultPasswordValidator(MessageResolver resolver, BiFunction<List<? extends Rule>,PasswordData,Entropy> entropyProvider, Rule... rules)	Creates a new default password validator.
	DefaultPasswordValidator(MessageResolver resolver, List<? extends Rule> rules)	Creates a new default password validator.

Uses of Rule in org.passay.entropy

Method parameters in org.passay.entropy with type arguments of type Rule

Modifier and Type	Method	Description
static RandomPasswordEntropy	RandomPasswordEntropyFactory.createEntropy(List<? extends Rule> passwordRules, PasswordData passwordData)	Creates a new random password entropy.
static ShannonEntropy	ShannonEntropyFactory.createEntropy(List<? extends Rule> passwordRules, PasswordData passwordData)	Creates a new shannon entropy.

Uses of Rule in org.passay.generate

Fields in org.passay.generate with type parameters of type Rule

Modifier and Type	Field	Description
private final List<Rule>	PasswordGenerator.passwordRules	Rules to determine password character appenders.

Method parameters in org.passay.generate with type arguments of type Rule

Modifier and Type	Method	Description
private UnicodeString	PasswordGenerator.getAllowedCharacters(List<? extends Rule> rules)	Returns the unique set of allowed characters as defined in the supplied list of AllowedCharacterRule.
protected List<CharacterAppender>	PasswordGenerator.getCharacterAppenders(List<? extends Rule> rules, UnicodeString allowedChars, UnicodeString illegalChars, Random rand)	Returns the list of character appenders used for password generation.
private UnicodeString	FillRemainingCharactersAppender.getCharacters(List<? extends Rule> rules)	Return a unicode string that contains the unique characters from all CharacterRule or CharacterCharacteristicsRule contained in the supplied list.
private UnicodeString	PasswordGenerator.getIllegalCharacters(List<? extends Rule> rules)	Returns the unique set of illegal characters as defined in the supplied list of IllegalCharacterRule.

Constructors in org.passay.generate with parameters of type Rule

Modifier	Constructor	Description
	PasswordGenerator(int length, int retryLimit, Rule... rules)	Creates a new password generator.
	PasswordGenerator(int length, Rule... rules)	Creates a new password generator.
	PasswordGenerator(Random random, int length, int retryLimit, Rule... rules)	Creates a new password generator.

Constructor parameters in org.passay.generate with type arguments of type Rule

Modifier	Constructor	Description
	FillRemainingCharactersAppender(List<? extends Rule> rules, UnicodeString allowedChars, UnicodeString illegalChars, Random rand)	Creates a new fill appender.
	PasswordGenerator(int length, int retryLimit, List<? extends Rule> rules)	Creates a new password generator.
	PasswordGenerator(int length, List<? extends Rule> rules)	Creates a new password generator.
	PasswordGenerator(Random random, int length, int retryLimit, List<? extends Rule> rules)	Creates a new password generator.

Uses of Rule in org.passay.rule

Classes in org.passay.rule that implement Rule

Modifier and Type	Class	Description
class	AbstractDictionaryRule	Provides common implementation for password dictionary rules.
class	AllowedCharacterRule	Rule for determining if a password contains allowed characters.
class	AllowedRegexRule	Rule for determining if a password matches an allowed regular expression.
class	CharacterCharacteristicsRule	Rule for determining if a password contains the desired mix of character types.
class	CharacterOccurrencesRule	Validates that a password does not contain too many occurrences of the same character.
class	CharacterRule	Validates whether a password contains a certain number of a type of character.
class	CompositeRule	Rule that is composed of other rules.
class	DictionaryRule	Rule for determining if a password matches a dictionary word.
class	DictionarySubstringRule	Rule for determining if a password contains a dictionary word with optional checking for reversed words.
class	DigestDictionaryRule	Rule for determining if a password matches a digested password that is stored in a dictionary.
class	DigestHistoryRule	Rule for determining if a password matches one of any previous digested password a user has chosen.
class	DigestSourceRule	Rule for determining if a password matches a digested password from a different source.
class	HaveIBeenPwnedRule	Validates the password against the online database of haveibeenpwned.com optionally allowing the usage of found passwords, but returns the number of found matches in the metadata.
class	HistoryRule	Rule for determining if a password matches one of any previous password a user has chosen.
class	IllegalCharacterRule	Rule for determining if a password contains an illegal character.
class	IllegalRegexRule	Rule for determining if a password matches an illegal regular expression.
class	IllegalSequenceRule	Password validation rule that prevents illegal sequences of characters, e.g. keyboard, alphabetical, numeric.
class	LengthComplexityRule	Rule for determining if a password contains the desired complexity for a certain length.
class	LengthRule	Rule for determining if a password is within a desired length.
class	NumberRangeRule	Rule for determining if a password contains any number within a defined range, lower inclusive, upper exclusive.
class	RepeatCharactersRule	Rule for determining if a password contains multiple sequences of repeating characters.
class	SourceRule	Rule for determining if a password matches a password from a different source.
class	UsernameRule	Rule for determining if a password contains the username associated with that password.
class	WhitespaceRule	Rule for determining if a password contains whitespace characters.

Fields in org.passay.rule with type parameters of type Rule

Modifier and Type	Field	Description
private final List<Rule>	CompositeRule.passwordRules	Password rules.
private final Map<LengthComplexityRule.Interval,List<Rule>>	LengthComplexityRule.rules	Rules to apply when checking a password.

Methods in org.passay.rule that return types with arguments of type Rule

Modifier and Type	Method	Description
Map<LengthComplexityRule.Interval,List<? extends Rule>>	LengthComplexityRule.getRules()	Returns the password rules for this complexity rule.
private List<Rule>	LengthComplexityRule.getRulesByLength(int length)	Returns the rules that apply to the supplied password length.

Constructors in org.passay.rule with parameters of type Rule

Modifier	Constructor	Description
	CompositeRule(Rule... rules)	See CompositeRule(List).
	Entry(String interval, Rule... rules)	Creates a new entry.

Constructor parameters in org.passay.rule with type arguments of type Rule

Modifier	Constructor	Description
	CompositeRule(List<? extends Rule> rules)	Creates a new composite rule.
	Entry(String interval, List<Rule> rules)	Creates a new entry.