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.LengthBasedPasswordValidatorCfg;
033
034
035
036/**
037 * A client-side interface for reading and modifying Length Based
038 * Password Validator settings.
039 * <p>
040 * The Length Based Password Validator is used to determine whether a
041 * proposed password is acceptable based on whether the number of
042 * characters it contains falls within an acceptable range of values.
043 */
044public interface LengthBasedPasswordValidatorCfgClient extends PasswordValidatorCfgClient {
045
046  /**
047   * Get the configuration definition associated with this Length Based Password Validator.
048   *
049   * @return Returns the configuration definition associated with this Length Based Password Validator.
050   */
051  ManagedObjectDefinition<? extends LengthBasedPasswordValidatorCfgClient, ? extends LengthBasedPasswordValidatorCfg> definition();
052
053
054
055  /**
056   * Gets the "java-class" property.
057   * <p>
058   * Specifies the fully-qualified name of the Java class that
059   * provides the password validator implementation.
060   *
061   * @return Returns the value of the "java-class" property.
062   */
063  String getJavaClass();
064
065
066
067  /**
068   * Sets the "java-class" property.
069   * <p>
070   * Specifies the fully-qualified name of the Java class that
071   * provides the password validator implementation.
072   *
073   * @param value The value of the "java-class" property.
074   * @throws PropertyException
075   *           If the new value is invalid.
076   */
077  void setJavaClass(String value) throws PropertyException;
078
079
080
081  /**
082   * Gets the "max-password-length" property.
083   * <p>
084   * Specifies the maximum number of characters that can be included
085   * in a proposed password.
086   * <p>
087   * A value of zero indicates that there will be no upper bound
088   * enforced. If both minimum and maximum lengths are defined, then
089   * the minimum length must be less than or equal to the maximum
090   * length.
091   *
092   * @return Returns the value of the "max-password-length" property.
093   */
094  int getMaxPasswordLength();
095
096
097
098  /**
099   * Sets the "max-password-length" property.
100   * <p>
101   * Specifies the maximum number of characters that can be included
102   * in a proposed password.
103   * <p>
104   * A value of zero indicates that there will be no upper bound
105   * enforced. If both minimum and maximum lengths are defined, then
106   * the minimum length must be less than or equal to the maximum
107   * length.
108   *
109   * @param value The value of the "max-password-length" property.
110   * @throws PropertyException
111   *           If the new value is invalid.
112   */
113  void setMaxPasswordLength(Integer value) throws PropertyException;
114
115
116
117  /**
118   * Gets the "min-password-length" property.
119   * <p>
120   * Specifies the minimum number of characters that must be included
121   * in a proposed password.
122   * <p>
123   * A value of zero indicates that there will be no lower bound
124   * enforced. If both minimum and maximum lengths are defined, then
125   * the minimum length must be less than or equal to the maximum
126   * length.
127   *
128   * @return Returns the value of the "min-password-length" property.
129   */
130  int getMinPasswordLength();
131
132
133
134  /**
135   * Sets the "min-password-length" property.
136   * <p>
137   * Specifies the minimum number of characters that must be included
138   * in a proposed password.
139   * <p>
140   * A value of zero indicates that there will be no lower bound
141   * enforced. If both minimum and maximum lengths are defined, then
142   * the minimum length must be less than or equal to the maximum
143   * length.
144   *
145   * @param value The value of the "min-password-length" property.
146   * @throws PropertyException
147   *           If the new value is invalid.
148   */
149  void setMinPasswordLength(Integer value) throws PropertyException;
150
151}