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 java.util.SortedSet;
032    import org.opends.server.admin.server.ConfigurationChangeListener;
033    
034    
035    
036    /**
037     * A server-side interface for querying Character Set Password
038     * Validator settings.
039     * <p>
040     * The Character Set Password Validator determines whether a proposed
041     * password is acceptable by checking whether it contains a sufficient
042     * number of characters from one or more user-defined character sets.
043     */
044    public interface CharacterSetPasswordValidatorCfg extends PasswordValidatorCfg {
045    
046      /**
047       * Gets the configuration class associated with this Character Set Password Validator.
048       *
049       * @return Returns the configuration class associated with this Character Set Password Validator.
050       */
051      Class<? extends CharacterSetPasswordValidatorCfg> configurationClass();
052    
053    
054    
055      /**
056       * Register to be notified when this Character Set Password Validator is changed.
057       *
058       * @param listener
059       *          The Character Set Password Validator configuration change listener.
060       */
061      void addCharacterSetChangeListener(ConfigurationChangeListener<CharacterSetPasswordValidatorCfg> listener);
062    
063    
064    
065      /**
066       * Deregister an existing Character Set Password Validator configuration change listener.
067       *
068       * @param listener
069       *          The Character Set Password Validator configuration change listener.
070       */
071      void removeCharacterSetChangeListener(ConfigurationChangeListener<CharacterSetPasswordValidatorCfg> listener);
072    
073    
074    
075      /**
076       * Gets the "allow-unclassified-characters" property.
077       * <p>
078       * Indicates whether this password validator allows passwords to
079       * contain characters outside of any of the user-defined character
080       * sets.
081       * <p>
082       * If this is "false", then only those characters in the
083       * user-defined character sets may be used in passwords. Any password
084       * containing a character not included in any character set will be
085       * rejected.
086       *
087       * @return Returns the value of the "allow-unclassified-characters" property.
088       */
089      boolean isAllowUnclassifiedCharacters();
090    
091    
092    
093      /**
094       * Gets the "character-set" property.
095       * <p>
096       * Specifies a character set containing characters that a password
097       * may contain and a value indicating the minimum number of
098       * characters required from that set.
099       * <p>
100       * Each value must be an integer (indicating the minimum required
101       * characters from the set) followed by a colon and the characters to
102       * include in that set (for example, "3:abcdefghijklmnopqrstuvwxyz"
103       * indicates that a user password must contain at least three
104       * characters from the set of lowercase ASCII letters). Multiple
105       * character sets can be defined in separate values, although no
106       * character can appear in more than one character set.
107       *
108       * @return Returns an unmodifiable set containing the values of the "character-set" property.
109       */
110      SortedSet<String> getCharacterSet();
111    
112    
113    
114      /**
115       * Gets the "java-class" property.
116       * <p>
117       * Specifies the fully-qualified name of the Java class that
118       * provides the password validator implementation.
119       *
120       * @return Returns the value of the "java-class" property.
121       */
122      String getJavaClass();
123    
124    }