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.ConfigurationClient;
031import org.opends.server.admin.ManagedObjectDefinition;
032import org.opends.server.admin.PropertyException;
033import org.opends.server.admin.std.server.IdentityMapperCfg;
034
035
036
037/**
038 * A client-side interface for reading and modifying Identity Mapper
039 * settings.
040 * <p>
041 * Identity Mappers are responsible for establishing a mapping between
042 * an identifier string provided by a client, and the entry for the
043 * user that corresponds to that identifier. Identity Mappers are used
044 * to process several SASL mechanisms to map an authorization ID (e.g.,
045 * a Kerberos principal when using GSSAPI) to a directory user. They
046 * are also used when processing requests with the proxied
047 * authorization control.
048 */
049public interface IdentityMapperCfgClient extends ConfigurationClient {
050
051  /**
052   * Get the configuration definition associated with this Identity Mapper.
053   *
054   * @return Returns the configuration definition associated with this Identity Mapper.
055   */
056  ManagedObjectDefinition<? extends IdentityMapperCfgClient, ? extends IdentityMapperCfg> definition();
057
058
059
060  /**
061   * Gets the "enabled" property.
062   * <p>
063   * Indicates whether the Identity Mapper is enabled for use.
064   *
065   * @return Returns the value of the "enabled" property.
066   */
067  Boolean isEnabled();
068
069
070
071  /**
072   * Sets the "enabled" property.
073   * <p>
074   * Indicates whether the Identity Mapper is enabled for use.
075   *
076   * @param value The value of the "enabled" property.
077   * @throws PropertyException
078   *           If the new value is invalid.
079   */
080  void setEnabled(boolean 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 Identity Mapper 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 Identity Mapper 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}