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