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.DefaultBehaviorProvider;
040import org.opends.server.admin.DefinedDefaultBehaviorProvider;
041import org.opends.server.admin.ManagedObjectAlreadyExistsException;
042import org.opends.server.admin.ManagedObjectDefinition;
043import org.opends.server.admin.PropertyOption;
044import org.opends.server.admin.PropertyProvider;
045import org.opends.server.admin.server.ConfigurationChangeListener;
046import org.opends.server.admin.server.ServerManagedObject;
047import org.opends.server.admin.std.client.AnonymousSASLMechanismHandlerCfgClient;
048import org.opends.server.admin.std.server.AnonymousSASLMechanismHandlerCfg;
049import org.opends.server.admin.std.server.SASLMechanismHandlerCfg;
050import org.opends.server.admin.Tag;
051import org.opends.server.types.DN;
052
053
054
055/**
056 * An interface for querying the Anonymous SASL Mechanism Handler
057 * managed object definition meta information.
058 * <p>
059 * The ANONYMOUS SASL mechanism provides the ability for clients to
060 * perform an anonymous bind using a SASL mechanism.
061 */
062public final class AnonymousSASLMechanismHandlerCfgDefn extends ManagedObjectDefinition<AnonymousSASLMechanismHandlerCfgClient, AnonymousSASLMechanismHandlerCfg> {
063
064  // The singleton configuration definition instance.
065  private static final AnonymousSASLMechanismHandlerCfgDefn INSTANCE = new AnonymousSASLMechanismHandlerCfgDefn();
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.COMPONENT_RESTART, INSTANCE, "java-class"));
080      DefaultBehaviorProvider<String> provider = new DefinedDefaultBehaviorProvider<String>("org.opends.server.extensions.AnonymousSASLMechanismHandler");
081      builder.setDefaultBehaviorProvider(provider);
082      builder.addInstanceOf("org.opends.server.api.SASLMechanismHandler");
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("security"));
092  }
093
094
095
096  /**
097   * Get the Anonymous SASL Mechanism Handler configuration definition
098   * singleton.
099   *
100   * @return Returns the Anonymous SASL Mechanism Handler
101   *         configuration definition singleton.
102   */
103  public static AnonymousSASLMechanismHandlerCfgDefn getInstance() {
104    return INSTANCE;
105  }
106
107
108
109  /**
110   * Private constructor.
111   */
112  private AnonymousSASLMechanismHandlerCfgDefn() {
113    super("anonymous-sasl-mechanism-handler", SASLMechanismHandlerCfgDefn.getInstance());
114  }
115
116
117
118  /**
119   * {@inheritDoc}
120   */
121  public AnonymousSASLMechanismHandlerCfgClient createClientConfiguration(
122      ManagedObject<? extends AnonymousSASLMechanismHandlerCfgClient> impl) {
123    return new AnonymousSASLMechanismHandlerCfgClientImpl(impl);
124  }
125
126
127
128  /**
129   * {@inheritDoc}
130   */
131  public AnonymousSASLMechanismHandlerCfg createServerConfiguration(
132      ServerManagedObject<? extends AnonymousSASLMechanismHandlerCfg> impl) {
133    return new AnonymousSASLMechanismHandlerCfgServerImpl(impl);
134  }
135
136
137
138  /**
139   * {@inheritDoc}
140   */
141  public Class<AnonymousSASLMechanismHandlerCfg> getServerConfigurationClass() {
142    return AnonymousSASLMechanismHandlerCfg.class;
143  }
144
145
146
147  /**
148   * Get the "enabled" property definition.
149   * <p>
150   * Indicates whether the SASL mechanism handler is enabled for use.
151   *
152   * @return Returns the "enabled" property definition.
153   */
154  public BooleanPropertyDefinition getEnabledPropertyDefinition() {
155    return SASLMechanismHandlerCfgDefn.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 SASL mechanism handler 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 AnonymousSASLMechanismHandlerCfgClientImpl implements
178    AnonymousSASLMechanismHandlerCfgClient {
179
180    // Private implementation.
181    private ManagedObject<? extends AnonymousSASLMechanismHandlerCfgClient> impl;
182
183
184
185    // Private constructor.
186    private AnonymousSASLMechanismHandlerCfgClientImpl(
187        ManagedObject<? extends AnonymousSASLMechanismHandlerCfgClient> 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 AnonymousSASLMechanismHandlerCfgClient, ? extends AnonymousSASLMechanismHandlerCfg> 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, AuthorizationException,
253        CommunicationException {
254      impl.commit();
255    }
256
257  }
258
259
260
261  /**
262   * Managed object server implementation.
263   */
264  private static class AnonymousSASLMechanismHandlerCfgServerImpl implements
265    AnonymousSASLMechanismHandlerCfg {
266
267    // Private implementation.
268    private ServerManagedObject<? extends AnonymousSASLMechanismHandlerCfg> impl;
269
270    // The value of the "enabled" property.
271    private final boolean pEnabled;
272
273    // The value of the "java-class" property.
274    private final String pJavaClass;
275
276
277
278    // Private constructor.
279    private AnonymousSASLMechanismHandlerCfgServerImpl(ServerManagedObject<? extends AnonymousSASLMechanismHandlerCfg> impl) {
280      this.impl = impl;
281      this.pEnabled = impl.getPropertyValue(INSTANCE.getEnabledPropertyDefinition());
282      this.pJavaClass = impl.getPropertyValue(INSTANCE.getJavaClassPropertyDefinition());
283    }
284
285
286
287    /**
288     * {@inheritDoc}
289     */
290    public void addAnonymousChangeListener(
291        ConfigurationChangeListener<AnonymousSASLMechanismHandlerCfg> listener) {
292      impl.registerChangeListener(listener);
293    }
294
295
296
297    /**
298     * {@inheritDoc}
299     */
300    public void removeAnonymousChangeListener(
301        ConfigurationChangeListener<AnonymousSASLMechanismHandlerCfg> listener) {
302      impl.deregisterChangeListener(listener);
303    }
304    /**
305     * {@inheritDoc}
306     */
307    public void addChangeListener(
308        ConfigurationChangeListener<SASLMechanismHandlerCfg> listener) {
309      impl.registerChangeListener(listener);
310    }
311
312
313
314    /**
315     * {@inheritDoc}
316     */
317    public void removeChangeListener(
318        ConfigurationChangeListener<SASLMechanismHandlerCfg> listener) {
319      impl.deregisterChangeListener(listener);
320    }
321
322
323
324    /**
325     * {@inheritDoc}
326     */
327    public boolean isEnabled() {
328      return pEnabled;
329    }
330
331
332
333    /**
334     * {@inheritDoc}
335     */
336    public String getJavaClass() {
337      return pJavaClass;
338    }
339
340
341
342    /**
343     * {@inheritDoc}
344     */
345    public Class<? extends AnonymousSASLMechanismHandlerCfg> configurationClass() {
346      return AnonymousSASLMechanismHandlerCfg.class;
347    }
348
349
350
351    /**
352     * {@inheritDoc}
353     */
354    public DN dn() {
355      return impl.getDN();
356    }
357
358  }
359}