org.passay

Class AllowedRegexRule

java.lang.Object

org.passay.AllowedRegexRule

All Implemented Interfaces:

Rule

public class AllowedRegexRule
extends Object
implements Rule

Rule for determining if a password matches an allowed regular expression. Passwords must match the expression or validation will fail.

Author:

Middleware Services

Field Summary

Fields

Modifier and Type	Field and Description
static String	ERROR_CODE Error code for regex validation failures.
protected Pattern	pattern Regex pattern.

Constructor Summary

Constructors

Constructor and Description
AllowedRegexRule(String regex) Creates a new allowed regex rule.
AllowedRegexRule(String regex, int regexFlags) Creates a new allowed regex rule.

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	createRuleResultDetailParameters() Creates the parameter data for the rule result detail.
Pattern	getPattern() Returns the pattern for this rule.
String	toString()
RuleResult	validate(PasswordData passwordData) Validates the supplied password data per the requirements of this rule.

Methods inherited from class java.lang.Object

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

Field Detail

ERROR_CODE

public static final String ERROR_CODE

Error code for regex validation failures.

See Also:

Constant Field Values

pattern

protected final Pattern pattern

Regex pattern.

Constructor Detail

AllowedRegexRule

public AllowedRegexRule(String regex)

Creates a new allowed regex rule.

Parameters:

regex - regular expression

AllowedRegexRule

public AllowedRegexRule(String regex,
                        int regexFlags)

Creates a new allowed regex rule.

Parameters:

regex - regular expression

regexFlags - regular expression flags

Method Detail

getPattern

public Pattern getPattern()

Returns the pattern for this rule.

Returns:

pattern

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

createRuleResultDetailParameters

protected Map<String,Object> createRuleResultDetailParameters()

Creates the parameter data for the rule result detail.

Returns:

map of parameter name to value

toString

public String toString()

Overrides:

toString in class Object