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