Interface CharacterSetPasswordValidatorCfg
-
- All Superinterfaces:
Configuration
,PasswordValidatorCfg
public interface CharacterSetPasswordValidatorCfg extends PasswordValidatorCfg
A server-side interface for querying Character Set Password Validator settings.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.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addCharacterSetChangeListener(ConfigurationChangeListener<CharacterSetPasswordValidatorCfg> listener)
Register to be notified when this Character Set Password Validator is changed.Class<? extends CharacterSetPasswordValidatorCfg>
configurationClass()
Gets the configuration class 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
removeCharacterSetChangeListener(ConfigurationChangeListener<CharacterSetPasswordValidatorCfg> listener)
Deregister an existing Character Set 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 CharacterSetPasswordValidatorCfg> configurationClass()
Gets the configuration class associated with this Character Set Password Validator.- Specified by:
configurationClass
in interfaceConfiguration
- Specified by:
configurationClass
in interfacePasswordValidatorCfg
- Returns:
- Returns the configuration class associated with this Character Set Password Validator.
-
addCharacterSetChangeListener
void addCharacterSetChangeListener(ConfigurationChangeListener<CharacterSetPasswordValidatorCfg> listener)
Register to be notified when this Character Set Password Validator is changed.- Parameters:
listener
- The Character Set Password Validator configuration change listener.
-
removeCharacterSetChangeListener
void removeCharacterSetChangeListener(ConfigurationChangeListener<CharacterSetPasswordValidatorCfg> listener)
Deregister an existing Character Set Password Validator configuration change listener.- Parameters:
listener
- The Character Set Password Validator configuration change listener.
-
isAllowUnclassifiedCharacters
boolean isAllowUnclassifiedCharacters()
Gets the "allow-unclassified-characters" property.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.
- Returns:
- Returns the value of the "allow-unclassified-characters" property.
-
getCharacterSet
SortedSet<String> getCharacterSet()
Gets the "character-set" property.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.
- Returns:
- Returns an unmodifiable set containing the values of the "character-set" property.
-
getCharacterSetRanges
SortedSet<String> getCharacterSetRanges()
Gets the "character-set-ranges" property.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.
- Returns:
- Returns an unmodifiable set containing the values of the "character-set-ranges" 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.CharacterSetPasswordValidator
- Specified by:
getJavaClass
in interfacePasswordValidatorCfg
- Returns:
- Returns the value of the "java-class" property.
-
getMinCharacterSets
Integer getMinCharacterSets()
Gets the "min-character-sets" property.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.
- Returns:
- Returns the value of the "min-character-sets" property.
-
-