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
 ManagedObjectDefinition<? extends AttributeValuePasswordValidatorCfgClient,? extends AttributeValuePasswordValidatorCfg> definition()
          Get the configuration definition associated with this Attribute Value Password Validator.
 java.lang.String getJavaClass()
          Gets the "java-class" property.
 java.util.SortedSet<AttributeType> getMatchAttribute()
          Gets the "match-attribute" property.
 java.lang.Boolean isTestReversedPassword()
          Gets the "test-reversed-password" property.
 void setJavaClass(java.lang.String value)
          Sets the "java-class" property.
 void setMatchAttribute(java.util.Collection<AttributeType> values)
          Sets the "match-attribute" 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.

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.

getMatchAttribute

java.util.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(java.util.Collection<AttributeType> values)
                       throws IllegalPropertyValueException
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:
IllegalPropertyValueException - If one or more of the new values are invalid.

isTestReversedPassword

java.lang.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 IllegalPropertyValueException
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:
IllegalPropertyValueException - If the new value is invalid.