Package org.forgerock.opendj.server.config.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

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends DictionaryPasswordValidatorCfgClient,? extends DictionaryPasswordValidatorCfg>	definition()	Get the configuration definition associated with this Dictionary Password Validator.
String	getDictionaryFile()	Gets the "dictionary-file" property.
String	getJavaClass()	Gets the "java-class" property.
int	getMinSubstringLength()	Gets the "min-substring-length" property.
boolean	isCaseSensitiveValidation()	Gets the "case-sensitive-validation" property.
boolean	isCheckSubstrings()	Gets the "check-substrings" property.
boolean	isTestReversedPassword()	Gets the "test-reversed-password" property.
void	setCaseSensitiveValidation(boolean value)	Sets the "case-sensitive-validation" property.
void	setCheckSubstrings(Boolean value)	Sets the "check-substrings" property.
void	setDictionaryFile(String value)	Sets the "dictionary-file" property.
void	setJavaClass(String value)	Sets the "java-class" property.
void	setMinSubstringLength(Integer value)	Sets the "min-substring-length" property.
void	setTestReversedPassword(boolean value)	Sets the "test-reversed-password" property.

Methods inherited from interface org.forgerock.opendj.config.ConfigurationClient

commit, properties

Methods inherited from interface org.forgerock.opendj.server.config.client.PasswordValidatorCfgClient

isEnabled, setEnabled

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 PropertyException

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:

PropertyException - If the new value is invalid.

isCheckSubstrings

boolean isCheckSubstrings()

Gets the "check-substrings" property.

Indicates whether this password validator is to match portions of the password string against dictionary words.

If "false" then only match the entire password against words otherwise ("true") check whether the password contains words.

Returns:

Returns the value of the "check-substrings" property.

setCheckSubstrings

void setCheckSubstrings(Boolean value)
                 throws PropertyException

Sets the "check-substrings" property.

Indicates whether this password validator is to match portions of the password string against dictionary words.

If "false" then only match the entire password against words otherwise ("true") check whether the password contains words.

Parameters:

value - The value of the "check-substrings" property.

Throws:

PropertyException - If the new value is invalid.

getDictionaryFile

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 OpenDJ instance root.

Returns:

Returns the value of the "dictionary-file" property.

setDictionaryFile

void setDictionaryFile(String value)
                throws PropertyException

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 OpenDJ instance root.

Parameters:

value - The value of the "dictionary-file" property.

Throws:

PropertyException - If the new value is invalid.

getJavaClass

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(String value)
           throws PropertyException

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:

PropertyException - If the new value is invalid.

getMinSubstringLength

int getMinSubstringLength()

Gets the "min-substring-length" property.

Indicates the minimal length of the substring within the password in case substring checking is enabled.

If "check-substrings" option is set to true, then this parameter defines the length of the smallest word which should be used for substring matching. Use with caution because values below 3 might disqualify valid passwords.

Returns:

Returns the value of the "min-substring-length" property.

setMinSubstringLength

void setMinSubstringLength(Integer value)
                    throws PropertyException

Sets the "min-substring-length" property.

Indicates the minimal length of the substring within the password in case substring checking is enabled.

If "check-substrings" option is set to true, then this parameter defines the length of the smallest word which should be used for substring matching. Use with caution because values below 3 might disqualify valid passwords.

Parameters:

value - The value of the "min-substring-length" property.

Throws:

PropertyException - 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 PropertyException

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:

PropertyException - If the new value is invalid.