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.SHA1PasswordStorageSchemeCfgClient;
049import org.forgerock.opendj.server.config.server.PasswordStorageSchemeCfg;
050import org.forgerock.opendj.server.config.server.SHA1PasswordStorageSchemeCfg;
051
052
053
054/**
055 * An interface for querying the SHA1 Password Storage Scheme managed
056 * object definition meta information.
057 * <p>
058 * The SHA1 Password Storage Scheme provides a mechanism for encoding
059 * user passwords using an unsalted form of the SHA-1 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 SHA1PasswordStorageSchemeCfgDefn extends ManagedObjectDefinition<SHA1PasswordStorageSchemeCfgClient, SHA1PasswordStorageSchemeCfg> {
065
066  /** The singleton configuration definition instance. */
067  private static final SHA1PasswordStorageSchemeCfgDefn INSTANCE = new SHA1PasswordStorageSchemeCfgDefn();
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.SHA1PasswordStorageScheme");
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 SHA1 Password Storage Scheme configuration definition
100   * singleton.
101   *
102   * @return Returns the SHA1 Password Storage Scheme configuration
103   *         definition singleton.
104   */
105  public static SHA1PasswordStorageSchemeCfgDefn getInstance() {
106    return INSTANCE;
107  }
108
109
110
111  /**
112   * Private constructor.
113   */
114  private SHA1PasswordStorageSchemeCfgDefn() {
115    super("sha1-password-storage-scheme", PasswordStorageSchemeCfgDefn.getInstance());
116  }
117
118
119
120  /** {@inheritDoc} */
121  public SHA1PasswordStorageSchemeCfgClient createClientConfiguration(
122      ManagedObject<? extends SHA1PasswordStorageSchemeCfgClient> impl) {
123    return new SHA1PasswordStorageSchemeCfgClientImpl(impl);
124  }
125
126
127
128  /** {@inheritDoc} */
129  public SHA1PasswordStorageSchemeCfg createServerConfiguration(
130      ServerManagedObject<? extends SHA1PasswordStorageSchemeCfg> impl) {
131    return new SHA1PasswordStorageSchemeCfgServerImpl(impl);
132  }
133
134
135
136  /** {@inheritDoc} */
137  public Class<SHA1PasswordStorageSchemeCfg> getServerConfigurationClass() {
138    return SHA1PasswordStorageSchemeCfg.class;
139  }
140
141
142
143  /**
144   * Get the "enabled" property definition.
145   * <p>
146   * Indicates whether the SHA1 Password Storage Scheme is enabled for
147   * use.
148   *
149   * @return Returns the "enabled" property definition.
150   */
151  public BooleanPropertyDefinition getEnabledPropertyDefinition() {
152    return PasswordStorageSchemeCfgDefn.getInstance().getEnabledPropertyDefinition();
153  }
154
155
156
157  /**
158   * Get the "java-class" property definition.
159   * <p>
160   * Specifies the fully-qualified name of the Java class that
161   * provides the SHA1 Password Storage Scheme implementation.
162   *
163   * @return Returns the "java-class" property definition.
164   */
165  public ClassPropertyDefinition getJavaClassPropertyDefinition() {
166    return PD_JAVA_CLASS;
167  }
168
169
170
171  /**
172   * Managed object client implementation.
173   */
174  private static class SHA1PasswordStorageSchemeCfgClientImpl implements
175    SHA1PasswordStorageSchemeCfgClient {
176
177    /** Private implementation. */
178    private ManagedObject<? extends SHA1PasswordStorageSchemeCfgClient> impl;
179
180
181
182    /** Private constructor. */
183    private SHA1PasswordStorageSchemeCfgClientImpl(
184        ManagedObject<? extends SHA1PasswordStorageSchemeCfgClient> impl) {
185      this.impl = impl;
186    }
187
188
189
190    /** {@inheritDoc} */
191    public Boolean isEnabled() {
192      return impl.getPropertyValue(INSTANCE.getEnabledPropertyDefinition());
193    }
194
195
196
197    /** {@inheritDoc} */
198    public void setEnabled(boolean value) {
199      impl.setPropertyValue(INSTANCE.getEnabledPropertyDefinition(), value);
200    }
201
202
203
204    /** {@inheritDoc} */
205    public String getJavaClass() {
206      return impl.getPropertyValue(INSTANCE.getJavaClassPropertyDefinition());
207    }
208
209
210
211    /** {@inheritDoc} */
212    public void setJavaClass(String value) {
213      impl.setPropertyValue(INSTANCE.getJavaClassPropertyDefinition(), value);
214    }
215
216
217
218    /** {@inheritDoc} */
219    public ManagedObjectDefinition<? extends SHA1PasswordStorageSchemeCfgClient, ? extends SHA1PasswordStorageSchemeCfg> definition() {
220      return INSTANCE;
221    }
222
223
224
225    /** {@inheritDoc} */
226    public PropertyProvider properties() {
227      return impl;
228    }
229
230
231
232    /** {@inheritDoc} */
233    public void commit() throws ManagedObjectAlreadyExistsException,
234        MissingMandatoryPropertiesException, ConcurrentModificationException,
235        OperationRejectedException, LdapException {
236      impl.commit();
237    }
238
239
240
241    /** {@inheritDoc} */
242    public String toString() {
243      return impl.toString();
244    }
245  }
246
247
248
249  /**
250   * Managed object server implementation.
251   */
252  private static class SHA1PasswordStorageSchemeCfgServerImpl implements
253    SHA1PasswordStorageSchemeCfg {
254
255    /** Private implementation. */
256    private ServerManagedObject<? extends SHA1PasswordStorageSchemeCfg> impl;
257
258    /** The value of the "enabled" property. */
259    private final boolean pEnabled;
260
261    /** The value of the "java-class" property. */
262    private final String pJavaClass;
263
264
265
266    /** Private constructor. */
267    private SHA1PasswordStorageSchemeCfgServerImpl(ServerManagedObject<? extends SHA1PasswordStorageSchemeCfg> impl) {
268      this.impl = impl;
269      this.pEnabled = impl.getPropertyValue(INSTANCE.getEnabledPropertyDefinition());
270      this.pJavaClass = impl.getPropertyValue(INSTANCE.getJavaClassPropertyDefinition());
271    }
272
273
274
275    /** {@inheritDoc} */
276    public void addSHA1ChangeListener(
277        ConfigurationChangeListener<SHA1PasswordStorageSchemeCfg> listener) {
278      impl.registerChangeListener(listener);
279    }
280
281
282
283    /** {@inheritDoc} */
284    public void removeSHA1ChangeListener(
285        ConfigurationChangeListener<SHA1PasswordStorageSchemeCfg> listener) {
286      impl.deregisterChangeListener(listener);
287    }
288    /** {@inheritDoc} */
289    public void addChangeListener(
290        ConfigurationChangeListener<PasswordStorageSchemeCfg> listener) {
291      impl.registerChangeListener(listener);
292    }
293
294
295
296    /** {@inheritDoc} */
297    public void removeChangeListener(
298        ConfigurationChangeListener<PasswordStorageSchemeCfg> listener) {
299      impl.deregisterChangeListener(listener);
300    }
301
302
303
304    /** {@inheritDoc} */
305    public boolean isEnabled() {
306      return pEnabled;
307    }
308
309
310
311    /** {@inheritDoc} */
312    public String getJavaClass() {
313      return pJavaClass;
314    }
315
316
317
318    /** {@inheritDoc} */
319    public Class<? extends SHA1PasswordStorageSchemeCfg> configurationClass() {
320      return SHA1PasswordStorageSchemeCfg.class;
321    }
322
323
324
325    /** {@inheritDoc} */
326    public DN dn() {
327      return impl.getDN();
328    }
329
330
331
332    /** {@inheritDoc} */
333    public String toString() {
334      return impl.toString();
335    }
336  }
337}