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.IllegalPropertyValueException; 032 import org.opends.server.admin.ManagedObjectDefinition; 033 import org.opends.server.admin.std.server.PlainSASLMechanismHandlerCfg; 034 035 036 037 /** 038 * A client-side interface for reading and modifying Plain SASL 039 * Mechanism Handler settings. 040 * <p> 041 * The Plain SASL Mechanism Handler performs all processing related to 042 * SASL PLAIN authentication. 043 */ 044 public interface PlainSASLMechanismHandlerCfgClient extends SASLMechanismHandlerCfgClient { 045 046 /** 047 * Get the configuration definition associated with this Plain SASL Mechanism Handler. 048 * 049 * @return Returns the configuration definition associated with this Plain SASL Mechanism Handler. 050 */ 051 ManagedObjectDefinition<? extends PlainSASLMechanismHandlerCfgClient, ? extends PlainSASLMechanismHandlerCfg> definition(); 052 053 054 055 /** 056 * Gets the "identity-mapper" property. 057 * <p> 058 * Specifies the name of the identity mapper that is to be used with 059 * this SASL mechanism handler to match the authentication or 060 * authorization ID included in the SASL bind request to the 061 * corresponding user in the directory. 062 * 063 * @return Returns the value of the "identity-mapper" property. 064 */ 065 String getIdentityMapper(); 066 067 068 069 /** 070 * Sets the "identity-mapper" property. 071 * <p> 072 * Specifies the name of the identity mapper that is to be used with 073 * this SASL mechanism handler to match the authentication or 074 * authorization ID included in the SASL bind request to the 075 * corresponding user in the directory. 076 * 077 * @param value The value of the "identity-mapper" property. 078 * @throws IllegalPropertyValueException 079 * If the new value is invalid. 080 */ 081 void setIdentityMapper(String 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 SASL mechanism handler 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 SASL mechanism handler 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 }