001/*
002 * CDDL HEADER START
003 *
004 * The contents of this file are subject to the terms of the
005 * Common Development and Distribution License, Version 1.0 only
006 * (the "License").  You may not use this file except in compliance
007 * with the License.
008 *
009 * You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
010 * or http://forgerock.org/license/CDDLv1.0.html.
011 * See the License for the specific language governing permissions
012 * and limitations under the License.
013 *
014 * When distributing Covered Code, include this CDDL HEADER in each
015 * file and include the License file at legal-notices/CDDLv1_0.txt.
016 * If applicable, add the following below this CDDL HEADER, with the
017 * fields enclosed by brackets "[]" replaced with your own identifying
018 * information:
019 *      Portions Copyright [yyyy] [name of copyright owner]
020 *
021 * CDDL HEADER END
022 *
023 *
024 *      Copyright 2008 Sun Microsystems, Inc.
025 */
026package org.opends.server.admin.std.server;
027
028
029
030import org.opends.server.admin.server.ConfigurationChangeListener;
031
032
033
034/**
035 * A server-side interface for querying Repeated Characters Password
036 * Validator settings.
037 * <p>
038 * The Repeated Characters Password Validator is used to determine
039 * whether a proposed password is acceptable based on the number of
040 * times any character appears consecutively in a password value.
041 */
042public interface RepeatedCharactersPasswordValidatorCfg extends PasswordValidatorCfg {
043
044  /**
045   * Gets the configuration class associated with this Repeated Characters Password Validator.
046   *
047   * @return Returns the configuration class associated with this Repeated Characters Password Validator.
048   */
049  Class<? extends RepeatedCharactersPasswordValidatorCfg> configurationClass();
050
051
052
053  /**
054   * Register to be notified when this Repeated Characters Password Validator is changed.
055   *
056   * @param listener
057   *          The Repeated Characters Password Validator configuration change listener.
058   */
059  void addRepeatedCharactersChangeListener(ConfigurationChangeListener<RepeatedCharactersPasswordValidatorCfg> listener);
060
061
062
063  /**
064   * Deregister an existing Repeated Characters Password Validator configuration change listener.
065   *
066   * @param listener
067   *          The Repeated Characters Password Validator configuration change listener.
068   */
069  void removeRepeatedCharactersChangeListener(ConfigurationChangeListener<RepeatedCharactersPasswordValidatorCfg> listener);
070
071
072
073  /**
074   * Gets the "case-sensitive-validation" property.
075   * <p>
076   * Indicates whether this password validator should treat password
077   * characters in a case-sensitive manner.
078   * <p>
079   * If the value of this property is false, the validator ignores any
080   * differences in capitalization when looking for consecutive
081   * characters in the password. If the value is true, the validator
082   * considers a character to be repeating only if all consecutive
083   * occurrences use the same capitalization.
084   *
085   * @return Returns the value of the "case-sensitive-validation" property.
086   */
087  boolean isCaseSensitiveValidation();
088
089
090
091  /**
092   * Gets the "java-class" property.
093   * <p>
094   * Specifies the fully-qualified name of the Java class that
095   * provides the password validator implementation.
096   *
097   * @return Returns the value of the "java-class" property.
098   */
099  String getJavaClass();
100
101
102
103  /**
104   * Gets the "max-consecutive-length" property.
105   * <p>
106   * Specifies the maximum number of times that any character can
107   * appear consecutively in a password value.
108   * <p>
109   * A value of zero indicates that no maximum limit is enforced.
110   *
111   * @return Returns the value of the "max-consecutive-length" property.
112   */
113  int getMaxConsecutiveLength();
114
115}