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.forgerock.opendj.server.config.meta;
027
028
029
030import org.forgerock.opendj.config.AdministratorAction;
031import org.forgerock.opendj.config.BooleanPropertyDefinition;
032import org.forgerock.opendj.config.ClassPropertyDefinition;
033import org.forgerock.opendj.config.client.ConcurrentModificationException;
034import org.forgerock.opendj.config.client.ManagedObject;
035import org.forgerock.opendj.config.client.MissingMandatoryPropertiesException;
036import org.forgerock.opendj.config.client.OperationRejectedException;
037import org.forgerock.opendj.config.DefaultBehaviorProvider;
038import org.forgerock.opendj.config.DefinedDefaultBehaviorProvider;
039import org.forgerock.opendj.config.ManagedObjectAlreadyExistsException;
040import org.forgerock.opendj.config.ManagedObjectDefinition;
041import org.forgerock.opendj.config.PropertyOption;
042import org.forgerock.opendj.config.PropertyProvider;
043import org.forgerock.opendj.config.server.ConfigurationChangeListener;
044import org.forgerock.opendj.config.server.ServerManagedObject;
045import org.forgerock.opendj.config.Tag;
046import org.forgerock.opendj.ldap.DN;
047import org.forgerock.opendj.ldap.LdapException;
048import org.forgerock.opendj.server.config.client.MD5PasswordStorageSchemeCfgClient;
049import org.forgerock.opendj.server.config.server.MD5PasswordStorageSchemeCfg;
050import org.forgerock.opendj.server.config.server.PasswordStorageSchemeCfg;
051
052
053
054/**
055 * An interface for querying the MD5 Password Storage Scheme managed
056 * object definition meta information.
057 * <p>
058 * The MD5 Password Storage Scheme provides a mechanism for encoding
059 * user passwords using an unsalted form of the MD5 message digest
060 * algorithm. Because the implementation does not use any kind of
061 * salting mechanism, a given password always has the same encoded
062 * form.
063 */
064public final class MD5PasswordStorageSchemeCfgDefn extends ManagedObjectDefinition<MD5PasswordStorageSchemeCfgClient, MD5PasswordStorageSchemeCfg> {
065
066  // The singleton configuration definition instance.
067  private static final MD5PasswordStorageSchemeCfgDefn INSTANCE = new MD5PasswordStorageSchemeCfgDefn();
068
069
070
071  // The "java-class" property definition.
072  private static final ClassPropertyDefinition PD_JAVA_CLASS;
073
074
075
076  // Build the "java-class" property definition.
077  static {
078      ClassPropertyDefinition.Builder builder = ClassPropertyDefinition.createBuilder(INSTANCE, "java-class");
079      builder.setOption(PropertyOption.MANDATORY);
080      builder.setOption(PropertyOption.ADVANCED);
081      builder.setAdministratorAction(new AdministratorAction(AdministratorAction.Type.NONE, INSTANCE, "java-class"));
082      DefaultBehaviorProvider<String> provider = new DefinedDefaultBehaviorProvider<String>("org.opends.server.extensions.MD5PasswordStorageScheme");
083      builder.setDefaultBehaviorProvider(provider);
084      builder.addInstanceOf("org.opends.server.api.PasswordStorageScheme");
085      PD_JAVA_CLASS = builder.getInstance();
086      INSTANCE.registerPropertyDefinition(PD_JAVA_CLASS);
087  }
088
089
090
091  // Register the tags associated with this managed object definition.
092  static {
093    INSTANCE.registerTag(Tag.valueOf("user-management"));
094  }
095
096
097
098  /**
099   * Get the MD5 Password Storage Scheme configuration definition
100   * singleton.
101   *
102   * @return Returns the MD5 Password Storage Scheme configuration
103   *         definition singleton.
104   */
105  public static MD5PasswordStorageSchemeCfgDefn getInstance() {
106    return INSTANCE;
107  }
108
109
110
111  /**
112   * Private constructor.
113   */
114  private MD5PasswordStorageSchemeCfgDefn() {
115    super("md5-password-storage-scheme", PasswordStorageSchemeCfgDefn.getInstance());
116  }
117
118
119
120  /**
121   * {@inheritDoc}
122   */
123  public MD5PasswordStorageSchemeCfgClient createClientConfiguration(
124      ManagedObject<? extends MD5PasswordStorageSchemeCfgClient> impl) {
125    return new MD5PasswordStorageSchemeCfgClientImpl(impl);
126  }
127
128
129
130  /**
131   * {@inheritDoc}
132   */
133  public MD5PasswordStorageSchemeCfg createServerConfiguration(
134      ServerManagedObject<? extends MD5PasswordStorageSchemeCfg> impl) {
135    return new MD5PasswordStorageSchemeCfgServerImpl(impl);
136  }
137
138
139
140  /**
141   * {@inheritDoc}
142   */
143  public Class<MD5PasswordStorageSchemeCfg> getServerConfigurationClass() {
144    return MD5PasswordStorageSchemeCfg.class;
145  }
146
147
148
149  /**
150   * Get the "enabled" property definition.
151   * <p>
152   * Indicates whether the MD5 Password Storage Scheme is enabled for
153   * use.
154   *
155   * @return Returns the "enabled" property definition.
156   */
157  public BooleanPropertyDefinition getEnabledPropertyDefinition() {
158    return PasswordStorageSchemeCfgDefn.getInstance().getEnabledPropertyDefinition();
159  }
160
161
162
163  /**
164   * Get the "java-class" property definition.
165   * <p>
166   * Specifies the fully-qualified name of the Java class that
167   * provides the MD5 Password Storage Scheme implementation.
168   *
169   * @return Returns the "java-class" property definition.
170   */
171  public ClassPropertyDefinition getJavaClassPropertyDefinition() {
172    return PD_JAVA_CLASS;
173  }
174
175
176
177  /**
178   * Managed object client implementation.
179   */
180  private static class MD5PasswordStorageSchemeCfgClientImpl implements
181    MD5PasswordStorageSchemeCfgClient {
182
183    // Private implementation.
184    private ManagedObject<? extends MD5PasswordStorageSchemeCfgClient> impl;
185
186
187
188    // Private constructor.
189    private MD5PasswordStorageSchemeCfgClientImpl(
190        ManagedObject<? extends MD5PasswordStorageSchemeCfgClient> impl) {
191      this.impl = impl;
192    }
193
194
195
196    /**
197     * {@inheritDoc}
198     */
199    public Boolean isEnabled() {
200      return impl.getPropertyValue(INSTANCE.getEnabledPropertyDefinition());
201    }
202
203
204
205    /**
206     * {@inheritDoc}
207     */
208    public void setEnabled(boolean value) {
209      impl.setPropertyValue(INSTANCE.getEnabledPropertyDefinition(), value);
210    }
211
212
213
214    /**
215     * {@inheritDoc}
216     */
217    public String getJavaClass() {
218      return impl.getPropertyValue(INSTANCE.getJavaClassPropertyDefinition());
219    }
220
221
222
223    /**
224     * {@inheritDoc}
225     */
226    public void setJavaClass(String value) {
227      impl.setPropertyValue(INSTANCE.getJavaClassPropertyDefinition(), value);
228    }
229
230
231
232    /**
233     * {@inheritDoc}
234     */
235    public ManagedObjectDefinition<? extends MD5PasswordStorageSchemeCfgClient, ? extends MD5PasswordStorageSchemeCfg> definition() {
236      return INSTANCE;
237    }
238
239
240
241    /**
242     * {@inheritDoc}
243     */
244    public PropertyProvider properties() {
245      return impl;
246    }
247
248
249
250    /**
251     * {@inheritDoc}
252     */
253    public void commit() throws ManagedObjectAlreadyExistsException,
254        MissingMandatoryPropertiesException, ConcurrentModificationException,
255        OperationRejectedException, LdapException {
256      impl.commit();
257    }
258
259  }
260
261
262
263  /**
264   * Managed object server implementation.
265   */
266  private static class MD5PasswordStorageSchemeCfgServerImpl implements
267    MD5PasswordStorageSchemeCfg {
268
269    // Private implementation.
270    private ServerManagedObject<? extends MD5PasswordStorageSchemeCfg> impl;
271
272    // The value of the "enabled" property.
273    private final boolean pEnabled;
274
275    // The value of the "java-class" property.
276    private final String pJavaClass;
277
278
279
280    // Private constructor.
281    private MD5PasswordStorageSchemeCfgServerImpl(ServerManagedObject<? extends MD5PasswordStorageSchemeCfg> impl) {
282      this.impl = impl;
283      this.pEnabled = impl.getPropertyValue(INSTANCE.getEnabledPropertyDefinition());
284      this.pJavaClass = impl.getPropertyValue(INSTANCE.getJavaClassPropertyDefinition());
285    }
286
287
288
289    /**
290     * {@inheritDoc}
291     */
292    public void addMD5ChangeListener(
293        ConfigurationChangeListener<MD5PasswordStorageSchemeCfg> listener) {
294      impl.registerChangeListener(listener);
295    }
296
297
298
299    /**
300     * {@inheritDoc}
301     */
302    public void removeMD5ChangeListener(
303        ConfigurationChangeListener<MD5PasswordStorageSchemeCfg> listener) {
304      impl.deregisterChangeListener(listener);
305    }
306    /**
307     * {@inheritDoc}
308     */
309    public void addChangeListener(
310        ConfigurationChangeListener<PasswordStorageSchemeCfg> listener) {
311      impl.registerChangeListener(listener);
312    }
313
314
315
316    /**
317     * {@inheritDoc}
318     */
319    public void removeChangeListener(
320        ConfigurationChangeListener<PasswordStorageSchemeCfg> listener) {
321      impl.deregisterChangeListener(listener);
322    }
323
324
325
326    /**
327     * {@inheritDoc}
328     */
329    public boolean isEnabled() {
330      return pEnabled;
331    }
332
333
334
335    /**
336     * {@inheritDoc}
337     */
338    public String getJavaClass() {
339      return pJavaClass;
340    }
341
342
343
344    /**
345     * {@inheritDoc}
346     */
347    public Class<? extends MD5PasswordStorageSchemeCfg> configurationClass() {
348      return MD5PasswordStorageSchemeCfg.class;
349    }
350
351
352
353    /**
354     * {@inheritDoc}
355     */
356    public DN dn() {
357      return impl.getDN();
358    }
359
360  }
361}