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 Plain SASL Mechanism Handler 027 * settings. 028 * <p> 029 * The Plain SASL Mechanism Handler performs all processing related to 030 * SASL PLAIN authentication. 031 */ 032public interface PlainSASLMechanismHandlerCfg extends SASLMechanismHandlerCfg { 033 034 /** 035 * Gets the configuration class associated with this Plain SASL Mechanism Handler. 036 * 037 * @return Returns the configuration class associated with this Plain SASL Mechanism Handler. 038 */ 039 Class<? extends PlainSASLMechanismHandlerCfg> configurationClass(); 040 041 042 043 /** 044 * Register to be notified when this Plain SASL Mechanism Handler is changed. 045 * 046 * @param listener 047 * The Plain SASL Mechanism Handler configuration change listener. 048 */ 049 void addPlainChangeListener(ConfigurationChangeListener<PlainSASLMechanismHandlerCfg> listener); 050 051 052 053 /** 054 * Deregister an existing Plain SASL Mechanism Handler configuration change listener. 055 * 056 * @param listener 057 * The Plain SASL Mechanism Handler configuration change listener. 058 */ 059 void removePlainChangeListener(ConfigurationChangeListener<PlainSASLMechanismHandlerCfg> listener); 060 061 062 063 /** 064 * Gets the "identity-mapper" property. 065 * <p> 066 * Specifies the name of the identity mapper that is to be used with 067 * this SASL mechanism handler to match the authentication or 068 * authorization ID included in the SASL bind request to the 069 * 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 that is to be used with 081 * this SASL mechanism handler to match the authentication or 082 * authorization ID included in the SASL bind request to the 083 * corresponding user in the directory. 084 * 085 * @return Returns the DN value of the "identity-mapper" property. 086 */ 087 DN getIdentityMapperDN(); 088 089 090 091 /** 092 * Gets the "java-class" property. 093 * <p> 094 * Specifies the fully-qualified name of the Java class that 095 * provides the SASL mechanism handler implementation. 096 * 097 * @return Returns the value of the "java-class" property. 098 */ 099 String getJavaClass(); 100 101}