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.Configuration;
032    import org.opends.server.admin.server.ConfigurationChangeListener;
033    
034    
035    
036    /**
037     * A server-side interface for querying Identity Mapper settings.
038     * <p>
039     * Identity Mappers are responsible for establishing a mapping between
040     * an identifier string provided by a client, and the entry for the
041     * user that corresponds to that identifier. Identity Mappers are used
042     * to process several SASL mechanisms to map an authorization ID (e.g.,
043     * a Kerberos principal when using GSSAPI) to a directory user. They
044     * are also used when processing requests with the proxied
045     * authorization control.
046     */
047    public interface IdentityMapperCfg extends Configuration {
048    
049      /**
050       * Gets the configuration class associated with this Identity Mapper.
051       *
052       * @return Returns the configuration class associated with this Identity Mapper.
053       */
054      Class<? extends IdentityMapperCfg> configurationClass();
055    
056    
057    
058      /**
059       * Register to be notified when this Identity Mapper is changed.
060       *
061       * @param listener
062       *          The Identity Mapper configuration change listener.
063       */
064      void addChangeListener(ConfigurationChangeListener<IdentityMapperCfg> listener);
065    
066    
067    
068      /**
069       * Deregister an existing Identity Mapper configuration change listener.
070       *
071       * @param listener
072       *          The Identity Mapper configuration change listener.
073       */
074      void removeChangeListener(ConfigurationChangeListener<IdentityMapperCfg> listener);
075    
076    
077    
078      /**
079       * Gets the "enabled" property.
080       * <p>
081       * Indicates whether the Identity Mapper is enabled for use.
082       *
083       * @return Returns the value of the "enabled" property.
084       */
085      boolean isEnabled();
086    
087    
088    
089      /**
090       * Gets the "java-class" property.
091       * <p>
092       * Specifies the fully-qualified name of the Java class that
093       * provides the Identity Mapper implementation.
094       *
095       * @return Returns the value of the "java-class" property.
096       */
097      String getJavaClass();
098    
099    }