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