org.opends.server.admin.std.meta

Class CharacterSetPasswordValidatorCfgDefn

java.lang.Object

org.opends.server.admin.AbstractManagedObjectDefinition<C,S>

org.opends.server.admin.ManagedObjectDefinition<CharacterSetPasswordValidatorCfgClient,CharacterSetPasswordValidatorCfg>

org.opends.server.admin.std.meta.CharacterSetPasswordValidatorCfgDefn

public final class CharacterSetPasswordValidatorCfgDefn
extends ManagedObjectDefinition<CharacterSetPasswordValidatorCfgClient,CharacterSetPasswordValidatorCfg>

An interface for querying the Character Set Password Validator managed object definition meta information.

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 and ranges.

Method Summary

Methods

Modifier and Type	Method and Description
CharacterSetPasswordValidatorCfgClient	createClientConfiguration(ManagedObject<? extends CharacterSetPasswordValidatorCfgClient> impl) Creates a client configuration view of the provided managed object.
CharacterSetPasswordValidatorCfg	createServerConfiguration(ServerManagedObject<? extends CharacterSetPasswordValidatorCfg> impl) Creates a server configuration view of the provided server managed object.
BooleanPropertyDefinition	getAllowUnclassifiedCharactersPropertyDefinition() Get the "allow-unclassified-characters" property definition.
StringPropertyDefinition	getCharacterSetPropertyDefinition() Get the "character-set" property definition.
StringPropertyDefinition	getCharacterSetRangesPropertyDefinition() Get the "character-set-ranges" property definition.
BooleanPropertyDefinition	getEnabledPropertyDefinition() Get the "enabled" property definition.
static CharacterSetPasswordValidatorCfgDefn	getInstance() Get the Character Set Password Validator configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition() Get the "java-class" property definition.
IntegerPropertyDefinition	getMinCharacterSetsPropertyDefinition() Get the "min-character-sets" property definition.
Class<CharacterSetPasswordValidatorCfg>	getServerConfigurationClass() Gets the server configuration class instance associated with this managed object definition.

Methods inherited from class org.opends.server.admin.AbstractManagedObjectDefinition

getAggregationPropertyDefinition, getAggregationPropertyDefinitions, getAllAggregationPropertyDefinitions, getAllChildren, getAllConstraints, getAllPropertyDefinitions, getAllRelationDefinitions, getAllReverseAggregationPropertyDefinitions, getAllReverseRelationDefinitions, getAllTags, getChild, getChildren, getConstraints, getDescription, getDescription, getName, getParent, getPropertyDefinition, getPropertyDefinitions, getRelationDefinition, getRelationDefinitions, getReverseAggregationPropertyDefinitions, getReverseRelationDefinitions, getSynopsis, getSynopsis, getUserFriendlyName, getUserFriendlyName, getUserFriendlyPluralName, getUserFriendlyPluralName, hasChildren, hasOption, hasTag, initialize, isChildOf, isParentOf, isTop, registerConstraint, registerOption, registerPropertyDefinition, registerRelationDefinition, registerTag, resolveManagedObjectDefinition, toString, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getInstance

public static CharacterSetPasswordValidatorCfgDefn getInstance()

Get the Character Set Password Validator configuration definition singleton.

Returns:

Returns the Character Set Password Validator configuration definition singleton.

createClientConfiguration

public CharacterSetPasswordValidatorCfgClient createClientConfiguration(ManagedObject<? extends CharacterSetPasswordValidatorCfgClient> impl)

Creates a client configuration view of the provided managed object. Modifications made to the underlying managed object will be reflected in the client configuration view and vice versa.

Specified by:

createClientConfiguration in class ManagedObjectDefinition<CharacterSetPasswordValidatorCfgClient,CharacterSetPasswordValidatorCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

public CharacterSetPasswordValidatorCfg createServerConfiguration(ServerManagedObject<? extends CharacterSetPasswordValidatorCfg> impl)

Creates a server configuration view of the provided server managed object.

Specified by:

createServerConfiguration in class ManagedObjectDefinition<CharacterSetPasswordValidatorCfgClient,CharacterSetPasswordValidatorCfg>

Parameters:

impl - The server managed object.

Returns:

Returns a server configuration view of the provided server managed object.

getServerConfigurationClass

public Class<CharacterSetPasswordValidatorCfg> getServerConfigurationClass()

Gets the server configuration class instance associated with this managed object definition.

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<CharacterSetPasswordValidatorCfgClient,CharacterSetPasswordValidatorCfg>

Returns:

Returns the server configuration class instance associated with this managed object definition.

getAllowUnclassifiedCharactersPropertyDefinition

public BooleanPropertyDefinition getAllowUnclassifiedCharactersPropertyDefinition()

Get the "allow-unclassified-characters" property definition.

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

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

Returns:

Returns the "allow-unclassified-characters" property definition.

getCharacterSetPropertyDefinition

public StringPropertyDefinition getCharacterSetPropertyDefinition()

Get the "character-set" property definition.

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 which may be zero, indicating that the character set is optional) 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 "character-set" property definition.

getCharacterSetRangesPropertyDefinition

public StringPropertyDefinition getCharacterSetRangesPropertyDefinition()

Get the "character-set-ranges" property definition.

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

Each value must be an integer (indicating the minimum required characters from the range which may be zero, indicating that the character range is optional) followed by a colon and one or more range specifications. A range specification is 3 characters: the first character allowed, a minus, and the last character allowed. For example, "3:A-Za-z0-9". The ranges in each value should not overlap, and the characters in each range specification should be ordered.

Returns:

Returns the "character-set-ranges" property definition.

getEnabledPropertyDefinition

public BooleanPropertyDefinition getEnabledPropertyDefinition()

Get the "enabled" property definition.

Indicates whether the password validator is enabled for use.

Returns:

Returns the "enabled" property definition.

getJavaClassPropertyDefinition

public ClassPropertyDefinition getJavaClassPropertyDefinition()

Get the "java-class" property definition.

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

Returns:

Returns the "java-class" property definition.

getMinCharacterSetsPropertyDefinition

public IntegerPropertyDefinition getMinCharacterSetsPropertyDefinition()

Get the "min-character-sets" property definition.

Specifies the minimum number of character sets and ranges that a password must contain.

This property should only be used in conjunction with optional character sets and ranges (those requiring zero characters). Its value must include any mandatory character sets and ranges (those requiring greater than zero characters). This is useful in situations where a password must contain characters from mandatory character sets and ranges, and characters from at least N optional character sets and ranges. For example, it is quite common to require that a password contains at least one non-alphanumeric character as well as characters from two alphanumeric character sets (lower-case, upper-case, digits). In this case, this property should be set to 3.

Returns:

Returns the "min-character-sets" property definition.