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

java.lang.Object
  extended by org.opends.server.admin.AbstractManagedObjectDefinition<C,S>
      extended by org.opends.server.admin.ManagedObjectDefinition<CharacterSetPasswordValidatorCfgClient,CharacterSetPasswordValidatorCfg>
          extended by org.opends.server.admin.std.meta.CharacterSetPasswordValidatorCfgDefn

public final class CharacterSetPasswordValidatorCfgDefn
extends ManagedObjectDefinition<CharacterSetPasswordValidatorCfgClient,CharacterSetPasswordValidatorCfg>

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

The Character Set Password Validator determines whether a proposed password is acceptable by checking whether it contains a sufficient number of characters from one or more user-defined character sets.


Method Summary
 CharacterSetPasswordValidatorCfgClient createClientConfiguration(ManagedObject<? extends CharacterSetPasswordValidatorCfgClient> impl)
          Creates a client configuration view of the provided managed object.
 CharacterSetPasswordValidatorCfg createServerConfiguration(ServerManagedObject<? extends CharacterSetPasswordValidatorCfg> impl)
          Creates a server configuration view of the provided server managed object.
 BooleanPropertyDefinition getAllowUnclassifiedCharactersPropertyDefinition()
          Get the "allow-unclassified-characters" property definition.
 StringPropertyDefinition getCharacterSetPropertyDefinition()
          Get the "character-set" property definition.
 BooleanPropertyDefinition getEnabledPropertyDefinition()
          Get the "enabled" property definition.
static CharacterSetPasswordValidatorCfgDefn getInstance()
          Get the Character Set Password Validator configuration definition singleton.
 ClassPropertyDefinition getJavaClassPropertyDefinition()
          Get the "java-class" property definition.
 java.lang.Class<CharacterSetPasswordValidatorCfg> getServerConfigurationClass()
          Gets the server configuration class instance associated with this managed object 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 CharacterSetPasswordValidatorCfgDefn getInstance()
Get the Character Set Password Validator configuration definition singleton.

Returns:
Returns the Character Set Password Validator configuration definition singleton.

createClientConfiguration

public CharacterSetPasswordValidatorCfgClient createClientConfiguration(ManagedObject<? extends CharacterSetPasswordValidatorCfgClient> 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<CharacterSetPasswordValidatorCfgClient,CharacterSetPasswordValidatorCfg>
Parameters:
impl - The managed object.
Returns:
Returns a client configuration view of the provided managed object.

createServerConfiguration

public CharacterSetPasswordValidatorCfg createServerConfiguration(ServerManagedObject<? extends CharacterSetPasswordValidatorCfg> impl)
Creates a server configuration view of the provided server managed object.

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

getServerConfigurationClass

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

Specified by:
getServerConfigurationClass in class ManagedObjectDefinition<CharacterSetPasswordValidatorCfgClient,CharacterSetPasswordValidatorCfg>
Returns:
Returns the server configuration class instance associated with this managed object definition.

getAllowUnclassifiedCharactersPropertyDefinition

public BooleanPropertyDefinition getAllowUnclassifiedCharactersPropertyDefinition()
Get the "allow-unclassified-characters" property definition.

Indicates whether this password validator allows passwords to contain characters outside of any of the user-defined character sets.

If this is "false", then only those characters in the user-defined character sets may be used in passwords. Any password containing a character not included in any character set will be rejected.

Returns:
Returns the "allow-unclassified-characters" property definition.

getCharacterSetPropertyDefinition

public StringPropertyDefinition getCharacterSetPropertyDefinition()
Get the "character-set" property definition.

Specifies a character set containing characters that a password may contain and a value indicating the minimum number of characters required from that set.

Each value must be an integer (indicating the minimum required characters from the set) followed by a colon and the characters to include in that set (for example, "3:abcdefghijklmnopqrstuvwxyz" indicates that a user password must contain at least three characters from the set of lowercase ASCII letters). Multiple character sets can be defined in separate values, although no character can appear in more than one character set.

Returns:
Returns the "character-set" 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.