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
010     * trunk/opends/resource/legal-notices/OpenDS.LICENSE
011     * or https://OpenDS.dev.java.net/OpenDS.LICENSE.
012     * See the License for the specific language governing permissions
013     * and limitations under the License.
014     *
015     * When distributing Covered Code, include this CDDL HEADER in each
016     * file and include the License file at
017     * trunk/opends/resource/legal-notices/OpenDS.LICENSE.  If applicable,
018     * add the following below this CDDL HEADER, with the fields enclosed
019     * by brackets "[]" replaced with your own identifying information:
020     *      Portions Copyright [yyyy] [name of copyright owner]
021     *
022     * CDDL HEADER END
023     *
024     *
025     *      Copyright 2008 Sun Microsystems, Inc.
026     */
027    package org.opends.server.admin.std.meta;
028    
029    
030    
031    import org.opends.server.admin.AdministratorAction;
032    import org.opends.server.admin.BooleanPropertyDefinition;
033    import org.opends.server.admin.ClassPropertyDefinition;
034    import org.opends.server.admin.client.AuthorizationException;
035    import org.opends.server.admin.client.CommunicationException;
036    import org.opends.server.admin.client.ConcurrentModificationException;
037    import org.opends.server.admin.client.ManagedObject;
038    import org.opends.server.admin.client.MissingMandatoryPropertiesException;
039    import org.opends.server.admin.client.OperationRejectedException;
040    import org.opends.server.admin.DefaultBehaviorProvider;
041    import org.opends.server.admin.DefinedDefaultBehaviorProvider;
042    import org.opends.server.admin.ManagedObjectAlreadyExistsException;
043    import org.opends.server.admin.ManagedObjectDefinition;
044    import org.opends.server.admin.PropertyOption;
045    import org.opends.server.admin.PropertyProvider;
046    import org.opends.server.admin.server.ConfigurationChangeListener;
047    import org.opends.server.admin.server.ServerManagedObject;
048    import org.opends.server.admin.std.client.SaltedSHA384PasswordStorageSchemeCfgClient;
049    import org.opends.server.admin.std.server.PasswordStorageSchemeCfg;
050    import org.opends.server.admin.std.server.SaltedSHA384PasswordStorageSchemeCfg;
051    import org.opends.server.admin.Tag;
052    import org.opends.server.types.DN;
053    
054    
055    
056    /**
057     * An interface for querying the Salted SHA384 Password Storage Scheme
058     * managed object definition meta information.
059     * <p>
060     * The Salted SHA384 Password Storage Scheme provides a mechanism for
061     * encoding user passwords using a salted form of the 384-bit SHA-2
062     * message digest algorithm.
063     */
064    public final class SaltedSHA384PasswordStorageSchemeCfgDefn extends ManagedObjectDefinition<SaltedSHA384PasswordStorageSchemeCfgClient, SaltedSHA384PasswordStorageSchemeCfg> {
065    
066      // The singleton configuration definition instance.
067      private static final SaltedSHA384PasswordStorageSchemeCfgDefn INSTANCE = new SaltedSHA384PasswordStorageSchemeCfgDefn();
068    
069    
070    
071      // The "java-class" property definition.
072      private static final ClassPropertyDefinition PD_JAVA_CLASS;
073    
074    
075    
076      // Build the "java-class" property definition.
077      static {
078          ClassPropertyDefinition.Builder builder = ClassPropertyDefinition.createBuilder(INSTANCE, "java-class");
079          builder.setOption(PropertyOption.MANDATORY);
080          builder.setOption(PropertyOption.ADVANCED);
081          builder.setAdministratorAction(new AdministratorAction(AdministratorAction.Type.NONE, INSTANCE, "java-class"));
082          DefaultBehaviorProvider<String> provider = new DefinedDefaultBehaviorProvider<String>("org.opends.server.extensions.SaltedSHA384PasswordStorageScheme");
083          builder.setDefaultBehaviorProvider(provider);
084          builder.addInstanceOf("org.opends.server.api.PasswordStorageScheme");
085          PD_JAVA_CLASS = builder.getInstance();
086          INSTANCE.registerPropertyDefinition(PD_JAVA_CLASS);
087      }
088    
089    
090    
091      // Register the tags associated with this managed object definition.
092      static {
093        INSTANCE.registerTag(Tag.valueOf("user-management"));
094      }
095    
096    
097    
098      /**
099       * Get the Salted SHA384 Password Storage Scheme configuration
100       * definition singleton.
101       *
102       * @return Returns the Salted SHA384 Password Storage Scheme
103       *         configuration definition singleton.
104       */
105      public static SaltedSHA384PasswordStorageSchemeCfgDefn getInstance() {
106        return INSTANCE;
107      }
108    
109    
110    
111      /**
112       * Private constructor.
113       */
114      private SaltedSHA384PasswordStorageSchemeCfgDefn() {
115        super("salted-sha384-password-storage-scheme", PasswordStorageSchemeCfgDefn.getInstance());
116      }
117    
118    
119    
120      /**
121       * {@inheritDoc}
122       */
123      public SaltedSHA384PasswordStorageSchemeCfgClient createClientConfiguration(
124          ManagedObject<? extends SaltedSHA384PasswordStorageSchemeCfgClient> impl) {
125        return new SaltedSHA384PasswordStorageSchemeCfgClientImpl(impl);
126      }
127    
128    
129    
130      /**
131       * {@inheritDoc}
132       */
133      public SaltedSHA384PasswordStorageSchemeCfg createServerConfiguration(
134          ServerManagedObject<? extends SaltedSHA384PasswordStorageSchemeCfg> impl) {
135        return new SaltedSHA384PasswordStorageSchemeCfgServerImpl(impl);
136      }
137    
138    
139    
140      /**
141       * {@inheritDoc}
142       */
143      public Class<SaltedSHA384PasswordStorageSchemeCfg> getServerConfigurationClass() {
144        return SaltedSHA384PasswordStorageSchemeCfg.class;
145      }
146    
147    
148    
149      /**
150       * Get the "enabled" property definition.
151       * <p>
152       * Indicates whether the Salted SHA384 Password Storage Scheme is
153       * enabled for use.
154       *
155       * @return Returns the "enabled" property definition.
156       */
157      public BooleanPropertyDefinition getEnabledPropertyDefinition() {
158        return PasswordStorageSchemeCfgDefn.getInstance().getEnabledPropertyDefinition();
159      }
160    
161    
162    
163      /**
164       * Get the "java-class" property definition.
165       * <p>
166       * Specifies the fully-qualified name of the Java class that
167       * provides the Salted SHA384 Password Storage Scheme implementation.
168       *
169       * @return Returns the "java-class" property definition.
170       */
171      public ClassPropertyDefinition getJavaClassPropertyDefinition() {
172        return PD_JAVA_CLASS;
173      }
174    
175    
176    
177      /**
178       * Managed object client implementation.
179       */
180      private static class SaltedSHA384PasswordStorageSchemeCfgClientImpl implements
181        SaltedSHA384PasswordStorageSchemeCfgClient {
182    
183        // Private implementation.
184        private ManagedObject<? extends SaltedSHA384PasswordStorageSchemeCfgClient> impl;
185    
186    
187    
188        // Private constructor.
189        private SaltedSHA384PasswordStorageSchemeCfgClientImpl(
190            ManagedObject<? extends SaltedSHA384PasswordStorageSchemeCfgClient> impl) {
191          this.impl = impl;
192        }
193    
194    
195    
196        /**
197         * {@inheritDoc}
198         */
199        public Boolean isEnabled() {
200          return impl.getPropertyValue(INSTANCE.getEnabledPropertyDefinition());
201        }
202    
203    
204    
205        /**
206         * {@inheritDoc}
207         */
208        public void setEnabled(boolean value) {
209          impl.setPropertyValue(INSTANCE.getEnabledPropertyDefinition(), value);
210        }
211    
212    
213    
214        /**
215         * {@inheritDoc}
216         */
217        public String getJavaClass() {
218          return impl.getPropertyValue(INSTANCE.getJavaClassPropertyDefinition());
219        }
220    
221    
222    
223        /**
224         * {@inheritDoc}
225         */
226        public void setJavaClass(String value) {
227          impl.setPropertyValue(INSTANCE.getJavaClassPropertyDefinition(), value);
228        }
229    
230    
231    
232        /**
233         * {@inheritDoc}
234         */
235        public ManagedObjectDefinition<? extends SaltedSHA384PasswordStorageSchemeCfgClient, ? extends SaltedSHA384PasswordStorageSchemeCfg> definition() {
236          return INSTANCE;
237        }
238    
239    
240    
241        /**
242         * {@inheritDoc}
243         */
244        public PropertyProvider properties() {
245          return impl;
246        }
247    
248    
249    
250        /**
251         * {@inheritDoc}
252         */
253        public void commit() throws ManagedObjectAlreadyExistsException,
254            MissingMandatoryPropertiesException, ConcurrentModificationException,
255            OperationRejectedException, AuthorizationException,
256            CommunicationException {
257          impl.commit();
258        }
259    
260      }
261    
262    
263    
264      /**
265       * Managed object server implementation.
266       */
267      private static class SaltedSHA384PasswordStorageSchemeCfgServerImpl implements
268        SaltedSHA384PasswordStorageSchemeCfg {
269    
270        // Private implementation.
271        private ServerManagedObject<? extends SaltedSHA384PasswordStorageSchemeCfg> impl;
272    
273        // The value of the "enabled" property.
274        private final boolean pEnabled;
275    
276        // The value of the "java-class" property.
277        private final String pJavaClass;
278    
279    
280    
281        // Private constructor.
282        private SaltedSHA384PasswordStorageSchemeCfgServerImpl(ServerManagedObject<? extends SaltedSHA384PasswordStorageSchemeCfg> impl) {
283          this.impl = impl;
284          this.pEnabled = impl.getPropertyValue(INSTANCE.getEnabledPropertyDefinition());
285          this.pJavaClass = impl.getPropertyValue(INSTANCE.getJavaClassPropertyDefinition());
286        }
287    
288    
289    
290        /**
291         * {@inheritDoc}
292         */
293        public void addSaltedSHA384ChangeListener(
294            ConfigurationChangeListener<SaltedSHA384PasswordStorageSchemeCfg> listener) {
295          impl.registerChangeListener(listener);
296        }
297    
298    
299    
300        /**
301         * {@inheritDoc}
302         */
303        public void removeSaltedSHA384ChangeListener(
304            ConfigurationChangeListener<SaltedSHA384PasswordStorageSchemeCfg> listener) {
305          impl.deregisterChangeListener(listener);
306        }
307        /**
308         * {@inheritDoc}
309         */
310        public void addChangeListener(
311            ConfigurationChangeListener<PasswordStorageSchemeCfg> listener) {
312          impl.registerChangeListener(listener);
313        }
314    
315    
316    
317        /**
318         * {@inheritDoc}
319         */
320        public void removeChangeListener(
321            ConfigurationChangeListener<PasswordStorageSchemeCfg> listener) {
322          impl.deregisterChangeListener(listener);
323        }
324    
325    
326    
327        /**
328         * {@inheritDoc}
329         */
330        public boolean isEnabled() {
331          return pEnabled;
332        }
333    
334    
335    
336        /**
337         * {@inheritDoc}
338         */
339        public String getJavaClass() {
340          return pJavaClass;
341        }
342    
343    
344    
345        /**
346         * {@inheritDoc}
347         */
348        public Class<? extends SaltedSHA384PasswordStorageSchemeCfg> configurationClass() {
349          return SaltedSHA384PasswordStorageSchemeCfg.class;
350        }
351    
352    
353    
354        /**
355         * {@inheritDoc}
356         */
357        public DN dn() {
358          return impl.getDN();
359        }
360    
361      }
362    }