Interface AttributeValuePasswordValidatorCfgClient
-
- All Superinterfaces:
ConfigurationClient
,PasswordValidatorCfgClient
public interface AttributeValuePasswordValidatorCfgClient extends PasswordValidatorCfgClient
A client-side interface for reading and modifying 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 ManagedObjectDefinition<? extends AttributeValuePasswordValidatorCfgClient,? extends AttributeValuePasswordValidatorCfg>
definition()
Get the configuration definition associated with this Attribute Value Password Validator.ValueOrExpression<String>
getJavaClass()
Gets the "java-class" property.SortedSet<ValueOrExpression<AttributeType>>
getMatchAttribute()
Gets the "match-attribute" property.ValueOrExpression<Integer>
getMinSubstringLength()
Gets the "min-substring-length" property.ValueOrExpression<Boolean>
isCheckSubstrings()
Gets the "check-substrings" property.ValueOrExpression<Boolean>
isTestReversedPassword()
Gets the "test-reversed-password" property.void
setCheckSubstrings(ValueOrExpression<Boolean> value)
Sets the "check-substrings" property.void
setJavaClass(ValueOrExpression<String> value)
Sets the "java-class" property.void
setMatchAttribute(Collection<ValueOrExpression<AttributeType>> values)
Sets the "match-attribute" property.void
setMinSubstringLength(ValueOrExpression<Integer> value)
Sets the "min-substring-length" property.void
setTestReversedPassword(ValueOrExpression<Boolean> value)
Sets the "test-reversed-password" property.-
Methods inherited from interface org.forgerock.opendj.config.ConfigurationClient
commit, properties
-
Methods inherited from interface org.forgerock.opendj.server.config.client.PasswordValidatorCfgClient
isEnabled, setEnabled
-
-
-
-
Method Detail
-
definition
ManagedObjectDefinition<? extends AttributeValuePasswordValidatorCfgClient,? extends AttributeValuePasswordValidatorCfg> definition()
Get the configuration definition associated with this Attribute Value Password Validator.- Specified by:
definition
in interfaceConfigurationClient
- Specified by:
definition
in interfacePasswordValidatorCfgClient
- Returns:
- Returns the configuration definition associated with this Attribute Value Password Validator.
-
isCheckSubstrings
ValueOrExpression<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.
-
setCheckSubstrings
void setCheckSubstrings(ValueOrExpression<Boolean> value) throws PropertyException
Sets 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.
- Parameters:
value
- The value of the "check-substrings" property.- Throws:
PropertyException
- If the new value is invalid.
-
getJavaClass
@MandatoryProperty ValueOrExpression<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 interfacePasswordValidatorCfgClient
- Returns:
- Returns the value of the "java-class" property.
-
setJavaClass
@MandatoryProperty void setJavaClass(ValueOrExpression<String> value) throws PropertyException
Sets the "java-class" property.Specifies the fully-qualified name of the Java class that provides the password validator implementation.
- Specified by:
setJavaClass
in interfacePasswordValidatorCfgClient
- Parameters:
value
- The value of the "java-class" property.- Throws:
PropertyException
- If the new value is invalid.
-
getMatchAttribute
SortedSet<ValueOrExpression<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 the values of the "match-attribute" property.
-
setMatchAttribute
void setMatchAttribute(Collection<ValueOrExpression<AttributeType>> values) throws PropertyException
Sets 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.
- Parameters:
values
- The values of the "match-attribute" property.- Throws:
PropertyException
- If one or more of the new values are invalid.
-
getMinSubstringLength
ValueOrExpression<Integer> 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.
-
setMinSubstringLength
void setMinSubstringLength(ValueOrExpression<Integer> value) throws PropertyException
Sets 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.
- Parameters:
value
- The value of the "min-substring-length" property.- Throws:
PropertyException
- If the new value is invalid.
-
isTestReversedPassword
@MandatoryProperty ValueOrExpression<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.
-
setTestReversedPassword
@MandatoryProperty void setTestReversedPassword(ValueOrExpression<Boolean> value) throws PropertyException
Sets 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.
- Parameters:
value
- The value of the "test-reversed-password" property.- Throws:
PropertyException
- If the new value is invalid.
-
-