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.SimilarityBasedPasswordValidatorCfg;
023
024
025
026/**
027 * A client-side interface for reading and modifying Similarity Based
028 * Password Validator settings.
029 * <p>
030 * The Similarity Based Password Validator determines whether a
031 * proposed password is acceptable by measuring how similar it is to
032 * the user's current password.
033 */
034public interface SimilarityBasedPasswordValidatorCfgClient extends PasswordValidatorCfgClient {
035
036  /**
037   * Get the configuration definition associated with this Similarity Based Password Validator.
038   *
039   * @return Returns the configuration definition associated with this Similarity Based Password Validator.
040   */
041  ManagedObjectDefinition<? extends SimilarityBasedPasswordValidatorCfgClient, ? extends SimilarityBasedPasswordValidatorCfg> definition();
042
043
044
045  /**
046   * Gets the "java-class" property.
047   * <p>
048   * Specifies the fully-qualified name of the Java class that
049   * provides the password validator implementation.
050   *
051   * @return Returns the value of the "java-class" property.
052   */
053  String getJavaClass();
054
055
056
057  /**
058   * Sets the "java-class" property.
059   * <p>
060   * Specifies the fully-qualified name of the Java class that
061   * provides the password validator implementation.
062   *
063   * @param value The value of the "java-class" property.
064   * @throws PropertyException
065   *           If the new value is invalid.
066   */
067  void setJavaClass(String value) throws PropertyException;
068
069
070
071  /**
072   * Gets the "min-password-difference" property.
073   * <p>
074   * Specifies the minimum difference of new and old password.
075   * <p>
076   * A value of zero indicates that no difference between passwords is
077   * acceptable.
078   *
079   * @return Returns the value of the "min-password-difference" property.
080   */
081  Integer getMinPasswordDifference();
082
083
084
085  /**
086   * Sets the "min-password-difference" property.
087   * <p>
088   * Specifies the minimum difference of new and old password.
089   * <p>
090   * A value of zero indicates that no difference between passwords is
091   * acceptable.
092   *
093   * @param value The value of the "min-password-difference" property.
094   * @throws PropertyException
095   *           If the new value is invalid.
096   */
097  void setMinPasswordDifference(int value) throws PropertyException;
098
099}