Interface AttributeValuePasswordValidatorCfg
-
- All Superinterfaces:
Configuration
,PasswordValidatorCfg
public interface AttributeValuePasswordValidatorCfg extends PasswordValidatorCfg
A server-side interface for querying Attribute Value Password Validator settings.The Attribute Value Password Validator attempts to determine whether a proposed password is acceptable for use by determining whether that password is contained in any attribute within the user's entry.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addAttributeValueChangeListener(ConfigurationChangeListener<AttributeValuePasswordValidatorCfg> listener)
Register to be notified when this Attribute Value Password Validator is changed.Class<? extends AttributeValuePasswordValidatorCfg>
configurationClass()
Gets the configuration class associated with this Attribute Value Password Validator.String
getJavaClass()
Gets the "java-class" property.SortedSet<AttributeType>
getMatchAttribute()
Gets the "match-attribute" property.int
getMinSubstringLength()
Gets the "min-substring-length" property.boolean
isCheckSubstrings()
Gets the "check-substrings" property.boolean
isTestReversedPassword()
Gets the "test-reversed-password" property.void
removeAttributeValueChangeListener(ConfigurationChangeListener<AttributeValuePasswordValidatorCfg> listener)
Deregister an existing Attribute Value 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 AttributeValuePasswordValidatorCfg> configurationClass()
Gets the configuration class associated with this Attribute Value Password Validator.- Specified by:
configurationClass
in interfaceConfiguration
- Specified by:
configurationClass
in interfacePasswordValidatorCfg
- Returns:
- Returns the configuration class associated with this Attribute Value Password Validator.
-
addAttributeValueChangeListener
void addAttributeValueChangeListener(ConfigurationChangeListener<AttributeValuePasswordValidatorCfg> listener)
Register to be notified when this Attribute Value Password Validator is changed.- Parameters:
listener
- The Attribute Value Password Validator configuration change listener.
-
removeAttributeValueChangeListener
void removeAttributeValueChangeListener(ConfigurationChangeListener<AttributeValuePasswordValidatorCfg> listener)
Deregister an existing Attribute Value Password Validator configuration change listener.- Parameters:
listener
- The Attribute Value Password Validator configuration change listener.
-
isCheckSubstrings
boolean isCheckSubstrings()
Gets the "check-substrings" property.Indicates whether this password validator is to match portions of the password string against attribute values.
If "false" then only match the entire password against attribute values otherwise ("true") check whether the password contains attribute values.
Default value:
true
- Returns:
- Returns the value of the "check-substrings" 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.AttributeValuePasswordValidator
- Specified by:
getJavaClass
in interfacePasswordValidatorCfg
- Returns:
- Returns the value of the "java-class" property.
-
getMatchAttribute
SortedSet<AttributeType> getMatchAttribute()
Gets the "match-attribute" property.Specifies the name(s) of the attribute(s) whose values should be checked to determine whether they match the provided password. If no values are provided, then the server checks if the proposed password matches the value of any attribute in the user's entry.
- Returns:
- Returns an unmodifiable set containing the values of the "match-attribute" 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 should test the reversed value of the provided password as well as the order in which it was given.
- Returns:
- Returns the value of the "test-reversed-password" property.
-
-