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 Repeated Characters Password
026 * Validator settings.
027 * <p>
028 * The Repeated Characters Password Validator is used to determine
029 * whether a proposed password is acceptable based on the number of
030 * times any character appears consecutively in a password value.
031 */
032public interface RepeatedCharactersPasswordValidatorCfg extends PasswordValidatorCfg {
033
034  /**
035   * Gets the configuration class associated with this Repeated Characters Password Validator.
036   *
037   * @return Returns the configuration class associated with this Repeated Characters Password Validator.
038   */
039  Class<? extends RepeatedCharactersPasswordValidatorCfg> configurationClass();
040
041
042
043  /**
044   * Register to be notified when this Repeated Characters Password Validator is changed.
045   *
046   * @param listener
047   *          The Repeated Characters Password Validator configuration change listener.
048   */
049  void addRepeatedCharactersChangeListener(ConfigurationChangeListener<RepeatedCharactersPasswordValidatorCfg> listener);
050
051
052
053  /**
054   * Deregister an existing Repeated Characters Password Validator configuration change listener.
055   *
056   * @param listener
057   *          The Repeated Characters Password Validator configuration change listener.
058   */
059  void removeRepeatedCharactersChangeListener(ConfigurationChangeListener<RepeatedCharactersPasswordValidatorCfg> 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   * If the value of this property is false, the validator ignores any
070   * differences in capitalization when looking for consecutive
071   * characters in the password. If the value is true, the validator
072   * considers a character to be repeating only if all consecutive
073   * occurrences use the same capitalization.
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 "max-consecutive-length" property.
095   * <p>
096   * Specifies the maximum number of times that any character can
097   * appear consecutively in a password value.
098   * <p>
099   * A value of zero indicates that no maximum limit is enforced.
100   *
101   * @return Returns the value of the "max-consecutive-length" property.
102   */
103  int getMaxConsecutiveLength();
104
105}