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.server;
027
028
029
030import org.opends.server.admin.server.ConfigurationChangeListener;
031
032
033
034/**
035 * A server-side interface for querying SHA1 Password Storage Scheme
036 * settings.
037 * <p>
038 * The SHA1 Password Storage Scheme provides a mechanism for encoding
039 * user passwords using an unsalted form of the SHA-1 message digest
040 * algorithm. Because the implementation does not use any kind of
041 * salting mechanism, a given password always has the same encoded
042 * form.
043 */
044public interface SHA1PasswordStorageSchemeCfg extends PasswordStorageSchemeCfg {
045
046  /**
047   * Gets the configuration class associated with this SHA1 Password Storage Scheme.
048   *
049   * @return Returns the configuration class associated with this SHA1 Password Storage Scheme.
050   */
051  Class<? extends SHA1PasswordStorageSchemeCfg> configurationClass();
052
053
054
055  /**
056   * Register to be notified when this SHA1 Password Storage Scheme is changed.
057   *
058   * @param listener
059   *          The SHA1 Password Storage Scheme configuration change listener.
060   */
061  void addSHA1ChangeListener(ConfigurationChangeListener<SHA1PasswordStorageSchemeCfg> listener);
062
063
064
065  /**
066   * Deregister an existing SHA1 Password Storage Scheme configuration change listener.
067   *
068   * @param listener
069   *          The SHA1 Password Storage Scheme configuration change listener.
070   */
071  void removeSHA1ChangeListener(ConfigurationChangeListener<SHA1PasswordStorageSchemeCfg> listener);
072
073
074
075  /**
076   * Gets the "java-class" property.
077   * <p>
078   * Specifies the fully-qualified name of the Java class that
079   * provides the SHA1 Password Storage Scheme implementation.
080   *
081   * @return Returns the value of the "java-class" property.
082   */
083  String getJavaClass();
084
085}