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 Random Password Generator
038     * settings.
039     * <p>
040     * The Random Password Generator creates random passwords based on
041     * fixed-length strings built from one or more character sets.
042     */
043    public interface RandomPasswordGeneratorCfg extends PasswordGeneratorCfg {
044    
045      /**
046       * Gets the configuration class associated with this Random Password Generator.
047       *
048       * @return Returns the configuration class associated with this Random Password Generator.
049       */
050      Class<? extends RandomPasswordGeneratorCfg> configurationClass();
051    
052    
053    
054      /**
055       * Register to be notified when this Random Password Generator is changed.
056       *
057       * @param listener
058       *          The Random Password Generator configuration change listener.
059       */
060      void addRandomChangeListener(ConfigurationChangeListener<RandomPasswordGeneratorCfg> listener);
061    
062    
063    
064      /**
065       * Deregister an existing Random Password Generator configuration change listener.
066       *
067       * @param listener
068       *          The Random Password Generator configuration change listener.
069       */
070      void removeRandomChangeListener(ConfigurationChangeListener<RandomPasswordGeneratorCfg> 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 Random Password Generator implementation.
079       *
080       * @return Returns the value of the "java-class" property.
081       */
082      String getJavaClass();
083    
084    
085    
086      /**
087       * Gets the "password-character-set" property.
088       * <p>
089       * Specifies one or more named character sets.
090       * <p>
091       * This is a multi-valued property, with each value defining a
092       * different character set. The format of the character set is the
093       * name of the set followed by a colon and the characters that are in
094       * that set. For example, the value
095       * "alpha:abcdefghijklmnopqrstuvwxyz" defines a character set named
096       * "alpha" containing all of the lower-case ASCII alphabetic
097       * characters.
098       *
099       * @return Returns an unmodifiable set containing the values of the "password-character-set" property.
100       */
101      SortedSet<String> getPasswordCharacterSet();
102    
103    
104    
105      /**
106       * Gets the "password-format" property.
107       * <p>
108       * Specifies the format to use for the generated password.
109       * <p>
110       * The value is a comma-delimited list of elements in which each of
111       * those elements is comprised of the name of a character set defined
112       * in the password-character-set property, a colon, and the number of
113       * characters to include from that set. For example, a value of
114       * "alpha:3,numeric:2,alpha:3" generates an 8-character password in
115       * which the first three characters are from the "alpha" set, the
116       * next two are from the "numeric" set, and the final three are from
117       * the "alpha" set.
118       *
119       * @return Returns the value of the "password-format" property.
120       */
121      String getPasswordFormat();
122    
123    }