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