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