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.server; 028 029 030 031 import org.opends.server.admin.server.ConfigurationChangeListener; 032 033 034 035 /** 036 * A server-side interface for querying Dictionary Password Validator 037 * settings. 038 * <p> 039 * The Dictionary Password Validator determines whether a proposed 040 * password is acceptable based on whether the given password value 041 * appears in a provided dictionary file. 042 */ 043 public interface DictionaryPasswordValidatorCfg extends PasswordValidatorCfg { 044 045 /** 046 * Gets the configuration class associated with this Dictionary Password Validator. 047 * 048 * @return Returns the configuration class associated with this Dictionary Password Validator. 049 */ 050 Class<? extends DictionaryPasswordValidatorCfg> configurationClass(); 051 052 053 054 /** 055 * Register to be notified when this Dictionary Password Validator is changed. 056 * 057 * @param listener 058 * The Dictionary Password Validator configuration change listener. 059 */ 060 void addDictionaryChangeListener(ConfigurationChangeListener<DictionaryPasswordValidatorCfg> listener); 061 062 063 064 /** 065 * Deregister an existing Dictionary Password Validator configuration change listener. 066 * 067 * @param listener 068 * The Dictionary Password Validator configuration change listener. 069 */ 070 void removeDictionaryChangeListener(ConfigurationChangeListener<DictionaryPasswordValidatorCfg> listener); 071 072 073 074 /** 075 * Gets the "case-sensitive-validation" property. 076 * <p> 077 * Indicates whether this password validator is to treat password 078 * characters in a case-sensitive manner. 079 * <p> 080 * If it is set to true, then the validator rejects a password only 081 * if it appears in the dictionary with exactly the same 082 * capitalization as provided by the user. 083 * 084 * @return Returns the value of the "case-sensitive-validation" property. 085 */ 086 boolean isCaseSensitiveValidation(); 087 088 089 090 /** 091 * Gets the "dictionary-file" property. 092 * <p> 093 * Specifies the path to the file containing a list of words that 094 * cannot be used as passwords. 095 * <p> 096 * It should be formatted with one word per line. The value can be 097 * an absolute path or a path that is relative to the OpenDS 098 * Directory Server instance root. 099 * 100 * @return Returns the value of the "dictionary-file" property. 101 */ 102 String getDictionaryFile(); 103 104 105 106 /** 107 * Gets the "java-class" property. 108 * <p> 109 * Specifies the fully-qualified name of the Java class that 110 * provides the password validator implementation. 111 * 112 * @return Returns the value of the "java-class" property. 113 */ 114 String getJavaClass(); 115 116 117 118 /** 119 * Gets the "test-reversed-password" property. 120 * <p> 121 * Indicates whether this password validator is to test the reversed 122 * value of the provided password as well as the order in which it 123 * was given. 124 * <p> 125 * For example, if the user provides a new password of "password" 126 * and this configuration attribute is set to true, then the value 127 * "drowssap" is also tested against attribute values in the user's 128 * entry. 129 * 130 * @return Returns the value of the "test-reversed-password" property. 131 */ 132 boolean isTestReversedPassword(); 133 134 }