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