Package org.passay.rule

Class DictionaryRule

java.lang.Object

org.passay.rule.AbstractDictionaryRule

org.passay.rule.DictionaryRule

All Implemented Interfaces:

Rule

public class DictionaryRule
extends AbstractDictionaryRule

Rule for determining if a password matches a dictionary word. This rule will optionally also check for reversed words.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ERROR_CODE	Error code for matching dictionary word.
static final String	ERROR_CODE_REVERSED	Error code for matching reversed dictionary word.

Constructor Summary

Constructors

Constructor	Description
DictionaryRule(Dictionary dict)	Creates a new dictionary rule.
DictionaryRule(Dictionary dict, boolean matchBackwards)	Creates a new dictionary rule.

Method Summary

Modifier and Type	Method	Description
protected CharSequence	doWordSearch(UnicodeString text)	Searches the dictionary with the supplied text.
protected String	getErrorCode(boolean backwards)	Returns the error code for this rule.

Methods inherited from class org.passay.rule.AbstractDictionaryRule

createRuleResultDetailParameters, getDictionary, isMatchBackwards, toString, validate

Methods inherited from class java.lang.Object

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

Field Details

ERROR_CODE

public static final String ERROR_CODE

Error code for matching dictionary word.

See Also:

• Constant Field Values

ERROR_CODE_REVERSED

public static final String ERROR_CODE_REVERSED

Error code for matching reversed dictionary word.

See Also:

• Constant Field Values

Constructor Details

DictionaryRule

public DictionaryRule(Dictionary dict)

Creates a new dictionary rule. The dictionary should be ready to use when passed to this constructor.

Parameters:

dict - to use for searching

DictionaryRule

public DictionaryRule(Dictionary dict,
 boolean matchBackwards)

Creates a new dictionary rule. The dictionary should be ready to use when passed to this constructor.

Parameters:

dict - to use for searching

matchBackwards - whether to match dictionary words backwards

Method Details

doWordSearch

protected CharSequence doWordSearch(UnicodeString text)

Description copied from class: AbstractDictionaryRule

Searches the dictionary with the supplied text.

Specified by:

doWordSearch in class AbstractDictionaryRule

Parameters:

text - to search dictionary with

Returns:

matching word

getErrorCode

protected String getErrorCode(boolean backwards)

Description copied from class: AbstractDictionaryRule

Returns the error code for this rule.

Specified by:

getErrorCode in class AbstractDictionaryRule

Parameters:

backwards - whether to return the error code for a backwards match

Returns:

properties error code