org.opends.server.admin.std.client
Interface DictionaryPasswordValidatorCfgClient

All Superinterfaces:
ConfigurationClient, PasswordValidatorCfgClient

public interface DictionaryPasswordValidatorCfgClient
extends PasswordValidatorCfgClient

A client-side interface for reading and modifying 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
 ManagedObjectDefinition<? extends DictionaryPasswordValidatorCfgClient,? extends DictionaryPasswordValidatorCfg> definition()
          Get the configuration definition 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 setCaseSensitiveValidation(boolean value)
          Sets the "case-sensitive-validation" property.
 void setDictionaryFile(java.lang.String value)
          Sets the "dictionary-file" property.
 void setJavaClass(java.lang.String value)
          Sets the "java-class" property.
 void setTestReversedPassword(boolean value)
          Sets the "test-reversed-password" property.
 
Methods inherited from interface org.opends.server.admin.std.client.PasswordValidatorCfgClient
isEnabled, setEnabled
 
Methods inherited from interface org.opends.server.admin.ConfigurationClient
commit, properties
 

Method Detail

definition

ManagedObjectDefinition<? extends DictionaryPasswordValidatorCfgClient,? extends DictionaryPasswordValidatorCfg> definition()
Get the configuration definition associated with this Dictionary Password Validator.

Specified by:
definition in interface ConfigurationClient
Specified by:
definition in interface PasswordValidatorCfgClient
Returns:
Returns the configuration definition associated with this Dictionary Password Validator.

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.

setCaseSensitiveValidation

void setCaseSensitiveValidation(boolean value)
                                throws IllegalPropertyValueException
Sets 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.

Parameters:
value - The value of the "case-sensitive-validation" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.

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.

setDictionaryFile

void setDictionaryFile(java.lang.String value)
                       throws IllegalPropertyValueException
Sets 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.

Parameters:
value - The value of the "dictionary-file" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.

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 PasswordValidatorCfgClient
Returns:
Returns the value of the "java-class" property.

setJavaClass

void setJavaClass(java.lang.String value)
                  throws IllegalPropertyValueException
Sets the "java-class" property.

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

Specified by:
setJavaClass in interface PasswordValidatorCfgClient
Parameters:
value - The value of the "java-class" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.

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.

setTestReversedPassword

void setTestReversedPassword(boolean value)
                             throws IllegalPropertyValueException
Sets 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.

Parameters:
value - The value of the "test-reversed-password" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.