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 Digest MD5 SASL Mechanism
038     * Handler settings.
039     * <p>
040     * The DIGEST-MD5 SASL mechanism is used to perform all processing
041     * related to SASL DIGEST-MD5 authentication.
042     */
043    public interface DigestMD5SASLMechanismHandlerCfg extends SASLMechanismHandlerCfg {
044    
045      /**
046       * Gets the configuration class associated with this Digest MD5 SASL Mechanism Handler.
047       *
048       * @return Returns the configuration class associated with this Digest MD5 SASL Mechanism Handler.
049       */
050      Class<? extends DigestMD5SASLMechanismHandlerCfg> configurationClass();
051    
052    
053    
054      /**
055       * Register to be notified when this Digest MD5 SASL Mechanism Handler is changed.
056       *
057       * @param listener
058       *          The Digest MD5 SASL Mechanism Handler configuration change listener.
059       */
060      void addDigestMD5ChangeListener(ConfigurationChangeListener<DigestMD5SASLMechanismHandlerCfg> listener);
061    
062    
063    
064      /**
065       * Deregister an existing Digest MD5 SASL Mechanism Handler configuration change listener.
066       *
067       * @param listener
068       *          The Digest MD5 SASL Mechanism Handler configuration change listener.
069       */
070      void removeDigestMD5ChangeListener(ConfigurationChangeListener<DigestMD5SASLMechanismHandlerCfg> listener);
071    
072    
073    
074      /**
075       * Gets the "identity-mapper" property.
076       * <p>
077       * Specifies the name of the identity mapper that is to be used with
078       * this SASL mechanism handler to match the authentication or
079       * authorization ID included in the SASL bind request to the
080       * 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 that is to be used with
092       * this SASL mechanism handler to match the authentication or
093       * authorization ID included in the SASL bind request to the
094       * corresponding user in the directory.
095       *
096       * @return Returns the DN value of the "identity-mapper" property.
097       */
098      DN getIdentityMapperDN();
099    
100    
101    
102      /**
103       * Gets the "java-class" property.
104       * <p>
105       * Specifies the fully-qualified name of the Java class that
106       * provides the SASL mechanism handler implementation.
107       *
108       * @return Returns the value of the "java-class" property.
109       */
110      String getJavaClass();
111    
112    
113    
114      /**
115       * Gets the "realm" property.
116       * <p>
117       * Specifies the realm that is to be used by the server for
118       * DIGEST-MD5 authentication.
119       * <p>
120       * If this value is not provided, then the server defaults to use a
121       * set of realm names that correspond to the defined suffixes.
122       *
123       * @return Returns the value of the "realm" property.
124       */
125      String getRealm();
126    
127    
128    
129      /**
130       * Gets the "server-fqdn" property.
131       * <p>
132       * Specifies the DNS-resolvable fully-qualified domain name for the
133       * server that is used when validating the digest-uri parameter
134       * during the authentication process.
135       * <p>
136       * If this configuration attribute is present, then the server
137       * expects that clients use a digest-uri equal to "ldap/" followed by
138       * the value of this attribute. For example, if the attribute has a
139       * value of "directory.example.com", then the server expects clients
140       * to use a digest-uri of "ldap/directory.example.com". If no value
141       * is provided, then the server does not attempt to validate the
142       * digest-uri provided by the client and accepts any value.
143       *
144       * @return Returns the value of the "server-fqdn" property.
145       */
146      String getServerFqdn();
147    
148    }