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.meta;
027
028
029
030import org.opends.server.admin.AdministratorAction;
031import org.opends.server.admin.BooleanPropertyDefinition;
032import org.opends.server.admin.ClassPropertyDefinition;
033import org.opends.server.admin.client.AuthorizationException;
034import org.opends.server.admin.client.CommunicationException;
035import org.opends.server.admin.client.ConcurrentModificationException;
036import org.opends.server.admin.client.ManagedObject;
037import org.opends.server.admin.client.MissingMandatoryPropertiesException;
038import org.opends.server.admin.client.OperationRejectedException;
039import org.opends.server.admin.DefaultBehaviorProvider;
040import org.opends.server.admin.DefinedDefaultBehaviorProvider;
041import org.opends.server.admin.ManagedObjectAlreadyExistsException;
042import org.opends.server.admin.ManagedObjectDefinition;
043import org.opends.server.admin.PropertyOption;
044import org.opends.server.admin.PropertyProvider;
045import org.opends.server.admin.server.ConfigurationChangeListener;
046import org.opends.server.admin.server.ServerManagedObject;
047import org.opends.server.admin.std.client.SaltedSHA512PasswordStorageSchemeCfgClient;
048import org.opends.server.admin.std.server.PasswordStorageSchemeCfg;
049import org.opends.server.admin.std.server.SaltedSHA512PasswordStorageSchemeCfg;
050import org.opends.server.admin.Tag;
051import org.opends.server.types.DN;
052
053
054
055/**
056 * An interface for querying the Salted SHA512 Password Storage Scheme
057 * managed object definition meta information.
058 * <p>
059 * The Salted SHA512 Password Storage Scheme provides a mechanism for
060 * encoding user passwords using a salted form of the 512-bit SHA-2
061 * message digest algorithm.
062 */
063public final class SaltedSHA512PasswordStorageSchemeCfgDefn extends ManagedObjectDefinition<SaltedSHA512PasswordStorageSchemeCfgClient, SaltedSHA512PasswordStorageSchemeCfg> {
064
065  // The singleton configuration definition instance.
066  private static final SaltedSHA512PasswordStorageSchemeCfgDefn INSTANCE = new SaltedSHA512PasswordStorageSchemeCfgDefn();
067
068
069
070  // The "java-class" property definition.
071  private static final ClassPropertyDefinition PD_JAVA_CLASS;
072
073
074
075  // Build the "java-class" property definition.
076  static {
077      ClassPropertyDefinition.Builder builder = ClassPropertyDefinition.createBuilder(INSTANCE, "java-class");
078      builder.setOption(PropertyOption.MANDATORY);
079      builder.setOption(PropertyOption.ADVANCED);
080      builder.setAdministratorAction(new AdministratorAction(AdministratorAction.Type.NONE, INSTANCE, "java-class"));
081      DefaultBehaviorProvider<String> provider = new DefinedDefaultBehaviorProvider<String>("org.opends.server.extensions.SaltedSHA512PasswordStorageScheme");
082      builder.setDefaultBehaviorProvider(provider);
083      builder.addInstanceOf("org.opends.server.api.PasswordStorageScheme");
084      PD_JAVA_CLASS = builder.getInstance();
085      INSTANCE.registerPropertyDefinition(PD_JAVA_CLASS);
086  }
087
088
089
090  // Register the tags associated with this managed object definition.
091  static {
092    INSTANCE.registerTag(Tag.valueOf("user-management"));
093  }
094
095
096
097  /**
098   * Get the Salted SHA512 Password Storage Scheme configuration
099   * definition singleton.
100   *
101   * @return Returns the Salted SHA512 Password Storage Scheme
102   *         configuration definition singleton.
103   */
104  public static SaltedSHA512PasswordStorageSchemeCfgDefn getInstance() {
105    return INSTANCE;
106  }
107
108
109
110  /**
111   * Private constructor.
112   */
113  private SaltedSHA512PasswordStorageSchemeCfgDefn() {
114    super("salted-sha512-password-storage-scheme", PasswordStorageSchemeCfgDefn.getInstance());
115  }
116
117
118
119  /**
120   * {@inheritDoc}
121   */
122  public SaltedSHA512PasswordStorageSchemeCfgClient createClientConfiguration(
123      ManagedObject<? extends SaltedSHA512PasswordStorageSchemeCfgClient> impl) {
124    return new SaltedSHA512PasswordStorageSchemeCfgClientImpl(impl);
125  }
126
127
128
129  /**
130   * {@inheritDoc}
131   */
132  public SaltedSHA512PasswordStorageSchemeCfg createServerConfiguration(
133      ServerManagedObject<? extends SaltedSHA512PasswordStorageSchemeCfg> impl) {
134    return new SaltedSHA512PasswordStorageSchemeCfgServerImpl(impl);
135  }
136
137
138
139  /**
140   * {@inheritDoc}
141   */
142  public Class<SaltedSHA512PasswordStorageSchemeCfg> getServerConfigurationClass() {
143    return SaltedSHA512PasswordStorageSchemeCfg.class;
144  }
145
146
147
148  /**
149   * Get the "enabled" property definition.
150   * <p>
151   * Indicates whether the Salted SHA512 Password Storage Scheme is
152   * enabled for use.
153   *
154   * @return Returns the "enabled" property definition.
155   */
156  public BooleanPropertyDefinition getEnabledPropertyDefinition() {
157    return PasswordStorageSchemeCfgDefn.getInstance().getEnabledPropertyDefinition();
158  }
159
160
161
162  /**
163   * Get the "java-class" property definition.
164   * <p>
165   * Specifies the fully-qualified name of the Java class that
166   * provides the Salted SHA512 Password Storage Scheme implementation.
167   *
168   * @return Returns the "java-class" property definition.
169   */
170  public ClassPropertyDefinition getJavaClassPropertyDefinition() {
171    return PD_JAVA_CLASS;
172  }
173
174
175
176  /**
177   * Managed object client implementation.
178   */
179  private static class SaltedSHA512PasswordStorageSchemeCfgClientImpl implements
180    SaltedSHA512PasswordStorageSchemeCfgClient {
181
182    // Private implementation.
183    private ManagedObject<? extends SaltedSHA512PasswordStorageSchemeCfgClient> impl;
184
185
186
187    // Private constructor.
188    private SaltedSHA512PasswordStorageSchemeCfgClientImpl(
189        ManagedObject<? extends SaltedSHA512PasswordStorageSchemeCfgClient> impl) {
190      this.impl = impl;
191    }
192
193
194
195    /**
196     * {@inheritDoc}
197     */
198    public Boolean isEnabled() {
199      return impl.getPropertyValue(INSTANCE.getEnabledPropertyDefinition());
200    }
201
202
203
204    /**
205     * {@inheritDoc}
206     */
207    public void setEnabled(boolean value) {
208      impl.setPropertyValue(INSTANCE.getEnabledPropertyDefinition(), value);
209    }
210
211
212
213    /**
214     * {@inheritDoc}
215     */
216    public String getJavaClass() {
217      return impl.getPropertyValue(INSTANCE.getJavaClassPropertyDefinition());
218    }
219
220
221
222    /**
223     * {@inheritDoc}
224     */
225    public void setJavaClass(String value) {
226      impl.setPropertyValue(INSTANCE.getJavaClassPropertyDefinition(), value);
227    }
228
229
230
231    /**
232     * {@inheritDoc}
233     */
234    public ManagedObjectDefinition<? extends SaltedSHA512PasswordStorageSchemeCfgClient, ? extends SaltedSHA512PasswordStorageSchemeCfg> definition() {
235      return INSTANCE;
236    }
237
238
239
240    /**
241     * {@inheritDoc}
242     */
243    public PropertyProvider properties() {
244      return impl;
245    }
246
247
248
249    /**
250     * {@inheritDoc}
251     */
252    public void commit() throws ManagedObjectAlreadyExistsException,
253        MissingMandatoryPropertiesException, ConcurrentModificationException,
254        OperationRejectedException, AuthorizationException,
255        CommunicationException {
256      impl.commit();
257    }
258
259  }
260
261
262
263  /**
264   * Managed object server implementation.
265   */
266  private static class SaltedSHA512PasswordStorageSchemeCfgServerImpl implements
267    SaltedSHA512PasswordStorageSchemeCfg {
268
269    // Private implementation.
270    private ServerManagedObject<? extends SaltedSHA512PasswordStorageSchemeCfg> 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 SaltedSHA512PasswordStorageSchemeCfgServerImpl(ServerManagedObject<? extends SaltedSHA512PasswordStorageSchemeCfg> 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 addSaltedSHA512ChangeListener(
293        ConfigurationChangeListener<SaltedSHA512PasswordStorageSchemeCfg> listener) {
294      impl.registerChangeListener(listener);
295    }
296
297
298
299    /**
300     * {@inheritDoc}
301     */
302    public void removeSaltedSHA512ChangeListener(
303        ConfigurationChangeListener<SaltedSHA512PasswordStorageSchemeCfg> 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 SaltedSHA512PasswordStorageSchemeCfg> configurationClass() {
348      return SaltedSHA512PasswordStorageSchemeCfg.class;
349    }
350
351
352
353    /**
354     * {@inheritDoc}
355     */
356    public DN dn() {
357      return impl.getDN();
358    }
359
360  }
361}