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 legal-notices/CDDLv1_0.txt 010 * or http://forgerock.org/license/CDDLv1.0.html. 011 * See the License for the specific language governing permissions 012 * and limitations under the License. 013 * 014 * When distributing Covered Code, include this CDDL HEADER in each 015 * file and include the License file at legal-notices/CDDLv1_0.txt. 016 * If applicable, add the following below this CDDL HEADER, with the 017 * fields enclosed by brackets "[]" replaced with your own identifying 018 * information: 019 * Portions Copyright [yyyy] [name of copyright owner] 020 * 021 * CDDL HEADER END 022 * 023 * 024 * Copyright 2008 Sun Microsystems, Inc. 025 */ 026package org.opends.server.admin.std.server; 027 028 029 030import org.opends.server.admin.server.ConfigurationChangeListener; 031import org.opends.server.types.DN; 032 033 034 035/** 036 * A server-side interface for querying Cram MD5 SASL Mechanism 037 * Handler settings. 038 * <p> 039 * The CRAM-MD5 SASL mechanism provides the ability for clients to 040 * perform password-based authentication in a manner that does not 041 * expose their password in the clear. 042 */ 043public interface CramMD5SASLMechanismHandlerCfg extends SASLMechanismHandlerCfg { 044 045 /** 046 * Gets the configuration class associated with this Cram MD5 SASL Mechanism Handler. 047 * 048 * @return Returns the configuration class associated with this Cram MD5 SASL Mechanism Handler. 049 */ 050 Class<? extends CramMD5SASLMechanismHandlerCfg> configurationClass(); 051 052 053 054 /** 055 * Register to be notified when this Cram MD5 SASL Mechanism Handler is changed. 056 * 057 * @param listener 058 * The Cram MD5 SASL Mechanism Handler configuration change listener. 059 */ 060 void addCramMD5ChangeListener(ConfigurationChangeListener<CramMD5SASLMechanismHandlerCfg> listener); 061 062 063 064 /** 065 * Deregister an existing Cram MD5 SASL Mechanism Handler configuration change listener. 066 * 067 * @param listener 068 * The Cram MD5 SASL Mechanism Handler configuration change listener. 069 */ 070 void removeCramMD5ChangeListener(ConfigurationChangeListener<CramMD5SASLMechanismHandlerCfg> listener); 071 072 073 074 /** 075 * Gets the "identity-mapper" property. 076 * <p> 077 * Specifies the name of the identity mapper used with this SASL 078 * mechanism handler to match the authentication ID included in the 079 * SASL bind request to the corresponding user in the directory. 080 * 081 * @return Returns the value of the "identity-mapper" property. 082 */ 083 String getIdentityMapper(); 084 085 086 087 /** 088 * Gets the "identity-mapper" property as a DN. 089 * <p> 090 * Specifies the name of the identity mapper used with this SASL 091 * mechanism handler to match the authentication ID included in the 092 * SASL bind request to the corresponding user in the directory. 093 * 094 * @return Returns the DN value of the "identity-mapper" property. 095 */ 096 DN getIdentityMapperDN(); 097 098 099 100 /** 101 * Gets the "java-class" property. 102 * <p> 103 * Specifies the fully-qualified name of the Java class that 104 * provides the SASL mechanism handler implementation. 105 * 106 * @return Returns the value of the "java-class" property. 107 */ 108 String getJavaClass(); 109 110}