org.opends.server.admin.std.server
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.


Method Summary
 void addCharacterSetChangeListener(ConfigurationChangeListener<CharacterSetPasswordValidatorCfg> listener)
          Register to be notified when this Character Set Password Validator is changed.
 java.lang.Class<? extends CharacterSetPasswordValidatorCfg> configurationClass()
          Gets the configuration class associated with this Character Set Password Validator.
 java.util.SortedSet<java.lang.String> getCharacterSet()
          Gets the "character-set" property.
 java.lang.String getJavaClass()
          Gets the "java-class" 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.opends.server.admin.std.server.PasswordValidatorCfg
addChangeListener, isEnabled, removeChangeListener
 
Methods inherited from interface org.opends.server.admin.Configuration
dn
 

Method Detail

configurationClass

java.lang.Class<? extends CharacterSetPasswordValidatorCfg> configurationClass()
Gets the configuration class associated with this Character Set Password Validator.

Specified by:
configurationClass in interface Configuration
Specified by:
configurationClass in interface PasswordValidatorCfg
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.

If this is "false", then only those characters in the user-defined character sets may be used in passwords. Any password containing a character not included in any character set will be rejected.

Returns:
Returns the value of the "allow-unclassified-characters" property.

getCharacterSet

java.util.SortedSet<java.lang.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) 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.

getJavaClass

java.lang.String getJavaClass()
Gets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the password validator implementation.

Specified by:
getJavaClass in interface PasswordValidatorCfg
Returns:
Returns the value of the "java-class" property.