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

Class LengthBasedPasswordValidatorCfgDefn

java.lang.Object

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

org.forgerock.opendj.config.ManagedObjectDefinition<LengthBasedPasswordValidatorCfgClient,LengthBasedPasswordValidatorCfg>

org.forgerock.opendj.server.config.meta.LengthBasedPasswordValidatorCfgDefn

public final class LengthBasedPasswordValidatorCfgDefn
extends ManagedObjectDefinition<LengthBasedPasswordValidatorCfgClient,LengthBasedPasswordValidatorCfg>

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

The Length Based Password Validator is used to determine whether a proposed password is acceptable based on whether the number of characters it contains falls within an acceptable range of values.

Method Summary

Modifier and Type	Method	Description
LengthBasedPasswordValidatorCfgClient	createClientConfiguration(ManagedObject<? extends LengthBasedPasswordValidatorCfgClient> impl)	Creates a client configuration view of the provided managed object.
LengthBasedPasswordValidatorCfg	createServerConfiguration(ServerManagedObject<? extends LengthBasedPasswordValidatorCfg> impl)	Creates a server configuration view of the provided server managed object.
BooleanPropertyDefinition	getEnabledPropertyDefinition()	Get the "enabled" property definition.
static LengthBasedPasswordValidatorCfgDefn	getInstance()	Get the Length Based Password Validator configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
IntegerPropertyDefinition	getMaxPasswordLengthPropertyDefinition()	Get the "max-password-length" property definition.
IntegerPropertyDefinition	getMinPasswordLengthPropertyDefinition()	Get the "min-password-length" property definition.
Class<LengthBasedPasswordValidatorCfg>	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 LengthBasedPasswordValidatorCfgDefn getInstance()

Get the Length Based Password Validator configuration definition singleton.

Returns:

Returns the Length Based Password Validator configuration definition singleton.

createClientConfiguration

public LengthBasedPasswordValidatorCfgClient createClientConfiguration(ManagedObject<? extends LengthBasedPasswordValidatorCfgClient> 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<LengthBasedPasswordValidatorCfgClient,LengthBasedPasswordValidatorCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<LengthBasedPasswordValidatorCfgClient,LengthBasedPasswordValidatorCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public Class<LengthBasedPasswordValidatorCfg> getServerConfigurationClass()

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<LengthBasedPasswordValidatorCfgClient,LengthBasedPasswordValidatorCfg>

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.

getMaxPasswordLengthPropertyDefinition

public IntegerPropertyDefinition getMaxPasswordLengthPropertyDefinition()

Get the "max-password-length" property definition.

Specifies the maximum number of characters that can be included in a proposed password.

A value of zero indicates that there will be no upper bound enforced. If both minimum and maximum lengths are defined, then the minimum length must be less than or equal to the maximum length.

Returns:

Returns the "max-password-length" property definition.

getMinPasswordLengthPropertyDefinition

public IntegerPropertyDefinition getMinPasswordLengthPropertyDefinition()

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

Specifies the minimum number of characters that must be included in a proposed password.

A value of zero indicates that there will be no lower bound enforced. If both minimum and maximum lengths are defined, then the minimum length must be less than or equal to the maximum length.

Returns:

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