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.meta.DigestMD5SASLMechanismHandlerCfgDefn.QualityOfProtection;
023import org.forgerock.opendj.server.config.server.DigestMD5SASLMechanismHandlerCfg;
024
025
026
027/**
028 * A client-side interface for reading and modifying Digest MD5 SASL
029 * Mechanism Handler settings.
030 * <p>
031 * The DIGEST-MD5 SASL mechanism is used to perform all processing
032 * related to SASL DIGEST-MD5 authentication.
033 */
034public interface DigestMD5SASLMechanismHandlerCfgClient extends SASLMechanismHandlerCfgClient {
035
036  /**
037   * Get the configuration definition associated with this Digest MD5 SASL Mechanism Handler.
038   *
039   * @return Returns the configuration definition associated with this Digest MD5 SASL Mechanism Handler.
040   */
041  ManagedObjectDefinition<? extends DigestMD5SASLMechanismHandlerCfgClient, ? extends DigestMD5SASLMechanismHandlerCfg> definition();
042
043
044
045  /**
046   * Gets the "identity-mapper" property.
047   * <p>
048   * Specifies the name of the identity mapper that is to be used with
049   * this SASL mechanism handler to match the authentication or
050   * authorization ID included in the SASL bind request to the
051   * corresponding user in the directory.
052   *
053   * @return Returns the value of the "identity-mapper" property.
054   */
055  String getIdentityMapper();
056
057
058
059  /**
060   * Sets the "identity-mapper" property.
061   * <p>
062   * Specifies the name of the identity mapper that is to be used with
063   * this SASL mechanism handler to match the authentication or
064   * authorization ID included in the SASL bind request to the
065   * corresponding user in the directory.
066   *
067   * @param value The value of the "identity-mapper" property.
068   * @throws PropertyException
069   *           If the new value is invalid.
070   */
071  void setIdentityMapper(String value) throws PropertyException;
072
073
074
075  /**
076   * Gets the "java-class" property.
077   * <p>
078   * Specifies the fully-qualified name of the Java class that
079   * provides the SASL mechanism handler implementation.
080   *
081   * @return Returns the value of the "java-class" property.
082   */
083  String getJavaClass();
084
085
086
087  /**
088   * Sets the "java-class" property.
089   * <p>
090   * Specifies the fully-qualified name of the Java class that
091   * provides the SASL mechanism handler implementation.
092   *
093   * @param value The value of the "java-class" property.
094   * @throws PropertyException
095   *           If the new value is invalid.
096   */
097  void setJavaClass(String value) throws PropertyException;
098
099
100
101  /**
102   * Gets the "quality-of-protection" property.
103   * <p>
104   * The name of a property that specifies the quality of protection
105   * the server will support.
106   *
107   * @return Returns the value of the "quality-of-protection" property.
108   */
109  QualityOfProtection getQualityOfProtection();
110
111
112
113  /**
114   * Sets the "quality-of-protection" property.
115   * <p>
116   * The name of a property that specifies the quality of protection
117   * the server will support.
118   *
119   * @param value The value of the "quality-of-protection" property.
120   * @throws PropertyException
121   *           If the new value is invalid.
122   */
123  void setQualityOfProtection(QualityOfProtection value) throws PropertyException;
124
125
126
127  /**
128   * Gets the "realm" property.
129   * <p>
130   * Specifies the realms that is to be used by the server for
131   * DIGEST-MD5 authentication.
132   * <p>
133   * If this value is not provided, then the server defaults to use
134   * the fully qualified hostname of the machine.
135   *
136   * @return Returns the value of the "realm" property.
137   */
138  String getRealm();
139
140
141
142  /**
143   * Sets the "realm" property.
144   * <p>
145   * Specifies the realms that is to be used by the server for
146   * DIGEST-MD5 authentication.
147   * <p>
148   * If this value is not provided, then the server defaults to use
149   * the fully qualified hostname of the machine.
150   *
151   * @param value The value of the "realm" property.
152   * @throws PropertyException
153   *           If the new value is invalid.
154   */
155  void setRealm(String value) throws PropertyException;
156
157
158
159  /**
160   * Gets the "server-fqdn" property.
161   * <p>
162   * Specifies the DNS-resolvable fully-qualified domain name for the
163   * server that is used when validating the digest-uri parameter
164   * during the authentication process.
165   * <p>
166   * If this configuration attribute is present, then the server
167   * expects that clients use a digest-uri equal to "ldap/" followed by
168   * the value of this attribute. For example, if the attribute has a
169   * value of "directory.example.com", then the server expects clients
170   * to use a digest-uri of "ldap/directory.example.com". If no value
171   * is provided, then the server does not attempt to validate the
172   * digest-uri provided by the client and accepts any value.
173   *
174   * @return Returns the value of the "server-fqdn" property.
175   */
176  String getServerFqdn();
177
178
179
180  /**
181   * Sets the "server-fqdn" property.
182   * <p>
183   * Specifies the DNS-resolvable fully-qualified domain name for the
184   * server that is used when validating the digest-uri parameter
185   * during the authentication process.
186   * <p>
187   * If this configuration attribute is present, then the server
188   * expects that clients use a digest-uri equal to "ldap/" followed by
189   * the value of this attribute. For example, if the attribute has a
190   * value of "directory.example.com", then the server expects clients
191   * to use a digest-uri of "ldap/directory.example.com". If no value
192   * is provided, then the server does not attempt to validate the
193   * digest-uri provided by the client and accepts any value.
194   *
195   * @param value The value of the "server-fqdn" property.
196   * @throws PropertyException
197   *           If the new value is invalid.
198   */
199  void setServerFqdn(String value) throws PropertyException;
200
201}