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 Length Based Password
026 * Validator settings.
027 * <p>
028 * The Length Based Password Validator is used to determine whether a
029 * proposed password is acceptable based on whether the number of
030 * characters it contains falls within an acceptable range of values.
031 */
032public interface LengthBasedPasswordValidatorCfg extends PasswordValidatorCfg {
033
034  /**
035   * Gets the configuration class associated with this Length Based Password Validator.
036   *
037   * @return Returns the configuration class associated with this Length Based Password Validator.
038   */
039  Class<? extends LengthBasedPasswordValidatorCfg> configurationClass();
040
041
042
043  /**
044   * Register to be notified when this Length Based Password Validator is changed.
045   *
046   * @param listener
047   *          The Length Based Password Validator configuration change listener.
048   */
049  void addLengthBasedChangeListener(ConfigurationChangeListener<LengthBasedPasswordValidatorCfg> listener);
050
051
052
053  /**
054   * Deregister an existing Length Based Password Validator configuration change listener.
055   *
056   * @param listener
057   *          The Length Based Password Validator configuration change listener.
058   */
059  void removeLengthBasedChangeListener(ConfigurationChangeListener<LengthBasedPasswordValidatorCfg> listener);
060
061
062
063  /**
064   * Gets the "java-class" property.
065   * <p>
066   * Specifies the fully-qualified name of the Java class that
067   * provides the password validator implementation.
068   *
069   * @return Returns the value of the "java-class" property.
070   */
071  String getJavaClass();
072
073
074
075  /**
076   * Gets the "max-password-length" property.
077   * <p>
078   * Specifies the maximum number of characters that can be included
079   * in a proposed password.
080   * <p>
081   * A value of zero indicates that there will be no upper bound
082   * enforced. If both minimum and maximum lengths are defined, then
083   * the minimum length must be less than or equal to the maximum
084   * length.
085   *
086   * @return Returns the value of the "max-password-length" property.
087   */
088  int getMaxPasswordLength();
089
090
091
092  /**
093   * Gets the "min-password-length" property.
094   * <p>
095   * Specifies the minimum number of characters that must be included
096   * in a proposed password.
097   * <p>
098   * A value of zero indicates that there will be no lower bound
099   * enforced. If both minimum and maximum lengths are defined, then
100   * the minimum length must be less than or equal to the maximum
101   * length.
102   *
103   * @return Returns the value of the "min-password-length" property.
104   */
105  int getMinPasswordLength();
106
107}