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.client;
027
028
029
030import org.opends.server.admin.ManagedObjectDefinition;
031import org.opends.server.admin.PropertyException;
032import org.opends.server.admin.std.server.SHA1PasswordStorageSchemeCfg;
033
034
035
036/**
037 * A client-side interface for reading and modifying SHA1 Password
038 * Storage Scheme settings.
039 * <p>
040 * The SHA1 Password Storage Scheme provides a mechanism for encoding
041 * user passwords using an unsalted form of the SHA-1 message digest
042 * algorithm. Because the implementation does not use any kind of
043 * salting mechanism, a given password always has the same encoded
044 * form.
045 */
046public interface SHA1PasswordStorageSchemeCfgClient extends PasswordStorageSchemeCfgClient {
047
048  /**
049   * Get the configuration definition associated with this SHA1 Password Storage Scheme.
050   *
051   * @return Returns the configuration definition associated with this SHA1 Password Storage Scheme.
052   */
053  ManagedObjectDefinition<? extends SHA1PasswordStorageSchemeCfgClient, ? extends SHA1PasswordStorageSchemeCfg> definition();
054
055
056
057  /**
058   * Gets the "java-class" property.
059   * <p>
060   * Specifies the fully-qualified name of the Java class that
061   * provides the SHA1 Password Storage Scheme implementation.
062   *
063   * @return Returns the value of the "java-class" property.
064   */
065  String getJavaClass();
066
067
068
069  /**
070   * Sets the "java-class" property.
071   * <p>
072   * Specifies the fully-qualified name of the Java class that
073   * provides the SHA1 Password Storage Scheme implementation.
074   *
075   * @param value The value of the "java-class" property.
076   * @throws PropertyException
077   *           If the new value is invalid.
078   */
079  void setJavaClass(String value) throws PropertyException;
080
081}