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 010 * trunk/opends/resource/legal-notices/OpenDS.LICENSE 011 * or https://OpenDS.dev.java.net/OpenDS.LICENSE. 012 * See the License for the specific language governing permissions 013 * and limitations under the License. 014 * 015 * When distributing Covered Code, include this CDDL HEADER in each 016 * file and include the License file at 017 * trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable, 018 * add the following below this CDDL HEADER, with the fields enclosed 019 * by brackets "[]" replaced with your own identifying information: 020 * Portions Copyright [yyyy] [name of copyright owner] 021 * 022 * CDDL HEADER END 023 * 024 * 025 * Copyright 2008 Sun Microsystems, Inc. 026 */ 027 package org.opends.server.admin.std.client; 028 029 030 031 import org.opends.server.admin.ConfigurationClient; 032 import org.opends.server.admin.IllegalPropertyValueException; 033 import org.opends.server.admin.ManagedObjectDefinition; 034 import org.opends.server.admin.std.server.IdentityMapperCfg; 035 036 037 038 /** 039 * A client-side interface for reading and modifying Identity Mapper 040 * settings. 041 * <p> 042 * Identity Mappers are responsible for establishing a mapping between 043 * an identifier string provided by a client, and the entry for the 044 * user that corresponds to that identifier. Identity Mappers are used 045 * to process several SASL mechanisms to map an authorization ID (e.g., 046 * a Kerberos principal when using GSSAPI) to a directory user. They 047 * are also used when processing requests with the proxied 048 * authorization control. 049 */ 050 public interface IdentityMapperCfgClient extends ConfigurationClient { 051 052 /** 053 * Get the configuration definition associated with this Identity Mapper. 054 * 055 * @return Returns the configuration definition associated with this Identity Mapper. 056 */ 057 ManagedObjectDefinition<? extends IdentityMapperCfgClient, ? extends IdentityMapperCfg> definition(); 058 059 060 061 /** 062 * Gets the "enabled" property. 063 * <p> 064 * Indicates whether the Identity Mapper is enabled for use. 065 * 066 * @return Returns the value of the "enabled" property. 067 */ 068 Boolean isEnabled(); 069 070 071 072 /** 073 * Sets the "enabled" property. 074 * <p> 075 * Indicates whether the Identity Mapper is enabled for use. 076 * 077 * @param value The value of the "enabled" property. 078 * @throws IllegalPropertyValueException 079 * If the new value is invalid. 080 */ 081 void setEnabled(boolean value) throws IllegalPropertyValueException; 082 083 084 085 /** 086 * Gets the "java-class" property. 087 * <p> 088 * Specifies the fully-qualified name of the Java class that 089 * provides the Identity Mapper implementation. 090 * 091 * @return Returns the value of the "java-class" property. 092 */ 093 String getJavaClass(); 094 095 096 097 /** 098 * Sets the "java-class" property. 099 * <p> 100 * Specifies the fully-qualified name of the Java class that 101 * provides the Identity Mapper implementation. 102 * 103 * @param value The value of the "java-class" property. 104 * @throws IllegalPropertyValueException 105 * If the new value is invalid. 106 */ 107 void setJavaClass(String value) throws IllegalPropertyValueException; 108 109 }