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.server; 017 018 019 020import org.forgerock.opendj.config.server.ConfigurationChangeListener; 021import org.forgerock.opendj.ldap.DN; 022 023 024 025/** 026 * A server-side interface for querying Cram MD5 SASL Mechanism 027 * Handler settings. 028 * <p> 029 * The CRAM-MD5 SASL mechanism provides the ability for clients to 030 * perform password-based authentication in a manner that does not 031 * expose their password in the clear. 032 */ 033public interface CramMD5SASLMechanismHandlerCfg extends SASLMechanismHandlerCfg { 034 035 /** 036 * Gets the configuration class associated with this Cram MD5 SASL Mechanism Handler. 037 * 038 * @return Returns the configuration class associated with this Cram MD5 SASL Mechanism Handler. 039 */ 040 Class<? extends CramMD5SASLMechanismHandlerCfg> configurationClass(); 041 042 043 044 /** 045 * Register to be notified when this Cram MD5 SASL Mechanism Handler is changed. 046 * 047 * @param listener 048 * The Cram MD5 SASL Mechanism Handler configuration change listener. 049 */ 050 void addCramMD5ChangeListener(ConfigurationChangeListener<CramMD5SASLMechanismHandlerCfg> listener); 051 052 053 054 /** 055 * Deregister an existing Cram MD5 SASL Mechanism Handler configuration change listener. 056 * 057 * @param listener 058 * The Cram MD5 SASL Mechanism Handler configuration change listener. 059 */ 060 void removeCramMD5ChangeListener(ConfigurationChangeListener<CramMD5SASLMechanismHandlerCfg> listener); 061 062 063 064 /** 065 * Gets the "identity-mapper" property. 066 * <p> 067 * Specifies the name of the identity mapper used with this SASL 068 * mechanism handler to match the authentication ID included in the 069 * SASL bind request to the corresponding user in the directory. 070 * 071 * @return Returns the value of the "identity-mapper" property. 072 */ 073 String getIdentityMapper(); 074 075 076 077 /** 078 * Gets the "identity-mapper" property as a DN. 079 * <p> 080 * Specifies the name of the identity mapper used with this SASL 081 * mechanism handler to match the authentication ID included in the 082 * SASL bind request to the corresponding user in the directory. 083 * 084 * @return Returns the DN value of the "identity-mapper" property. 085 */ 086 DN getIdentityMapperDN(); 087 088 089 090 /** 091 * Gets the "java-class" property. 092 * <p> 093 * Specifies the fully-qualified name of the Java class that 094 * provides the SASL mechanism handler implementation. 095 * 096 * @return Returns the value of the "java-class" property. 097 */ 098 String getJavaClass(); 099 100}