001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions Copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2008 Sun Microsystems, Inc.
015 */
016package org.forgerock.opendj.server.config.server;
017
018
019
020import org.forgerock.opendj.config.server.ConfigurationChangeListener;
021
022
023
024/**
025 * A server-side interface for querying Unique Characters Password
026 * Validator settings.
027 * <p>
028 * The Unique Characters Password Validator is used to determine
029 * whether a proposed password is acceptable based on the number of
030 * unique characters that it contains.
031 */
032public interface UniqueCharactersPasswordValidatorCfg extends PasswordValidatorCfg {
033
034  /**
035   * Gets the configuration class associated with this Unique Characters Password Validator.
036   *
037   * @return Returns the configuration class associated with this Unique Characters Password Validator.
038   */
039  Class<? extends UniqueCharactersPasswordValidatorCfg> configurationClass();
040
041
042
043  /**
044   * Register to be notified when this Unique Characters Password Validator is changed.
045   *
046   * @param listener
047   *          The Unique Characters Password Validator configuration change listener.
048   */
049  void addUniqueCharactersChangeListener(ConfigurationChangeListener<UniqueCharactersPasswordValidatorCfg> listener);
050
051
052
053  /**
054   * Deregister an existing Unique Characters Password Validator configuration change listener.
055   *
056   * @param listener
057   *          The Unique Characters Password Validator configuration change listener.
058   */
059  void removeUniqueCharactersChangeListener(ConfigurationChangeListener<UniqueCharactersPasswordValidatorCfg> listener);
060
061
062
063  /**
064   * Gets the "case-sensitive-validation" property.
065   * <p>
066   * Indicates whether this password validator should treat password
067   * characters in a case-sensitive manner.
068   * <p>
069   * A value of true indicates that the validator does not consider a
070   * capital letter to be the same as its lower-case counterpart. A
071   * value of false indicates that the validator ignores differences in
072   * capitalization when looking at the number of unique characters in
073   * the password.
074   *
075   * @return Returns the value of the "case-sensitive-validation" property.
076   */
077  boolean isCaseSensitiveValidation();
078
079
080
081  /**
082   * Gets the "java-class" property.
083   * <p>
084   * Specifies the fully-qualified name of the Java class that
085   * provides the password validator implementation.
086   *
087   * @return Returns the value of the "java-class" property.
088   */
089  String getJavaClass();
090
091
092
093  /**
094   * Gets the "min-unique-characters" property.
095   * <p>
096   * Specifies the minimum number of unique characters that a password
097   * will be allowed to contain.
098   * <p>
099   * A value of zero indicates that no minimum value is enforced.
100   *
101   * @return Returns the value of the "min-unique-characters" property.
102   */
103  int getMinUniqueCharacters();
104
105}