org.passay

Class SourceRule

java.lang.Object

org.passay.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 Summary

Fields

Modifier and Type	Field and Description
static String	ERROR_CODE Error code for regex validation failures.
protected boolean	reportAllFailures Whether to report all source matches or just the first.

Constructor Summary

Constructors

Constructor and Description
SourceRule() Creates a new source rule.
SourceRule(boolean reportAll) Creates a new source rule.

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	createRuleResultDetailParameters(String source) Creates the parameter data for the rule result detail.
protected boolean	matches(String password, PasswordData.Reference reference) Determines whether a password matches a source password.
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, toString, wait, wait, wait

Field Detail

ERROR_CODE

public static final String ERROR_CODE

Error code for regex validation failures.

See Also:

Constant Field Values

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