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.client;
027
028
029
030import org.opends.server.admin.ManagedObjectDefinition;
031import org.opends.server.admin.PropertyException;
032import org.opends.server.admin.std.server.PlainSASLMechanismHandlerCfg;
033
034
035
036/**
037 * A client-side interface for reading and modifying Plain SASL
038 * Mechanism Handler settings.
039 * <p>
040 * The Plain SASL Mechanism Handler performs all processing related to
041 * SASL PLAIN authentication.
042 */
043public interface PlainSASLMechanismHandlerCfgClient extends SASLMechanismHandlerCfgClient {
044
045  /**
046   * Get the configuration definition associated with this Plain SASL Mechanism Handler.
047   *
048   * @return Returns the configuration definition associated with this Plain SASL Mechanism Handler.
049   */
050  ManagedObjectDefinition<? extends PlainSASLMechanismHandlerCfgClient, ? extends PlainSASLMechanismHandlerCfg> definition();
051
052
053
054  /**
055   * Gets the "identity-mapper" property.
056   * <p>
057   * Specifies the name of the identity mapper that is to be used with
058   * this SASL mechanism handler to match the authentication or
059   * authorization ID included in the SASL bind request to the
060   * corresponding user in the directory.
061   *
062   * @return Returns the value of the "identity-mapper" property.
063   */
064  String getIdentityMapper();
065
066
067
068  /**
069   * Sets the "identity-mapper" property.
070   * <p>
071   * Specifies the name of the identity mapper that is to be used with
072   * this SASL mechanism handler to match the authentication or
073   * authorization ID included in the SASL bind request to the
074   * corresponding user in the directory.
075   *
076   * @param value The value of the "identity-mapper" property.
077   * @throws PropertyException
078   *           If the new value is invalid.
079   */
080  void setIdentityMapper(String value) throws PropertyException;
081
082
083
084  /**
085   * Gets the "java-class" property.
086   * <p>
087   * Specifies the fully-qualified name of the Java class that
088   * provides the SASL mechanism handler implementation.
089   *
090   * @return Returns the value of the "java-class" property.
091   */
092  String getJavaClass();
093
094
095
096  /**
097   * Sets the "java-class" property.
098   * <p>
099   * Specifies the fully-qualified name of the Java class that
100   * provides the SASL mechanism handler implementation.
101   *
102   * @param value The value of the "java-class" property.
103   * @throws PropertyException
104   *           If the new value is invalid.
105   */
106  void setJavaClass(String value) throws PropertyException;
107
108}