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 java.util.SortedSet;
032    import org.opends.server.admin.server.ConfigurationChangeListener;
033    import org.opends.server.types.AttributeType;
034    
035    
036    
037    /**
038     * A server-side interface for querying Attribute Value Password
039     * Validator settings.
040     * <p>
041     * The Attribute Value Password Validator attempts to determine
042     * whether a proposed password is acceptable for use by determining
043     * whether that password is contained in any attribute within the
044     * user's entry.
045     */
046    public interface AttributeValuePasswordValidatorCfg extends PasswordValidatorCfg {
047    
048      /**
049       * Gets the configuration class associated with this Attribute Value Password Validator.
050       *
051       * @return Returns the configuration class associated with this Attribute Value Password Validator.
052       */
053      Class<? extends AttributeValuePasswordValidatorCfg> configurationClass();
054    
055    
056    
057      /**
058       * Register to be notified when this Attribute Value Password Validator is changed.
059       *
060       * @param listener
061       *          The Attribute Value Password Validator configuration change listener.
062       */
063      void addAttributeValueChangeListener(ConfigurationChangeListener<AttributeValuePasswordValidatorCfg> listener);
064    
065    
066    
067      /**
068       * Deregister an existing Attribute Value Password Validator configuration change listener.
069       *
070       * @param listener
071       *          The Attribute Value Password Validator configuration change listener.
072       */
073      void removeAttributeValueChangeListener(ConfigurationChangeListener<AttributeValuePasswordValidatorCfg> listener);
074    
075    
076    
077      /**
078       * Gets the "java-class" property.
079       * <p>
080       * Specifies the fully-qualified name of the Java class that
081       * provides the password validator implementation.
082       *
083       * @return Returns the value of the "java-class" property.
084       */
085      String getJavaClass();
086    
087    
088    
089      /**
090       * Gets the "match-attribute" property.
091       * <p>
092       * Specifies the name(s) of the attribute(s) whose values should be
093       * checked to determine whether they match the provided password. If
094       * no values are provided, then the server checks if the proposed
095       * password matches the value of any attribute in the user's entry.
096       *
097       * @return Returns an unmodifiable set containing the values of the "match-attribute" property.
098       */
099      SortedSet<AttributeType> getMatchAttribute();
100    
101    
102    
103      /**
104       * Gets the "test-reversed-password" property.
105       * <p>
106       * Indicates whether this password validator should test the
107       * reversed value of the provided password as well as the order in
108       * which it was given.
109       *
110       * @return Returns the value of the "test-reversed-password" property.
111       */
112      boolean isTestReversedPassword();
113    
114    }