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.admin.std.meta.DigestMD5SASLMechanismHandlerCfgDefn.QualityOfProtection; 032import org.opends.server.types.DN; 033 034 035 036/** 037 * A server-side interface for querying Digest MD5 SASL Mechanism 038 * Handler settings. 039 * <p> 040 * The DIGEST-MD5 SASL mechanism is used to perform all processing 041 * related to SASL DIGEST-MD5 authentication. 042 */ 043public interface DigestMD5SASLMechanismHandlerCfg extends SASLMechanismHandlerCfg { 044 045 /** 046 * Gets the configuration class associated with this Digest MD5 SASL Mechanism Handler. 047 * 048 * @return Returns the configuration class associated with this Digest MD5 SASL Mechanism Handler. 049 */ 050 Class<? extends DigestMD5SASLMechanismHandlerCfg> configurationClass(); 051 052 053 054 /** 055 * Register to be notified when this Digest MD5 SASL Mechanism Handler is changed. 056 * 057 * @param listener 058 * The Digest MD5 SASL Mechanism Handler configuration change listener. 059 */ 060 void addDigestMD5ChangeListener(ConfigurationChangeListener<DigestMD5SASLMechanismHandlerCfg> listener); 061 062 063 064 /** 065 * Deregister an existing Digest MD5 SASL Mechanism Handler configuration change listener. 066 * 067 * @param listener 068 * The Digest MD5 SASL Mechanism Handler configuration change listener. 069 */ 070 void removeDigestMD5ChangeListener(ConfigurationChangeListener<DigestMD5SASLMechanismHandlerCfg> listener); 071 072 073 074 /** 075 * Gets the "identity-mapper" property. 076 * <p> 077 * Specifies the name of the identity mapper that is to be used with 078 * this SASL mechanism handler to match the authentication or 079 * authorization ID included in the SASL bind request to the 080 * corresponding user in the directory. 081 * 082 * @return Returns the value of the "identity-mapper" property. 083 */ 084 String getIdentityMapper(); 085 086 087 088 /** 089 * Gets the "identity-mapper" property as a DN. 090 * <p> 091 * Specifies the name of the identity mapper that is to be used with 092 * this SASL mechanism handler to match the authentication or 093 * authorization ID included in the SASL bind request to the 094 * corresponding user in the directory. 095 * 096 * @return Returns the DN value of the "identity-mapper" property. 097 */ 098 DN getIdentityMapperDN(); 099 100 101 102 /** 103 * Gets the "java-class" property. 104 * <p> 105 * Specifies the fully-qualified name of the Java class that 106 * provides the SASL mechanism handler implementation. 107 * 108 * @return Returns the value of the "java-class" property. 109 */ 110 String getJavaClass(); 111 112 113 114 /** 115 * Gets the "quality-of-protection" property. 116 * <p> 117 * The name of a property that specifies the quality of protection 118 * the server will support. 119 * 120 * @return Returns the value of the "quality-of-protection" property. 121 */ 122 QualityOfProtection getQualityOfProtection(); 123 124 125 126 /** 127 * Gets the "realm" property. 128 * <p> 129 * Specifies the realms that is to be used by the server for 130 * DIGEST-MD5 authentication. 131 * <p> 132 * If this value is not provided, then the server defaults to use 133 * the fully qualified hostname of the machine. 134 * 135 * @return Returns the value of the "realm" property. 136 */ 137 String getRealm(); 138 139 140 141 /** 142 * Gets the "server-fqdn" property. 143 * <p> 144 * Specifies the DNS-resolvable fully-qualified domain name for the 145 * server that is used when validating the digest-uri parameter 146 * during the authentication process. 147 * <p> 148 * If this configuration attribute is present, then the server 149 * expects that clients use a digest-uri equal to "ldap/" followed by 150 * the value of this attribute. For example, if the attribute has a 151 * value of "directory.example.com", then the server expects clients 152 * to use a digest-uri of "ldap/directory.example.com". If no value 153 * is provided, then the server does not attempt to validate the 154 * digest-uri provided by the client and accepts any value. 155 * 156 * @return Returns the value of the "server-fqdn" property. 157 */ 158 String getServerFqdn(); 159 160}