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    import org.opends.server.types.DN;
033    
034    
035    
036    /**
037     * A server-side interface for querying Cram MD5 SASL Mechanism
038     * Handler settings.
039     * <p>
040     * The CRAM-MD5 SASL mechanism provides the ability for clients to
041     * perform password-based authentication in a manner that does not
042     * expose their password in the clear.
043     */
044    public interface CramMD5SASLMechanismHandlerCfg extends SASLMechanismHandlerCfg {
045    
046      /**
047       * Gets the configuration class associated with this Cram MD5 SASL Mechanism Handler.
048       *
049       * @return Returns the configuration class associated with this Cram MD5 SASL Mechanism Handler.
050       */
051      Class<? extends CramMD5SASLMechanismHandlerCfg> configurationClass();
052    
053    
054    
055      /**
056       * Register to be notified when this Cram MD5 SASL Mechanism Handler is changed.
057       *
058       * @param listener
059       *          The Cram MD5 SASL Mechanism Handler configuration change listener.
060       */
061      void addCramMD5ChangeListener(ConfigurationChangeListener<CramMD5SASLMechanismHandlerCfg> listener);
062    
063    
064    
065      /**
066       * Deregister an existing Cram MD5 SASL Mechanism Handler configuration change listener.
067       *
068       * @param listener
069       *          The Cram MD5 SASL Mechanism Handler configuration change listener.
070       */
071      void removeCramMD5ChangeListener(ConfigurationChangeListener<CramMD5SASLMechanismHandlerCfg> listener);
072    
073    
074    
075      /**
076       * Gets the "identity-mapper" property.
077       * <p>
078       * Specifies the name of the identity mapper used with this SASL
079       * mechanism handler to match the authentication ID included in the
080       * SASL bind request to the corresponding user in the directory.
081       *
082       * @return Returns the value of the "identity-mapper" property.
083       */
084      String getIdentityMapper();
085    
086    
087    
088      /**
089       * Gets the "identity-mapper" property as a DN.
090       * <p>
091       * Specifies the name of the identity mapper used with this SASL
092       * mechanism handler to match the authentication ID included in the
093       * SASL bind request to the corresponding user in the directory.
094       *
095       * @return Returns the DN value of the "identity-mapper" property.
096       */
097      DN getIdentityMapperDN();
098    
099    
100    
101      /**
102       * Gets the "java-class" property.
103       * <p>
104       * Specifies the fully-qualified name of the Java class that
105       * provides the SASL mechanism handler implementation.
106       *
107       * @return Returns the value of the "java-class" property.
108       */
109      String getJavaClass();
110    
111    }