public interface CharacterSetPasswordValidatorCfgClient extends PasswordValidatorCfgClient
The Character Set Password Validator determines whether a proposed password is acceptable by checking whether it contains a sufficient number of characters from one or more user-defined character sets and ranges.
| Modifier and Type | Method and Description |
|---|---|
ManagedObjectDefinition<? extends CharacterSetPasswordValidatorCfgClient,? extends CharacterSetPasswordValidatorCfg> |
definition()
Get the configuration definition associated with this Character Set Password Validator.
|
SortedSet<String> |
getCharacterSet()
Gets the "character-set" property.
|
SortedSet<String> |
getCharacterSetRanges()
Gets the "character-set-ranges" property.
|
String |
getJavaClass()
Gets the "java-class" property.
|
Integer |
getMinCharacterSets()
Gets the "min-character-sets" property.
|
Boolean |
isAllowUnclassifiedCharacters()
Gets the "allow-unclassified-characters" property.
|
void |
setAllowUnclassifiedCharacters(boolean value)
Sets the "allow-unclassified-characters" property.
|
void |
setCharacterSet(Collection<String> values)
Sets the "character-set" property.
|
void |
setCharacterSetRanges(Collection<String> values)
Sets the "character-set-ranges" property.
|
void |
setJavaClass(String value)
Sets the "java-class" property.
|
void |
setMinCharacterSets(Integer value)
Sets the "min-character-sets" property.
|
isEnabled, setEnabledcommit, propertiesManagedObjectDefinition<? extends CharacterSetPasswordValidatorCfgClient,? extends CharacterSetPasswordValidatorCfg> definition()
definition in interface ConfigurationClientdefinition in interface PasswordValidatorCfgClientBoolean isAllowUnclassifiedCharacters()
Indicates whether this password validator allows passwords to contain characters outside of any of the user-defined character sets and ranges.
If this is "false", then only those characters in the user-defined character sets and ranges may be used in passwords. Any password containing a character not included in any character set or range will be rejected.
void setAllowUnclassifiedCharacters(boolean value) throws PropertyException
Indicates whether this password validator allows passwords to contain characters outside of any of the user-defined character sets and ranges.
If this is "false", then only those characters in the user-defined character sets and ranges may be used in passwords. Any password containing a character not included in any character set or range will be rejected.
value - The value of the "allow-unclassified-characters" property.PropertyException - If the new value is invalid.SortedSet<String> getCharacterSet()
Specifies a character set containing characters that a password may contain and a value indicating the minimum number of characters required from that set.
Each value must be an integer (indicating the minimum required characters from the set which may be zero, indicating that the character set is optional) followed by a colon and the characters to include in that set (for example, "3:abcdefghijklmnopqrstuvwxyz" indicates that a user password must contain at least three characters from the set of lowercase ASCII letters). Multiple character sets can be defined in separate values, although no character can appear in more than one character set.
void setCharacterSet(Collection<String> values) throws PropertyException
Specifies a character set containing characters that a password may contain and a value indicating the minimum number of characters required from that set.
Each value must be an integer (indicating the minimum required characters from the set which may be zero, indicating that the character set is optional) followed by a colon and the characters to include in that set (for example, "3:abcdefghijklmnopqrstuvwxyz" indicates that a user password must contain at least three characters from the set of lowercase ASCII letters). Multiple character sets can be defined in separate values, although no character can appear in more than one character set.
values - The values of the "character-set" property.PropertyException - If one or more of the new values are invalid.SortedSet<String> getCharacterSetRanges()
Specifies a character range containing characters that a password may contain and a value indicating the minimum number of characters required from that range.
Each value must be an integer (indicating the minimum required characters from the range which may be zero, indicating that the character range is optional) followed by a colon and one or more range specifications. A range specification is 3 characters: the first character allowed, a minus, and the last character allowed. For example, "3:A-Za-z0-9". The ranges in each value should not overlap, and the characters in each range specification should be ordered.
void setCharacterSetRanges(Collection<String> values) throws PropertyException
Specifies a character range containing characters that a password may contain and a value indicating the minimum number of characters required from that range.
Each value must be an integer (indicating the minimum required characters from the range which may be zero, indicating that the character range is optional) followed by a colon and one or more range specifications. A range specification is 3 characters: the first character allowed, a minus, and the last character allowed. For example, "3:A-Za-z0-9". The ranges in each value should not overlap, and the characters in each range specification should be ordered.
values - The values of the "character-set-ranges" property.PropertyException - If one or more of the new values are invalid.String getJavaClass()
Specifies the fully-qualified name of the Java class that provides the password validator implementation.
getJavaClass in interface PasswordValidatorCfgClientvoid setJavaClass(String value) throws PropertyException
Specifies the fully-qualified name of the Java class that provides the password validator implementation.
setJavaClass in interface PasswordValidatorCfgClientvalue - The value of the "java-class" property.PropertyException - If the new value is invalid.Integer getMinCharacterSets()
Specifies the minimum number of character sets and ranges that a password must contain.
This property should only be used in conjunction with optional character sets and ranges (those requiring zero characters). Its value must include any mandatory character sets and ranges (those requiring greater than zero characters). This is useful in situations where a password must contain characters from mandatory character sets and ranges, and characters from at least N optional character sets and ranges. For example, it is quite common to require that a password contains at least one non-alphanumeric character as well as characters from two alphanumeric character sets (lower-case, upper-case, digits). In this case, this property should be set to 3.
void setMinCharacterSets(Integer value) throws PropertyException
Specifies the minimum number of character sets and ranges that a password must contain.
This property should only be used in conjunction with optional character sets and ranges (those requiring zero characters). Its value must include any mandatory character sets and ranges (those requiring greater than zero characters). This is useful in situations where a password must contain characters from mandatory character sets and ranges, and characters from at least N optional character sets and ranges. For example, it is quite common to require that a password contains at least one non-alphanumeric character as well as characters from two alphanumeric character sets (lower-case, upper-case, digits). In this case, this property should be set to 3.
value - The value of the "min-character-sets" property.PropertyException - If the new value is invalid.Copyright © 2010-2016 ForgeRock AS. All Rights Reserved.