Class AttributeValuePasswordValidatorCfgDefn
- java.lang.Object
-
- org.forgerock.opendj.config.AbstractManagedObjectDefinition<C,S>
-
- org.forgerock.opendj.config.ManagedObjectDefinition<AttributeValuePasswordValidatorCfgClient,AttributeValuePasswordValidatorCfg>
-
- org.forgerock.opendj.server.config.meta.AttributeValuePasswordValidatorCfgDefn
-
public final class AttributeValuePasswordValidatorCfgDefn extends ManagedObjectDefinition<AttributeValuePasswordValidatorCfgClient,AttributeValuePasswordValidatorCfg>
An interface for querying the Attribute Value Password Validator managed object definition meta information.The Attribute Value Password Validator attempts to determine whether a proposed password is acceptable for use by determining whether that password is contained in any attribute within the user's entry.
-
-
Method Summary
-
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
-
-
-
-
Method Detail
-
getInstance
public static AttributeValuePasswordValidatorCfgDefn getInstance()
Get the Attribute Value Password Validator configuration definition singleton.- Returns:
- Returns the Attribute Value Password Validator configuration definition singleton.
-
createClientConfiguration
public AttributeValuePasswordValidatorCfgClient createClientConfiguration(ManagedObject<? extends AttributeValuePasswordValidatorCfgClient> impl)
Description copied from class:ManagedObjectDefinition
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 classManagedObjectDefinition<AttributeValuePasswordValidatorCfgClient,AttributeValuePasswordValidatorCfg>
- Parameters:
impl
- The managed object.- Returns:
- Returns a client configuration view of the provided managed object.
-
createServerConfiguration
public AttributeValuePasswordValidatorCfg createServerConfiguration(ServerManagedObject<? extends AttributeValuePasswordValidatorCfg> impl)
Description copied from class:ManagedObjectDefinition
Creates a server configuration view of the provided server managed object.- Specified by:
createServerConfiguration
in classManagedObjectDefinition<AttributeValuePasswordValidatorCfgClient,AttributeValuePasswordValidatorCfg>
- Parameters:
impl
- The server managed object.- Returns:
- Returns a server configuration view of the provided server managed object.
-
getServerConfigurationClass
public Class<AttributeValuePasswordValidatorCfg> getServerConfigurationClass()
Description copied from class:ManagedObjectDefinition
Gets the server configuration class instance associated with this managed object definition.- Specified by:
getServerConfigurationClass
in classManagedObjectDefinition<AttributeValuePasswordValidatorCfgClient,AttributeValuePasswordValidatorCfg>
- Returns:
- Returns the server configuration class instance associated with this managed object 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 attribute values.
If "false" then only match the entire password against attribute values otherwise ("true") check whether the password contains attribute values.
- Returns:
- Returns the "check-substrings" 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.
-
getMatchAttributePropertyDefinition
public AttributeTypePropertyDefinition getMatchAttributePropertyDefinition()
Get the "match-attribute" property definition.Specifies the name(s) of the attribute(s) whose values should be checked to determine whether they match the provided password. If no values are provided, then the server checks if the proposed password matches the value of any attribute in the user's entry.
- Returns:
- Returns the "match-attribute" 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 should test the reversed value of the provided password as well as the order in which it was given.
- Returns:
- Returns the "test-reversed-password" property definition.
-
-