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.CramMD5SASLMechanismHandlerCfg;
033
034
035
036/**
037 * A client-side interface for reading and modifying Cram MD5 SASL
038 * Mechanism 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 */
044public interface CramMD5SASLMechanismHandlerCfgClient extends SASLMechanismHandlerCfgClient {
045
046  /**
047   * Get the configuration definition associated with this Cram MD5 SASL Mechanism Handler.
048   *
049   * @return Returns the configuration definition associated with this Cram MD5 SASL Mechanism Handler.
050   */
051  ManagedObjectDefinition<? extends CramMD5SASLMechanismHandlerCfgClient, ? extends CramMD5SASLMechanismHandlerCfg> definition();
052
053
054
055  /**
056   * Gets the "identity-mapper" property.
057   * <p>
058   * Specifies the name of the identity mapper used with this SASL
059   * mechanism handler to match the authentication ID included in the
060   * SASL bind request to the 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 used with this SASL
072   * mechanism handler to match the authentication ID included in the
073   * SASL bind request to the corresponding user in the directory.
074   *
075   * @param value The value of the "identity-mapper" property.
076   * @throws PropertyException
077   *           If the new value is invalid.
078   */
079  void setIdentityMapper(String value) throws PropertyException;
080
081
082
083  /**
084   * Gets the "java-class" property.
085   * <p>
086   * Specifies the fully-qualified name of the Java class that
087   * provides the SASL mechanism handler implementation.
088   *
089   * @return Returns the value of the "java-class" property.
090   */
091  String getJavaClass();
092
093
094
095  /**
096   * Sets the "java-class" property.
097   * <p>
098   * Specifies the fully-qualified name of the Java class that
099   * provides the SASL mechanism handler implementation.
100   *
101   * @param value The value of the "java-class" property.
102   * @throws PropertyException
103   *           If the new value is invalid.
104   */
105  void setJavaClass(String value) throws PropertyException;
106
107}