001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions Copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2008 Sun Microsystems, Inc.
015 */
016package org.forgerock.opendj.server.config.client;
017
018
019
020import org.forgerock.opendj.config.ManagedObjectDefinition;
021import org.forgerock.opendj.config.PropertyException;
022import org.forgerock.opendj.server.config.server.PlainSASLMechanismHandlerCfg;
023
024
025
026/**
027 * A client-side interface for reading and modifying Plain SASL
028 * Mechanism Handler settings.
029 * <p>
030 * The Plain SASL Mechanism Handler performs all processing related to
031 * SASL PLAIN authentication.
032 */
033public interface PlainSASLMechanismHandlerCfgClient extends SASLMechanismHandlerCfgClient {
034
035  /**
036   * Get the configuration definition associated with this Plain SASL Mechanism Handler.
037   *
038   * @return Returns the configuration definition associated with this Plain SASL Mechanism Handler.
039   */
040  ManagedObjectDefinition<? extends PlainSASLMechanismHandlerCfgClient, ? extends PlainSASLMechanismHandlerCfg> definition();
041
042
043
044  /**
045   * Gets the "identity-mapper" property.
046   * <p>
047   * Specifies the name of the identity mapper that is to be used with
048   * this SASL mechanism handler to match the authentication or
049   * authorization ID included in the SASL bind request to the
050   * corresponding user in the directory.
051   *
052   * @return Returns the value of the "identity-mapper" property.
053   */
054  String getIdentityMapper();
055
056
057
058  /**
059   * Sets the "identity-mapper" property.
060   * <p>
061   * Specifies the name of the identity mapper that is to be used with
062   * this SASL mechanism handler to match the authentication or
063   * authorization ID included in the SASL bind request to the
064   * corresponding user in the directory.
065   *
066   * @param value The value of the "identity-mapper" property.
067   * @throws PropertyException
068   *           If the new value is invalid.
069   */
070  void setIdentityMapper(String value) throws PropertyException;
071
072
073
074  /**
075   * Gets the "java-class" property.
076   * <p>
077   * Specifies the fully-qualified name of the Java class that
078   * provides the SASL mechanism handler implementation.
079   *
080   * @return Returns the value of the "java-class" property.
081   */
082  String getJavaClass();
083
084
085
086  /**
087   * Sets the "java-class" property.
088   * <p>
089   * Specifies the fully-qualified name of the Java class that
090   * provides the SASL mechanism handler implementation.
091   *
092   * @param value The value of the "java-class" property.
093   * @throws PropertyException
094   *           If the new value is invalid.
095   */
096  void setJavaClass(String value) throws PropertyException;
097
098}