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.client;
027
028
029
030import org.opends.server.admin.ManagedObjectDefinition;
031import org.opends.server.admin.PropertyException;
032import org.opends.server.admin.std.server.RepeatedCharactersPasswordValidatorCfg;
033
034
035
036/**
037 * A client-side interface for reading and modifying Repeated
038 * Characters Password Validator settings.
039 * <p>
040 * The Repeated Characters Password Validator is used to determine
041 * whether a proposed password is acceptable based on the number of
042 * times any character appears consecutively in a password value.
043 */
044public interface RepeatedCharactersPasswordValidatorCfgClient extends PasswordValidatorCfgClient {
045
046  /**
047   * Get the configuration definition associated with this Repeated Characters Password Validator.
048   *
049   * @return Returns the configuration definition associated with this Repeated Characters Password Validator.
050   */
051  ManagedObjectDefinition<? extends RepeatedCharactersPasswordValidatorCfgClient, ? extends RepeatedCharactersPasswordValidatorCfg> definition();
052
053
054
055  /**
056   * Gets the "case-sensitive-validation" property.
057   * <p>
058   * Indicates whether this password validator should treat password
059   * characters in a case-sensitive manner.
060   * <p>
061   * If the value of this property is false, the validator ignores any
062   * differences in capitalization when looking for consecutive
063   * characters in the password. If the value is true, the validator
064   * considers a character to be repeating only if all consecutive
065   * occurrences use the same capitalization.
066   *
067   * @return Returns the value of the "case-sensitive-validation" property.
068   */
069  Boolean isCaseSensitiveValidation();
070
071
072
073  /**
074   * Sets 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   * @param value The value of the "case-sensitive-validation" property.
086   * @throws PropertyException
087   *           If the new value is invalid.
088   */
089  void setCaseSensitiveValidation(boolean value) throws PropertyException;
090
091
092
093  /**
094   * Gets the "java-class" property.
095   * <p>
096   * Specifies the fully-qualified name of the Java class that
097   * provides the password validator implementation.
098   *
099   * @return Returns the value of the "java-class" property.
100   */
101  String getJavaClass();
102
103
104
105  /**
106   * Sets the "java-class" property.
107   * <p>
108   * Specifies the fully-qualified name of the Java class that
109   * provides the password validator implementation.
110   *
111   * @param value The value of the "java-class" property.
112   * @throws PropertyException
113   *           If the new value is invalid.
114   */
115  void setJavaClass(String value) throws PropertyException;
116
117
118
119  /**
120   * Gets the "max-consecutive-length" property.
121   * <p>
122   * Specifies the maximum number of times that any character can
123   * appear consecutively in a password value.
124   * <p>
125   * A value of zero indicates that no maximum limit is enforced.
126   *
127   * @return Returns the value of the "max-consecutive-length" property.
128   */
129  Integer getMaxConsecutiveLength();
130
131
132
133  /**
134   * Sets the "max-consecutive-length" property.
135   * <p>
136   * Specifies the maximum number of times that any character can
137   * appear consecutively in a password value.
138   * <p>
139   * A value of zero indicates that no maximum limit is enforced.
140   *
141   * @param value The value of the "max-consecutive-length" property.
142   * @throws PropertyException
143   *           If the new value is invalid.
144   */
145  void setMaxConsecutiveLength(int value) throws PropertyException;
146
147}