org.opends.server.admin.std.meta
Class AttributeValuePasswordValidatorCfgDefn

java.lang.Object
  extended by org.opends.server.admin.AbstractManagedObjectDefinition<C,S>
      extended by org.opends.server.admin.ManagedObjectDefinition<AttributeValuePasswordValidatorCfgClient,AttributeValuePasswordValidatorCfg>
          extended by org.opends.server.admin.std.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
 AttributeValuePasswordValidatorCfgClient createClientConfiguration(ManagedObject<? extends AttributeValuePasswordValidatorCfgClient> impl)
          Creates a client configuration view of the provided managed object.
 AttributeValuePasswordValidatorCfg createServerConfiguration(ServerManagedObject<? extends AttributeValuePasswordValidatorCfg> impl)
          Creates a server configuration view of the provided server managed object.
 BooleanPropertyDefinition getEnabledPropertyDefinition()
          Get the "enabled" property definition.
static AttributeValuePasswordValidatorCfgDefn getInstance()
          Get the Attribute Value Password Validator configuration definition singleton.
 ClassPropertyDefinition getJavaClassPropertyDefinition()
          Get the "java-class" property definition.
 AttributeTypePropertyDefinition getMatchAttributePropertyDefinition()
          Get the "match-attribute" property definition.
 java.lang.Class<AttributeValuePasswordValidatorCfg> 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 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)
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<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)
Creates a server configuration view of the provided server managed object.

Specified by:
createServerConfiguration in class ManagedObjectDefinition<AttributeValuePasswordValidatorCfgClient,AttributeValuePasswordValidatorCfg>
Parameters:
impl - The server managed object.
Returns:
Returns a server configuration view of the provided server managed object.

getServerConfigurationClass

public java.lang.Class<AttributeValuePasswordValidatorCfg> getServerConfigurationClass()
Gets the server configuration class instance associated with this managed object definition.

Specified by:
getServerConfigurationClass in class ManagedObjectDefinition<AttributeValuePasswordValidatorCfgClient,AttributeValuePasswordValidatorCfg>
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.

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.

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.