public interface DictionaryPasswordValidatorCfgClient extends PasswordValidatorCfgClient
The Dictionary Password Validator determines whether a proposed password is acceptable based on whether the given password value appears in a provided dictionary file.
Modifier and Type | Method and Description |
---|---|
ManagedObjectDefinition<? extends DictionaryPasswordValidatorCfgClient,? extends DictionaryPasswordValidatorCfg> |
definition()
Get the configuration definition associated with this Dictionary Password Validator.
|
ValueOrExpression<String> |
getDictionaryFile()
Gets the "dictionary-file" property.
|
ValueOrExpression<String> |
getJavaClass()
Gets the "java-class" property.
|
ValueOrExpression<Integer> |
getMinSubstringLength()
Gets the "min-substring-length" property.
|
ValueOrExpression<Boolean> |
isCaseSensitiveValidation()
Gets the "case-sensitive-validation" property.
|
ValueOrExpression<Boolean> |
isCheckSubstrings()
Gets the "check-substrings" property.
|
ValueOrExpression<Boolean> |
isTestReversedPassword()
Gets the "test-reversed-password" property.
|
void |
setCaseSensitiveValidation(ValueOrExpression<Boolean> value)
Sets the "case-sensitive-validation" property.
|
void |
setCheckSubstrings(ValueOrExpression<Boolean> value)
Sets the "check-substrings" property.
|
void |
setDictionaryFile(ValueOrExpression<String> value)
Sets the "dictionary-file" property.
|
void |
setJavaClass(ValueOrExpression<String> value)
Sets the "java-class" property.
|
void |
setMinSubstringLength(ValueOrExpression<Integer> value)
Sets the "min-substring-length" property.
|
void |
setTestReversedPassword(ValueOrExpression<Boolean> value)
Sets the "test-reversed-password" property.
|
isEnabled, setEnabled
commit, properties
ManagedObjectDefinition<? extends DictionaryPasswordValidatorCfgClient,? extends DictionaryPasswordValidatorCfg> definition()
definition
in interface ConfigurationClient
definition
in interface PasswordValidatorCfgClient
ValueOrExpression<Boolean> isCaseSensitiveValidation()
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.
void setCaseSensitiveValidation(ValueOrExpression<Boolean> value) throws PropertyException
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.
value
- The value of the "case-sensitive-validation" property.PropertyException
- If the new value is invalid.ValueOrExpression<Boolean> isCheckSubstrings()
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.
void setCheckSubstrings(ValueOrExpression<Boolean> value) throws PropertyException
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.
value
- The value of the "check-substrings" property.PropertyException
- If the new value is invalid.ValueOrExpression<String> getDictionaryFile()
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.
void setDictionaryFile(ValueOrExpression<String> value) throws PropertyException
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.
value
- The value of the "dictionary-file" property.PropertyException
- If the new value is invalid.ValueOrExpression<String> getJavaClass()
Specifies the fully-qualified name of the Java class that provides the password validator implementation.
getJavaClass
in interface PasswordValidatorCfgClient
void setJavaClass(ValueOrExpression<String> value) throws PropertyException
Specifies the fully-qualified name of the Java class that provides the password validator implementation.
setJavaClass
in interface PasswordValidatorCfgClient
value
- The value of the "java-class" property.PropertyException
- If the new value is invalid.ValueOrExpression<Integer> getMinSubstringLength()
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.
void setMinSubstringLength(ValueOrExpression<Integer> value) throws PropertyException
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.
value
- The value of the "min-substring-length" property.PropertyException
- If the new value is invalid.ValueOrExpression<Boolean> isTestReversedPassword()
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.
void setTestReversedPassword(ValueOrExpression<Boolean> value) throws PropertyException
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.
value
- The value of the "test-reversed-password" property.PropertyException
- If the new value is invalid.Copyright 2010-2018 ForgeRock AS.