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