001/* 002 * The contents of this file are subject to the terms of the Common Development and 003 * Distribution License (the License). You may not use this file except in compliance with the 004 * License. 005 * 006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the 007 * specific language governing permission and limitations under the License. 008 * 009 * When distributing Covered Software, include this CDDL Header Notice in each file and include 010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL 011 * Header, with the fields enclosed by brackets [] replaced by your own identifying 012 * information: "Portions Copyright [year] [name of copyright owner]". 013 * 014 * Copyright 2008 Sun Microsystems, Inc. 015 */ 016package org.forgerock.opendj.server.config.client; 017 018 019 020import org.forgerock.opendj.config.ManagedObjectDefinition; 021import org.forgerock.opendj.config.PropertyException; 022import org.forgerock.opendj.server.config.server.CramMD5SASLMechanismHandlerCfg; 023 024 025 026/** 027 * A client-side interface for reading and modifying Cram MD5 SASL 028 * Mechanism Handler settings. 029 * <p> 030 * The CRAM-MD5 SASL mechanism provides the ability for clients to 031 * perform password-based authentication in a manner that does not 032 * expose their password in the clear. 033 */ 034public interface CramMD5SASLMechanismHandlerCfgClient extends SASLMechanismHandlerCfgClient { 035 036 /** 037 * Get the configuration definition associated with this Cram MD5 SASL Mechanism Handler. 038 * 039 * @return Returns the configuration definition associated with this Cram MD5 SASL Mechanism Handler. 040 */ 041 ManagedObjectDefinition<? extends CramMD5SASLMechanismHandlerCfgClient, ? extends CramMD5SASLMechanismHandlerCfg> definition(); 042 043 044 045 /** 046 * Gets the "identity-mapper" property. 047 * <p> 048 * Specifies the name of the identity mapper used with this SASL 049 * mechanism handler to match the authentication ID included in the 050 * SASL bind request to the corresponding user in the directory. 051 * 052 * @return Returns the value of the "identity-mapper" property. 053 */ 054 String getIdentityMapper(); 055 056 057 058 /** 059 * Sets the "identity-mapper" property. 060 * <p> 061 * Specifies the name of the identity mapper used with this SASL 062 * mechanism handler to match the authentication ID included in the 063 * SASL bind request to the corresponding user in the directory. 064 * 065 * @param value The value of the "identity-mapper" property. 066 * @throws PropertyException 067 * If the new value is invalid. 068 */ 069 void setIdentityMapper(String value) throws PropertyException; 070 071 072 073 /** 074 * Gets the "java-class" property. 075 * <p> 076 * Specifies the fully-qualified name of the Java class that 077 * provides the SASL mechanism handler implementation. 078 * 079 * @return Returns the value of the "java-class" property. 080 */ 081 String getJavaClass(); 082 083 084 085 /** 086 * Sets 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 * @param value The value of the "java-class" property. 092 * @throws PropertyException 093 * If the new value is invalid. 094 */ 095 void setJavaClass(String value) throws PropertyException; 096 097}