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
010 * trunk/opends/resource/legal-notices/OpenDS.LICENSE
011 * or https://OpenDS.dev.java.net/OpenDS.LICENSE.
012 * See the License for the specific language governing permissions
013 * and limitations under the License.
014 *
015 * When distributing Covered Code, include this CDDL HEADER in each
016 * file and include the License file at
017 * trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable,
018 * add the following below this CDDL HEADER, with the fields enclosed
019 * by brackets "[]" replaced with your own identifying information:
020 * Portions Copyright [yyyy] [name of copyright owner]
021 *
022 * CDDL HEADER END
023 *
024 *
025 * Copyright 2008 Sun Microsystems, Inc.
026 */
027 package org.opends.server.admin.std.client;
028
029
030
031 import org.opends.server.admin.IllegalPropertyValueException;
032 import org.opends.server.admin.ManagedObjectDefinition;
033 import org.opends.server.admin.std.server.SimilarityBasedPasswordValidatorCfg;
034
035
036
037 /**
038 * A client-side interface for reading and modifying Similarity Based
039 * Password Validator settings.
040 * <p>
041 * The Similarity Based Password Validator determines whether a
042 * proposed password is acceptable by measuring how similar it is to
043 * the user's current password.
044 */
045 public interface SimilarityBasedPasswordValidatorCfgClient extends PasswordValidatorCfgClient {
046
047 /**
048 * Get the configuration definition associated with this Similarity Based Password Validator.
049 *
050 * @return Returns the configuration definition associated with this Similarity Based Password Validator.
051 */
052 ManagedObjectDefinition<? extends SimilarityBasedPasswordValidatorCfgClient, ? extends SimilarityBasedPasswordValidatorCfg> definition();
053
054
055
056 /**
057 * Gets the "java-class" property.
058 * <p>
059 * Specifies the fully-qualified name of the Java class that
060 * provides the password validator implementation.
061 *
062 * @return Returns the value of the "java-class" property.
063 */
064 String getJavaClass();
065
066
067
068 /**
069 * Sets the "java-class" property.
070 * <p>
071 * Specifies the fully-qualified name of the Java class that
072 * provides the password validator implementation.
073 *
074 * @param value The value of the "java-class" property.
075 * @throws IllegalPropertyValueException
076 * If the new value is invalid.
077 */
078 void setJavaClass(String value) throws IllegalPropertyValueException;
079
080
081
082 /**
083 * Gets the "min-password-difference" property.
084 * <p>
085 * Specifies the minimum difference of new and old password.
086 * <p>
087 * A value of zero indicates that no difference between passwords is
088 * acceptable.
089 *
090 * @return Returns the value of the "min-password-difference" property.
091 */
092 Integer getMinPasswordDifference();
093
094
095
096 /**
097 * Sets the "min-password-difference" property.
098 * <p>
099 * Specifies the minimum difference of new and old password.
100 * <p>
101 * A value of zero indicates that no difference between passwords is
102 * acceptable.
103 *
104 * @param value The value of the "min-password-difference" property.
105 * @throws IllegalPropertyValueException
106 * If the new value is invalid.
107 */
108 void setMinPasswordDifference(int value) throws IllegalPropertyValueException;
109
110 }