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

All Superinterfaces:
ConfigurationClient, PasswordValidatorCfgClient

public interface CharacterSetPasswordValidatorCfgClient
extends PasswordValidatorCfgClient

A client-side interface for reading and modifying Character Set Password Validator settings.

The Character Set Password Validator determines whether a proposed password is acceptable by checking whether it contains a sufficient number of characters from one or more user-defined character sets.


Method Summary
 ManagedObjectDefinition<? extends CharacterSetPasswordValidatorCfgClient,? extends CharacterSetPasswordValidatorCfg> definition()
          Get the configuration definition associated with this Character Set Password Validator.
 java.util.SortedSet<java.lang.String> getCharacterSet()
          Gets the "character-set" property.
 java.lang.String getJavaClass()
          Gets the "java-class" property.
 java.lang.Boolean isAllowUnclassifiedCharacters()
          Gets the "allow-unclassified-characters" property.
 void setAllowUnclassifiedCharacters(boolean value)
          Sets the "allow-unclassified-characters" property.
 void setCharacterSet(java.util.Collection<java.lang.String> values)
          Sets the "character-set" property.
 void setJavaClass(java.lang.String value)
          Sets the "java-class" 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 CharacterSetPasswordValidatorCfgClient,? extends CharacterSetPasswordValidatorCfg> definition()
Get the configuration definition associated with this Character Set Password Validator.

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

isAllowUnclassifiedCharacters

java.lang.Boolean isAllowUnclassifiedCharacters()
Gets the "allow-unclassified-characters" property.

Indicates whether this password validator allows passwords to contain characters outside of any of the user-defined character sets.

If this is "false", then only those characters in the user-defined character sets may be used in passwords. Any password containing a character not included in any character set will be rejected.

Returns:
Returns the value of the "allow-unclassified-characters" property.

setAllowUnclassifiedCharacters

void setAllowUnclassifiedCharacters(boolean value)
                                    throws IllegalPropertyValueException
Sets the "allow-unclassified-characters" property.

Indicates whether this password validator allows passwords to contain characters outside of any of the user-defined character sets.

If this is "false", then only those characters in the user-defined character sets may be used in passwords. Any password containing a character not included in any character set will be rejected.

Parameters:
value - The value of the "allow-unclassified-characters" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.

getCharacterSet

java.util.SortedSet<java.lang.String> getCharacterSet()
Gets the "character-set" property.

Specifies a character set containing characters that a password may contain and a value indicating the minimum number of characters required from that set.

Each value must be an integer (indicating the minimum required characters from the set) followed by a colon and the characters to include in that set (for example, "3:abcdefghijklmnopqrstuvwxyz" indicates that a user password must contain at least three characters from the set of lowercase ASCII letters). Multiple character sets can be defined in separate values, although no character can appear in more than one character set.

Returns:
Returns the values of the "character-set" property.

setCharacterSet

void setCharacterSet(java.util.Collection<java.lang.String> values)
                     throws IllegalPropertyValueException
Sets the "character-set" property.

Specifies a character set containing characters that a password may contain and a value indicating the minimum number of characters required from that set.

Each value must be an integer (indicating the minimum required characters from the set) followed by a colon and the characters to include in that set (for example, "3:abcdefghijklmnopqrstuvwxyz" indicates that a user password must contain at least three characters from the set of lowercase ASCII letters). Multiple character sets can be defined in separate values, although no character can appear in more than one character set.

Parameters:
values - The values of the "character-set" property.
Throws:
IllegalPropertyValueException - If one or more of the new values are 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.