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