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 legal-notices/CDDLv1_0.txt
010 * or http://forgerock.org/license/CDDLv1.0.html.
011 * See the License for the specific language governing permissions
012 * and limitations under the License.
013 *
014 * When distributing Covered Code, include this CDDL HEADER in each
015 * file and include the License file at legal-notices/CDDLv1_0.txt.
016 * If applicable, add the following below this CDDL HEADER, with the
017 * fields enclosed by brackets "[]" replaced with your own identifying
018 * information:
019 *      Portions Copyright [yyyy] [name of copyright owner]
020 *
021 * CDDL HEADER END
022 *
023 *
024 *      Copyright 2008 Sun Microsystems, Inc.
025 */
026package org.opends.server.admin.std.server;
027
028
029
030import org.opends.server.admin.server.ConfigurationChangeListener;
031import org.opends.server.types.DN;
032
033
034
035/**
036 * A server-side interface for querying Plain SASL Mechanism Handler
037 * settings.
038 * <p>
039 * The Plain SASL Mechanism Handler performs all processing related to
040 * SASL PLAIN authentication.
041 */
042public interface PlainSASLMechanismHandlerCfg extends SASLMechanismHandlerCfg {
043
044  /**
045   * Gets the configuration class associated with this Plain SASL Mechanism Handler.
046   *
047   * @return Returns the configuration class associated with this Plain SASL Mechanism Handler.
048   */
049  Class<? extends PlainSASLMechanismHandlerCfg> configurationClass();
050
051
052
053  /**
054   * Register to be notified when this Plain SASL Mechanism Handler is changed.
055   *
056   * @param listener
057   *          The Plain SASL Mechanism Handler configuration change listener.
058   */
059  void addPlainChangeListener(ConfigurationChangeListener<PlainSASLMechanismHandlerCfg> listener);
060
061
062
063  /**
064   * Deregister an existing Plain SASL Mechanism Handler configuration change listener.
065   *
066   * @param listener
067   *          The Plain SASL Mechanism Handler configuration change listener.
068   */
069  void removePlainChangeListener(ConfigurationChangeListener<PlainSASLMechanismHandlerCfg> listener);
070
071
072
073  /**
074   * Gets the "identity-mapper" property.
075   * <p>
076   * Specifies the name of the identity mapper that is to be used with
077   * this SASL mechanism handler to match the authentication or
078   * authorization ID included in the SASL bind request to the
079   * corresponding user in the directory.
080   *
081   * @return Returns the value of the "identity-mapper" property.
082   */
083  String getIdentityMapper();
084
085
086
087  /**
088   * Gets the "identity-mapper" property as a DN.
089   * <p>
090   * Specifies the name of the identity mapper that is to be used with
091   * this SASL mechanism handler to match the authentication or
092   * authorization ID included in the SASL bind request to the
093   * 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}