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 java.util.SortedSet; 031import org.opends.server.admin.server.ConfigurationChangeListener; 032import org.opends.server.types.AttributeType; 033import org.opends.server.types.DN; 034 035 036 037/** 038 * A server-side interface for querying Exact Match Identity Mapper 039 * settings. 040 * <p> 041 * The Exact Match Identity Mapper maps an identifier string to user 042 * entries by searching for the entry containing a specified attribute 043 * whose value is the provided identifier. For example, the username 044 * provided by the client for DIGEST-MD5 authentication must match the 045 * value of the uid attribute 046 */ 047public interface ExactMatchIdentityMapperCfg extends IdentityMapperCfg { 048 049 /** 050 * Gets the configuration class associated with this Exact Match Identity Mapper. 051 * 052 * @return Returns the configuration class associated with this Exact Match Identity Mapper. 053 */ 054 Class<? extends ExactMatchIdentityMapperCfg> configurationClass(); 055 056 057 058 /** 059 * Register to be notified when this Exact Match Identity Mapper is changed. 060 * 061 * @param listener 062 * The Exact Match Identity Mapper configuration change listener. 063 */ 064 void addExactMatchChangeListener(ConfigurationChangeListener<ExactMatchIdentityMapperCfg> listener); 065 066 067 068 /** 069 * Deregister an existing Exact Match Identity Mapper configuration change listener. 070 * 071 * @param listener 072 * The Exact Match Identity Mapper configuration change listener. 073 */ 074 void removeExactMatchChangeListener(ConfigurationChangeListener<ExactMatchIdentityMapperCfg> listener); 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 Exact Match Identity Mapper implementation. 083 * 084 * @return Returns the value of the "java-class" property. 085 */ 086 String getJavaClass(); 087 088 089 090 /** 091 * Gets the "match-attribute" property. 092 * <p> 093 * Specifies the attribute whose value should exactly match the ID 094 * string provided to this identity mapper. 095 * <p> 096 * At least one value must be provided. All values must refer to the 097 * name or OID of an attribute type defined in the directory server 098 * schema. If multiple attributes or OIDs are provided, at least one 099 * of those attributes must contain the provided ID string value in 100 * exactly one entry. The internal search performed includes a 101 * logical OR across all of these values. 102 * 103 * @return Returns an unmodifiable set containing the values of the "match-attribute" property. 104 */ 105 SortedSet<AttributeType> getMatchAttribute(); 106 107 108 109 /** 110 * Gets the "match-base-dn" property. 111 * <p> 112 * Specifies the set of base DNs below which to search for users. 113 * <p> 114 * The base DNs will be used when performing searches to map the 115 * provided ID string to a user entry. If multiple values are given, 116 * searches are performed below all specified base DNs. 117 * 118 * @return Returns an unmodifiable set containing the values of the "match-base-dn" property. 119 */ 120 SortedSet<DN> getMatchBaseDN(); 121 122}