Package org.forgerock.opendj.server.config.meta

Class SimilarityBasedPasswordValidatorCfgDefn

java.lang.Object

org.forgerock.opendj.config.AbstractManagedObjectDefinition<C,S>

org.forgerock.opendj.config.ManagedObjectDefinition<SimilarityBasedPasswordValidatorCfgClient,SimilarityBasedPasswordValidatorCfg>

org.forgerock.opendj.server.config.meta.SimilarityBasedPasswordValidatorCfgDefn

public final class SimilarityBasedPasswordValidatorCfgDefn
extends ManagedObjectDefinition<SimilarityBasedPasswordValidatorCfgClient,SimilarityBasedPasswordValidatorCfg>

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

The Similarity Based Password Validator determines whether a proposed password is acceptable by measuring how similar it is to the user's current password.

Method Summary

Modifier and Type	Method	Description
SimilarityBasedPasswordValidatorCfgClient	createClientConfiguration(ManagedObject<? extends SimilarityBasedPasswordValidatorCfgClient> impl)	Creates a client configuration view of the provided managed object.
SimilarityBasedPasswordValidatorCfg	createServerConfiguration(ServerManagedObject<? extends SimilarityBasedPasswordValidatorCfg> impl)	Creates a server configuration view of the provided server managed object.
BooleanPropertyDefinition	getEnabledPropertyDefinition()	Get the "enabled" property definition.
static SimilarityBasedPasswordValidatorCfgDefn	getInstance()	Get the Similarity Based Password Validator configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
IntegerPropertyDefinition	getMinPasswordDifferencePropertyDefinition()	Get the "min-password-difference" property definition.
Class<SimilarityBasedPasswordValidatorCfg>	getServerConfigurationClass()	Gets the server configuration class instance associated with this managed object definition.

Methods inherited from class org.forgerock.opendj.config.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 SimilarityBasedPasswordValidatorCfgDefn getInstance()

Get the Similarity Based Password Validator configuration definition singleton.

Returns:

Returns the Similarity Based Password Validator configuration definition singleton.

createClientConfiguration

public SimilarityBasedPasswordValidatorCfgClient createClientConfiguration(ManagedObject<? extends SimilarityBasedPasswordValidatorCfgClient> 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<SimilarityBasedPasswordValidatorCfgClient,SimilarityBasedPasswordValidatorCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<SimilarityBasedPasswordValidatorCfgClient,SimilarityBasedPasswordValidatorCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public Class<SimilarityBasedPasswordValidatorCfg> getServerConfigurationClass()

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<SimilarityBasedPasswordValidatorCfgClient,SimilarityBasedPasswordValidatorCfg>

Returns:

Returns the server configuration class instance associated with this managed object 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.

getMinPasswordDifferencePropertyDefinition

public IntegerPropertyDefinition getMinPasswordDifferencePropertyDefinition()

Get the "min-password-difference" property definition.

Specifies the minimum difference of new and old password.

A value of zero indicates that no difference between passwords is acceptable.

Returns:

Returns the "min-password-difference" property definition.