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.CramMD5SASLMechanismHandlerCfg; 034 035 036 037 /** 038 * A client-side interface for reading and modifying Cram MD5 SASL 039 * Mechanism Handler settings. 040 * <p> 041 * The CRAM-MD5 SASL mechanism provides the ability for clients to 042 * perform password-based authentication in a manner that does not 043 * expose their password in the clear. 044 */ 045 public interface CramMD5SASLMechanismHandlerCfgClient extends SASLMechanismHandlerCfgClient { 046 047 /** 048 * Get the configuration definition associated with this Cram MD5 SASL Mechanism Handler. 049 * 050 * @return Returns the configuration definition associated with this Cram MD5 SASL Mechanism Handler. 051 */ 052 ManagedObjectDefinition<? extends CramMD5SASLMechanismHandlerCfgClient, ? extends CramMD5SASLMechanismHandlerCfg> definition(); 053 054 055 056 /** 057 * Gets the "identity-mapper" property. 058 * <p> 059 * Specifies the name of the identity mapper used with this SASL 060 * mechanism handler to match the authentication ID included in the 061 * SASL bind request to the 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 used with this SASL 073 * mechanism handler to match the authentication ID included in the 074 * SASL bind request to the corresponding user in the directory. 075 * 076 * @param value The value of the "identity-mapper" property. 077 * @throws IllegalPropertyValueException 078 * If the new value is invalid. 079 */ 080 void setIdentityMapper(String value) throws IllegalPropertyValueException; 081 082 083 084 /** 085 * Gets the "java-class" property. 086 * <p> 087 * Specifies the fully-qualified name of the Java class that 088 * provides the SASL mechanism handler implementation. 089 * 090 * @return Returns the value of the "java-class" property. 091 */ 092 String getJavaClass(); 093 094 095 096 /** 097 * Sets the "java-class" property. 098 * <p> 099 * Specifies the fully-qualified name of the Java class that 100 * provides the SASL mechanism handler implementation. 101 * 102 * @param value The value of the "java-class" property. 103 * @throws IllegalPropertyValueException 104 * If the new value is invalid. 105 */ 106 void setJavaClass(String value) throws IllegalPropertyValueException; 107 108 }