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