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.Configuration;
032    import org.opends.server.admin.server.ConfigurationChangeListener;
033    
034    
035    
036    /**
037     * A server-side interface for querying Password Storage Scheme
038     * settings.
039     * <p>
040     * Password Storage Schemes encode new passwords provided by users so
041     * that they are stored in an encoded manner. This makes it difficult
042     * or impossible for someone to determine the clear-text passwords from
043     * the encoded values.
044     */
045    public interface PasswordStorageSchemeCfg extends Configuration {
046    
047      /**
048       * Gets the configuration class associated with this Password Storage Scheme.
049       *
050       * @return Returns the configuration class associated with this Password Storage Scheme.
051       */
052      Class<? extends PasswordStorageSchemeCfg> configurationClass();
053    
054    
055    
056      /**
057       * Register to be notified when this Password Storage Scheme is changed.
058       *
059       * @param listener
060       *          The Password Storage Scheme configuration change listener.
061       */
062      void addChangeListener(ConfigurationChangeListener<PasswordStorageSchemeCfg> listener);
063    
064    
065    
066      /**
067       * Deregister an existing Password Storage Scheme configuration change listener.
068       *
069       * @param listener
070       *          The Password Storage Scheme configuration change listener.
071       */
072      void removeChangeListener(ConfigurationChangeListener<PasswordStorageSchemeCfg> listener);
073    
074    
075    
076      /**
077       * Gets the "enabled" property.
078       * <p>
079       * Indicates whether the Password Storage Scheme is enabled for use.
080       *
081       * @return Returns the value of the "enabled" property.
082       */
083      boolean isEnabled();
084    
085    
086    
087      /**
088       * Gets the "java-class" property.
089       * <p>
090       * Specifies the fully-qualified name of the Java class that
091       * provides the Password Storage Scheme implementation.
092       *
093       * @return Returns the value of the "java-class" property.
094       */
095      String getJavaClass();
096    
097    }