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