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.BlowfishPasswordStorageSchemeCfgClient;
049import org.forgerock.opendj.server.config.server.BlowfishPasswordStorageSchemeCfg;
050import org.forgerock.opendj.server.config.server.PasswordStorageSchemeCfg;
051
052
053
054/**
055 * An interface for querying the Blowfish Password Storage Scheme
056 * managed object definition meta information.
057 * <p>
058 * The Blowfish Password Storage Scheme provides a mechanism for
059 * encoding user passwords using the Blowfish reversible encryption
060 * mechanism.
061 */
062public final class BlowfishPasswordStorageSchemeCfgDefn extends ManagedObjectDefinition<BlowfishPasswordStorageSchemeCfgClient, BlowfishPasswordStorageSchemeCfg> {
063
064  /** The singleton configuration definition instance. */
065  private static final BlowfishPasswordStorageSchemeCfgDefn INSTANCE = new BlowfishPasswordStorageSchemeCfgDefn();
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.BlowfishPasswordStorageScheme");
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 Blowfish Password Storage Scheme configuration definition
098   * singleton.
099   *
100   * @return Returns the Blowfish Password Storage Scheme
101   *         configuration definition singleton.
102   */
103  public static BlowfishPasswordStorageSchemeCfgDefn getInstance() {
104    return INSTANCE;
105  }
106
107
108
109  /**
110   * Private constructor.
111   */
112  private BlowfishPasswordStorageSchemeCfgDefn() {
113    super("blowfish-password-storage-scheme", PasswordStorageSchemeCfgDefn.getInstance());
114  }
115
116
117
118  /** {@inheritDoc} */
119  public BlowfishPasswordStorageSchemeCfgClient createClientConfiguration(
120      ManagedObject<? extends BlowfishPasswordStorageSchemeCfgClient> impl) {
121    return new BlowfishPasswordStorageSchemeCfgClientImpl(impl);
122  }
123
124
125
126  /** {@inheritDoc} */
127  public BlowfishPasswordStorageSchemeCfg createServerConfiguration(
128      ServerManagedObject<? extends BlowfishPasswordStorageSchemeCfg> impl) {
129    return new BlowfishPasswordStorageSchemeCfgServerImpl(impl);
130  }
131
132
133
134  /** {@inheritDoc} */
135  public Class<BlowfishPasswordStorageSchemeCfg> getServerConfigurationClass() {
136    return BlowfishPasswordStorageSchemeCfg.class;
137  }
138
139
140
141  /**
142   * Get the "enabled" property definition.
143   * <p>
144   * Indicates whether the Blowfish Password Storage Scheme is enabled
145   * for use.
146   *
147   * @return Returns the "enabled" property definition.
148   */
149  public BooleanPropertyDefinition getEnabledPropertyDefinition() {
150    return PasswordStorageSchemeCfgDefn.getInstance().getEnabledPropertyDefinition();
151  }
152
153
154
155  /**
156   * Get the "java-class" property definition.
157   * <p>
158   * Specifies the fully-qualified name of the Java class that
159   * provides the Blowfish Password Storage Scheme implementation.
160   *
161   * @return Returns the "java-class" property definition.
162   */
163  public ClassPropertyDefinition getJavaClassPropertyDefinition() {
164    return PD_JAVA_CLASS;
165  }
166
167
168
169  /**
170   * Managed object client implementation.
171   */
172  private static class BlowfishPasswordStorageSchemeCfgClientImpl implements
173    BlowfishPasswordStorageSchemeCfgClient {
174
175    /** Private implementation. */
176    private ManagedObject<? extends BlowfishPasswordStorageSchemeCfgClient> impl;
177
178
179
180    /** Private constructor. */
181    private BlowfishPasswordStorageSchemeCfgClientImpl(
182        ManagedObject<? extends BlowfishPasswordStorageSchemeCfgClient> impl) {
183      this.impl = impl;
184    }
185
186
187
188    /** {@inheritDoc} */
189    public Boolean isEnabled() {
190      return impl.getPropertyValue(INSTANCE.getEnabledPropertyDefinition());
191    }
192
193
194
195    /** {@inheritDoc} */
196    public void setEnabled(boolean value) {
197      impl.setPropertyValue(INSTANCE.getEnabledPropertyDefinition(), value);
198    }
199
200
201
202    /** {@inheritDoc} */
203    public String getJavaClass() {
204      return impl.getPropertyValue(INSTANCE.getJavaClassPropertyDefinition());
205    }
206
207
208
209    /** {@inheritDoc} */
210    public void setJavaClass(String value) {
211      impl.setPropertyValue(INSTANCE.getJavaClassPropertyDefinition(), value);
212    }
213
214
215
216    /** {@inheritDoc} */
217    public ManagedObjectDefinition<? extends BlowfishPasswordStorageSchemeCfgClient, ? extends BlowfishPasswordStorageSchemeCfg> definition() {
218      return INSTANCE;
219    }
220
221
222
223    /** {@inheritDoc} */
224    public PropertyProvider properties() {
225      return impl;
226    }
227
228
229
230    /** {@inheritDoc} */
231    public void commit() throws ManagedObjectAlreadyExistsException,
232        MissingMandatoryPropertiesException, ConcurrentModificationException,
233        OperationRejectedException, LdapException {
234      impl.commit();
235    }
236
237
238
239    /** {@inheritDoc} */
240    public String toString() {
241      return impl.toString();
242    }
243  }
244
245
246
247  /**
248   * Managed object server implementation.
249   */
250  private static class BlowfishPasswordStorageSchemeCfgServerImpl implements
251    BlowfishPasswordStorageSchemeCfg {
252
253    /** Private implementation. */
254    private ServerManagedObject<? extends BlowfishPasswordStorageSchemeCfg> impl;
255
256    /** The value of the "enabled" property. */
257    private final boolean pEnabled;
258
259    /** The value of the "java-class" property. */
260    private final String pJavaClass;
261
262
263
264    /** Private constructor. */
265    private BlowfishPasswordStorageSchemeCfgServerImpl(ServerManagedObject<? extends BlowfishPasswordStorageSchemeCfg> impl) {
266      this.impl = impl;
267      this.pEnabled = impl.getPropertyValue(INSTANCE.getEnabledPropertyDefinition());
268      this.pJavaClass = impl.getPropertyValue(INSTANCE.getJavaClassPropertyDefinition());
269    }
270
271
272
273    /** {@inheritDoc} */
274    public void addBlowfishChangeListener(
275        ConfigurationChangeListener<BlowfishPasswordStorageSchemeCfg> listener) {
276      impl.registerChangeListener(listener);
277    }
278
279
280
281    /** {@inheritDoc} */
282    public void removeBlowfishChangeListener(
283        ConfigurationChangeListener<BlowfishPasswordStorageSchemeCfg> listener) {
284      impl.deregisterChangeListener(listener);
285    }
286    /** {@inheritDoc} */
287    public void addChangeListener(
288        ConfigurationChangeListener<PasswordStorageSchemeCfg> listener) {
289      impl.registerChangeListener(listener);
290    }
291
292
293
294    /** {@inheritDoc} */
295    public void removeChangeListener(
296        ConfigurationChangeListener<PasswordStorageSchemeCfg> listener) {
297      impl.deregisterChangeListener(listener);
298    }
299
300
301
302    /** {@inheritDoc} */
303    public boolean isEnabled() {
304      return pEnabled;
305    }
306
307
308
309    /** {@inheritDoc} */
310    public String getJavaClass() {
311      return pJavaClass;
312    }
313
314
315
316    /** {@inheritDoc} */
317    public Class<? extends BlowfishPasswordStorageSchemeCfg> configurationClass() {
318      return BlowfishPasswordStorageSchemeCfg.class;
319    }
320
321
322
323    /** {@inheritDoc} */
324    public DN dn() {
325      return impl.getDN();
326    }
327
328
329
330    /** {@inheritDoc} */
331    public String toString() {
332      return impl.toString();
333    }
334  }
335}