Interface DictionaryPasswordValidatorCfg
-
- All Superinterfaces:
Configuration
,PasswordValidatorCfg
public interface DictionaryPasswordValidatorCfg extends PasswordValidatorCfg
A server-side interface for querying Dictionary Password Validator settings.The Dictionary Password Validator determines whether a proposed password is acceptable based on whether the given password value appears in a provided dictionary file.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addDictionaryChangeListener(ConfigurationChangeListener<DictionaryPasswordValidatorCfg> listener)
Register to be notified when this Dictionary Password Validator is changed.Class<? extends DictionaryPasswordValidatorCfg>
configurationClass()
Gets the configuration class associated with this Dictionary Password Validator.String
getDictionaryFile()
Gets the "dictionary-file" property.String
getJavaClass()
Gets the "java-class" property.int
getMinSubstringLength()
Gets the "min-substring-length" property.boolean
isCaseSensitiveValidation()
Gets the "case-sensitive-validation" property.boolean
isCheckSubstrings()
Gets the "check-substrings" property.boolean
isTestReversedPassword()
Gets the "test-reversed-password" property.void
removeDictionaryChangeListener(ConfigurationChangeListener<DictionaryPasswordValidatorCfg> listener)
Deregister an existing Dictionary Password Validator configuration change listener.-
Methods inherited from interface org.forgerock.opendj.config.Configuration
dn, name
-
Methods inherited from interface org.forgerock.opendj.server.config.server.PasswordValidatorCfg
addChangeListener, isEnabled, removeChangeListener
-
-
-
-
Method Detail
-
configurationClass
Class<? extends DictionaryPasswordValidatorCfg> configurationClass()
Gets the configuration class associated with this Dictionary Password Validator.- Specified by:
configurationClass
in interfaceConfiguration
- Specified by:
configurationClass
in interfacePasswordValidatorCfg
- Returns:
- Returns the configuration class associated with this Dictionary Password Validator.
-
addDictionaryChangeListener
void addDictionaryChangeListener(ConfigurationChangeListener<DictionaryPasswordValidatorCfg> listener)
Register to be notified when this Dictionary Password Validator is changed.- Parameters:
listener
- The Dictionary Password Validator configuration change listener.
-
removeDictionaryChangeListener
void removeDictionaryChangeListener(ConfigurationChangeListener<DictionaryPasswordValidatorCfg> listener)
Deregister an existing Dictionary Password Validator configuration change listener.- Parameters:
listener
- The Dictionary Password Validator configuration change listener.
-
isCaseSensitiveValidation
boolean isCaseSensitiveValidation()
Gets the "case-sensitive-validation" property.Indicates whether this password validator is to treat password characters in a case-sensitive manner.
If it is set to true, then the validator rejects a password only if it appears in the dictionary with exactly the same capitalization as provided by the user.
- Returns:
- Returns the value of the "case-sensitive-validation" property.
-
isCheckSubstrings
boolean isCheckSubstrings()
Gets the "check-substrings" property.Indicates whether this password validator is to match portions of the password string against dictionary words.
If "false" then only match the entire password against words otherwise ("true") check whether the password contains words.
Default value:
true
- Returns:
- Returns the value of the "check-substrings" property.
-
getDictionaryFile
String getDictionaryFile()
Gets the "dictionary-file" property.Specifies the path to the file containing a list of words that cannot be used as passwords.
It should be formatted with one word per line. The value can be an absolute path or a path that is relative to the OpenDJ instance root.
- Returns:
- Returns the value of the "dictionary-file" property.
-
getJavaClass
String getJavaClass()
Gets the "java-class" property.Specifies the fully-qualified name of the Java class that provides the password validator implementation.
Default value:
org.opends.server.extensions.DictionaryPasswordValidator
- Specified by:
getJavaClass
in interfacePasswordValidatorCfg
- Returns:
- Returns the value of the "java-class" property.
-
getMinSubstringLength
int getMinSubstringLength()
Gets the "min-substring-length" property.Indicates the minimal length of the substring within the password in case substring checking is enabled.
If "check-substrings" option is set to true, then this parameter defines the length of the smallest word which should be used for substring matching. Use with caution because values below 3 might disqualify valid passwords.
Default value:
5
- Returns:
- Returns the value of the "min-substring-length" property.
-
isTestReversedPassword
boolean isTestReversedPassword()
Gets the "test-reversed-password" property.Indicates whether this password validator is to test the reversed value of the provided password as well as the order in which it was given.
For example, if the user provides a new password of "password" and this configuration attribute is set to true, then the value "drowssap" is also tested against attribute values in the user's entry.
- Returns:
- Returns the value of the "test-reversed-password" property.
-
-