org.opends.server.admin.std.server
Interface DictionaryPasswordValidatorCfg

All Superinterfaces:
Configuration, PasswordValidatorCfg

public interface DictionaryPasswordValidatorCfg
extends PasswordValidatorCfg

A server-side interface for querying Dictionary Password Validator settings.

The Dictionary Password Validator determines whether a proposed password is acceptable based on whether the given password value appears in a provided dictionary file.


Method Summary
 void addDictionaryChangeListener(ConfigurationChangeListener<DictionaryPasswordValidatorCfg> listener)
          Register to be notified when this Dictionary Password Validator is changed.
 java.lang.Class<? extends DictionaryPasswordValidatorCfg> configurationClass()
          Gets the configuration class associated with this Dictionary Password Validator.
 java.lang.String getDictionaryFile()
          Gets the "dictionary-file" property.
 java.lang.String getJavaClass()
          Gets the "java-class" property.
 boolean isCaseSensitiveValidation()
          Gets the "case-sensitive-validation" property.
 boolean isTestReversedPassword()
          Gets the "test-reversed-password" property.
 void removeDictionaryChangeListener(ConfigurationChangeListener<DictionaryPasswordValidatorCfg> listener)
          Deregister an existing Dictionary 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 DictionaryPasswordValidatorCfg> configurationClass()
Gets the configuration class associated with this Dictionary Password Validator.

Specified by:
configurationClass in interface Configuration
Specified by:
configurationClass in interface PasswordValidatorCfg
Returns:
Returns the configuration class associated with this Dictionary Password Validator.

addDictionaryChangeListener

void addDictionaryChangeListener(ConfigurationChangeListener<DictionaryPasswordValidatorCfg> listener)
Register to be notified when this Dictionary Password Validator is changed.

Parameters:
listener - The Dictionary Password Validator configuration change listener.

removeDictionaryChangeListener

void removeDictionaryChangeListener(ConfigurationChangeListener<DictionaryPasswordValidatorCfg> listener)
Deregister an existing Dictionary Password Validator configuration change listener.

Parameters:
listener - The Dictionary Password Validator configuration change listener.

isCaseSensitiveValidation

boolean isCaseSensitiveValidation()
Gets the "case-sensitive-validation" property.

Indicates whether this password validator is to treat password characters in a case-sensitive manner.

If it is set to true, then the validator rejects a password only if it appears in the dictionary with exactly the same capitalization as provided by the user.

Returns:
Returns the value of the "case-sensitive-validation" property.

getDictionaryFile

java.lang.String getDictionaryFile()
Gets the "dictionary-file" property.

Specifies the path to the file containing a list of words that cannot be used as passwords.

It should be formatted with one word per line. The value can be an absolute path or a path that is relative to the OpenDS Directory Server instance root.

Returns:
Returns the value of the "dictionary-file" 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.

isTestReversedPassword

boolean isTestReversedPassword()
Gets the "test-reversed-password" property.

Indicates whether this password validator is to test the reversed value of the provided password as well as the order in which it was given.

For example, if the user provides a new password of "password" and this configuration attribute is set to true, then the value "drowssap" is also tested against attribute values in the user's entry.

Returns:
Returns the value of the "test-reversed-password" property.