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