org.opends.server.admin.std.meta

Class DictionaryPasswordValidatorCfgDefn

java.lang.Object

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

org.opends.server.admin.ManagedObjectDefinition<DictionaryPasswordValidatorCfgClient,DictionaryPasswordValidatorCfg>

org.opends.server.admin.std.meta.DictionaryPasswordValidatorCfgDefn

public final class DictionaryPasswordValidatorCfgDefn
extends ManagedObjectDefinition<DictionaryPasswordValidatorCfgClient,DictionaryPasswordValidatorCfg>

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

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

Methods

Modifier and Type	Method and Description
DictionaryPasswordValidatorCfgClient	createClientConfiguration(ManagedObject<? extends DictionaryPasswordValidatorCfgClient> impl) Creates a client configuration view of the provided managed object.
DictionaryPasswordValidatorCfg	createServerConfiguration(ServerManagedObject<? extends DictionaryPasswordValidatorCfg> impl) Creates a server configuration view of the provided server managed object.
BooleanPropertyDefinition	getCaseSensitiveValidationPropertyDefinition() Get the "case-sensitive-validation" property definition.
BooleanPropertyDefinition	getCheckSubstringsPropertyDefinition() Get the "check-substrings" property definition.
StringPropertyDefinition	getDictionaryFilePropertyDefinition() Get the "dictionary-file" property definition.
BooleanPropertyDefinition	getEnabledPropertyDefinition() Get the "enabled" property definition.
static DictionaryPasswordValidatorCfgDefn	getInstance() Get the Dictionary Password Validator configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition() Get the "java-class" property definition.
IntegerPropertyDefinition	getMinSubstringLengthPropertyDefinition() Get the "min-substring-length" property definition.
Class<DictionaryPasswordValidatorCfg>	getServerConfigurationClass() Gets the server configuration class instance associated with this managed object definition.
BooleanPropertyDefinition	getTestReversedPasswordPropertyDefinition() Get the "test-reversed-password" property 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 DictionaryPasswordValidatorCfgDefn getInstance()

Get the Dictionary Password Validator configuration definition singleton.

Returns:

Returns the Dictionary Password Validator configuration definition singleton.

createClientConfiguration

public DictionaryPasswordValidatorCfgClient createClientConfiguration(ManagedObject<? extends DictionaryPasswordValidatorCfgClient> 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<DictionaryPasswordValidatorCfgClient,DictionaryPasswordValidatorCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<DictionaryPasswordValidatorCfgClient,DictionaryPasswordValidatorCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public Class<DictionaryPasswordValidatorCfg> getServerConfigurationClass()

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<DictionaryPasswordValidatorCfgClient,DictionaryPasswordValidatorCfg>

Returns:

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

getCaseSensitiveValidationPropertyDefinition

public BooleanPropertyDefinition getCaseSensitiveValidationPropertyDefinition()

Get the "case-sensitive-validation" property definition.

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 "case-sensitive-validation" property definition.

getCheckSubstringsPropertyDefinition

public BooleanPropertyDefinition getCheckSubstringsPropertyDefinition()

Get the "check-substrings" property definition.

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 "check-substrings" property definition.

getDictionaryFilePropertyDefinition

public StringPropertyDefinition getDictionaryFilePropertyDefinition()

Get the "dictionary-file" property definition.

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 "dictionary-file" 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.

getMinSubstringLengthPropertyDefinition

public IntegerPropertyDefinition getMinSubstringLengthPropertyDefinition()

Get the "min-substring-length" property definition.

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 "min-substring-length" property definition.

getTestReversedPasswordPropertyDefinition

public BooleanPropertyDefinition getTestReversedPasswordPropertyDefinition()

Get the "test-reversed-password" property definition.

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 "test-reversed-password" property definition.