Package org.forgerock.opendj.server.config.client

Interface AttributeValuePasswordValidatorCfgClient

  • All Superinterfaces:
    ConfigurationClient, PasswordValidatorCfgClient
    public interface AttributeValuePasswordValidatorCfgClient
extends PasswordValidatorCfgClient
    A client-side interface for reading and modifying Attribute Value Password Validator settings.

    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 Detail

      • isCheckSubstrings

        boolean isCheckSubstrings()
        Gets the "check-substrings" property.

        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 value of the "check-substrings" property.

      • setCheckSubstrings

        void setCheckSubstrings​(Boolean value)
                 throws PropertyException
        Sets the "check-substrings" property.

        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.

        Parameters:
        value - The value of the "check-substrings" property.
        Throws:
        PropertyException - If the new value is invalid.

      • getJavaClass

        String getJavaClass()
        Gets the "java-class" property.

        Specifies the fully-qualified name of the Java class that provides the password validator implementation.

        Specified by:
        getJavaClass in interface PasswordValidatorCfgClient
        Returns:
        Returns the value of the "java-class" property.

      • setJavaClass

        void setJavaClass​(String value)
           throws PropertyException
        Sets the "java-class" property.

        Specifies the fully-qualified name of the Java class that provides the password validator implementation.

        Specified by:
        setJavaClass in interface PasswordValidatorCfgClient
        Parameters:
        value - The value of the "java-class" property.
        Throws:
        PropertyException - If the new value is invalid.

      • getMatchAttribute

        SortedSet<org.forgerock.opendj.ldap.schema.AttributeType> getMatchAttribute()
        Gets the "match-attribute" property.

        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 values of the "match-attribute" property.

      • setMatchAttribute

        void setMatchAttribute​(Collection<org.forgerock.opendj.ldap.schema.AttributeType> values)
                throws PropertyException
        Sets the "match-attribute" property.

        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.

        Parameters:
        values - The values of the "match-attribute" property.
        Throws:
        PropertyException - If one or more of the new values are invalid.

      • getMinSubstringLength

        int getMinSubstringLength()
        Gets the "min-substring-length" property.

        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 value of the "min-substring-length" property.

      • setMinSubstringLength

        void setMinSubstringLength​(Integer value)
                    throws PropertyException
        Sets the "min-substring-length" property.

        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.

        Parameters:
        value - The value of the "min-substring-length" property.
        Throws:
        PropertyException - If the new value is invalid.

      • isTestReversedPassword

        Boolean isTestReversedPassword()
        Gets the "test-reversed-password" property.

        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 value of the "test-reversed-password" property.

      • setTestReversedPassword

        void setTestReversedPassword​(boolean value)
                      throws PropertyException
        Sets the "test-reversed-password" property.

        Indicates whether this password validator should test the reversed value of the provided password as well as the order in which it was given.

        Parameters:
        value - The value of the "test-reversed-password" property.
        Throws:
        PropertyException - If the new value is invalid.