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.server;
017
018
019
020import org.forgerock.opendj.config.Configuration;
021import org.forgerock.opendj.config.server.ConfigurationChangeListener;
022
023
024
025/**
026 * A server-side interface for querying Password Validator settings.
027 * <p>
028 * Password Validators are responsible for determining whether a
029 * proposed password is acceptable for use and could include checks
030 * like ensuring it meets minimum length requirements, that it has an
031 * appropriate range of characters, or that it is not in the history.
032 */
033public interface PasswordValidatorCfg extends Configuration {
034
035  /**
036   * Gets the configuration class associated with this Password Validator.
037   *
038   * @return Returns the configuration class associated with this Password Validator.
039   */
040  Class<? extends PasswordValidatorCfg> configurationClass();
041
042
043
044  /**
045   * Register to be notified when this Password Validator is changed.
046   *
047   * @param listener
048   *          The Password Validator configuration change listener.
049   */
050  void addChangeListener(ConfigurationChangeListener<PasswordValidatorCfg> listener);
051
052
053
054  /**
055   * Deregister an existing Password Validator configuration change listener.
056   *
057   * @param listener
058   *          The Password Validator configuration change listener.
059   */
060  void removeChangeListener(ConfigurationChangeListener<PasswordValidatorCfg> listener);
061
062
063
064  /**
065   * Gets the "enabled" property.
066   * <p>
067   * Indicates whether the password validator is enabled for use.
068   *
069   * @return Returns the value of the "enabled" property.
070   */
071  boolean isEnabled();
072
073
074
075  /**
076   * Gets the "java-class" property.
077   * <p>
078   * Specifies the fully-qualified name of the Java class that
079   * provides the password validator implementation.
080   *
081   * @return Returns the value of the "java-class" property.
082   */
083  String getJavaClass();
084
085}