org.opends.server.admin.std.client

Interface AttributeValuePasswordValidatorCfgClient

All Superinterfaces:

ConfigurationClient, PasswordValidatorCfgClient

public interface AttributeValuePasswordValidatorCfgClient
extends PasswordValidatorCfgClient

A client-side interface for reading and modifying Attribute Value Password Validator settings.

The Attribute Value Password Validator attempts to determine whether a proposed password is acceptable for use by determining whether that password is contained in any attribute within the user's entry.

Method Summary

Methods

Modifier and Type	Method and Description
ManagedObjectDefinition<? extends AttributeValuePasswordValidatorCfgClient,? extends AttributeValuePasswordValidatorCfg>	definition() Get the configuration definition associated with this Attribute Value Password Validator.
String	getJavaClass() Gets the "java-class" property.
SortedSet<AttributeType>	getMatchAttribute() Gets the "match-attribute" property.
int	getMinSubstringLength() Gets the "min-substring-length" property.
boolean	isCheckSubstrings() Gets the "check-substrings" property.
Boolean	isTestReversedPassword() Gets the "test-reversed-password" property.
void	setCheckSubstrings(Boolean value) Sets the "check-substrings" property.
void	setJavaClass(String value) Sets the "java-class" property.
void	setMatchAttribute(Collection<AttributeType> values) Sets the "match-attribute" 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.opends.server.admin.std.client.PasswordValidatorCfgClient

isEnabled, setEnabled

Methods inherited from interface org.opends.server.admin.ConfigurationClient

commit, properties

Method Detail

definition

ManagedObjectDefinition<? extends AttributeValuePasswordValidatorCfgClient,? extends AttributeValuePasswordValidatorCfg> definition()

Get the configuration definition associated with this Attribute Value Password Validator.

Specified by:

definition in interface ConfigurationClient

Specified by:

definition in interface PasswordValidatorCfgClient

Returns:

Returns the configuration definition associated with this Attribute Value Password Validator.

isCheckSubstrings

boolean isCheckSubstrings()

Gets the "check-substrings" property.

Indicates whether this password validator is to match portions of the password string against attribute values.

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

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 attribute values.

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

Parameters:

value - The value of the "check-substrings" 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.

getMatchAttribute

SortedSet<AttributeType> getMatchAttribute()

Gets the "match-attribute" property.

Specifies the name(s) of the attribute(s) whose values should be checked to determine whether they match the provided password. If no values are provided, then the server checks if the proposed password matches the value of any attribute in the user's entry.

Returns:

Returns the values of the "match-attribute" property.

setMatchAttribute

void setMatchAttribute(Collection<AttributeType> values)
                       throws PropertyException

Sets the "match-attribute" property.

Specifies the name(s) of the attribute(s) whose values should be checked to determine whether they match the provided password. If no values are provided, then the server checks if the proposed password matches the value of any attribute in the user's entry.

Parameters:

values - The values of the "match-attribute" property.

Throws:

PropertyException - If one or more of the new values are 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 should test the reversed value of the provided password as well as the order in which it was given.

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 should test the reversed value of the provided password as well as the order in which it was given.

Parameters:

value - The value of the "test-reversed-password" property.

Throws:

PropertyException - If the new value is invalid.