001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions Copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2008 Sun Microsystems, Inc.
015 */
016package org.forgerock.opendj.server.config.server;
017
018
019
020import org.forgerock.opendj.config.server.ConfigurationChangeListener;
021
022
023
024/**
025 * A server-side interface for querying SHA1 Password Storage Scheme
026 * settings.
027 * <p>
028 * The SHA1 Password Storage Scheme provides a mechanism for encoding
029 * user passwords using an unsalted form of the SHA-1 message digest
030 * algorithm. Because the implementation does not use any kind of
031 * salting mechanism, a given password always has the same encoded
032 * form.
033 */
034public interface SHA1PasswordStorageSchemeCfg extends PasswordStorageSchemeCfg {
035
036  /**
037   * Gets the configuration class associated with this SHA1 Password Storage Scheme.
038   *
039   * @return Returns the configuration class associated with this SHA1 Password Storage Scheme.
040   */
041  Class<? extends SHA1PasswordStorageSchemeCfg> configurationClass();
042
043
044
045  /**
046   * Register to be notified when this SHA1 Password Storage Scheme is changed.
047   *
048   * @param listener
049   *          The SHA1 Password Storage Scheme configuration change listener.
050   */
051  void addSHA1ChangeListener(ConfigurationChangeListener<SHA1PasswordStorageSchemeCfg> listener);
052
053
054
055  /**
056   * Deregister an existing SHA1 Password Storage Scheme configuration change listener.
057   *
058   * @param listener
059   *          The SHA1 Password Storage Scheme configuration change listener.
060   */
061  void removeSHA1ChangeListener(ConfigurationChangeListener<SHA1PasswordStorageSchemeCfg> listener);
062
063
064
065  /**
066   * Gets the "java-class" property.
067   * <p>
068   * Specifies the fully-qualified name of the Java class that
069   * provides the SHA1 Password Storage Scheme implementation.
070   *
071   * @return Returns the value of the "java-class" property.
072   */
073  String getJavaClass();
074
075}