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.server; 017 018 019 020import org.forgerock.opendj.config.Configuration; 021import org.forgerock.opendj.config.server.ConfigurationChangeListener; 022 023 024 025/** 026 * A server-side interface for querying Identity Mapper settings. 027 * <p> 028 * Identity Mappers are responsible for establishing a mapping between 029 * an identifier string provided by a client, and the entry for the 030 * user that corresponds to that identifier. Identity Mappers are used 031 * to process several SASL mechanisms to map an authorization ID (e.g., 032 * a Kerberos principal when using GSSAPI) to a directory user. They 033 * are also used when processing requests with the proxied 034 * authorization control. 035 */ 036public interface IdentityMapperCfg extends Configuration { 037 038 /** 039 * Gets the configuration class associated with this Identity Mapper. 040 * 041 * @return Returns the configuration class associated with this Identity Mapper. 042 */ 043 Class<? extends IdentityMapperCfg> configurationClass(); 044 045 046 047 /** 048 * Register to be notified when this Identity Mapper is changed. 049 * 050 * @param listener 051 * The Identity Mapper configuration change listener. 052 */ 053 void addChangeListener(ConfigurationChangeListener<IdentityMapperCfg> listener); 054 055 056 057 /** 058 * Deregister an existing Identity Mapper configuration change listener. 059 * 060 * @param listener 061 * The Identity Mapper configuration change listener. 062 */ 063 void removeChangeListener(ConfigurationChangeListener<IdentityMapperCfg> listener); 064 065 066 067 /** 068 * Gets the "enabled" property. 069 * <p> 070 * Indicates whether the Identity Mapper is enabled for use. 071 * 072 * @return Returns the value of the "enabled" property. 073 */ 074 boolean isEnabled(); 075 076 077 078 /** 079 * Gets the "java-class" property. 080 * <p> 081 * Specifies the fully-qualified name of the Java class that 082 * provides the Identity Mapper implementation. 083 * 084 * @return Returns the value of the "java-class" property. 085 */ 086 String getJavaClass(); 087 088}