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.AggregationPropertyDefinition;
032import org.forgerock.opendj.config.BooleanPropertyDefinition;
033import org.forgerock.opendj.config.ClassPropertyDefinition;
034import org.forgerock.opendj.config.client.ConcurrentModificationException;
035import org.forgerock.opendj.config.client.ManagedObject;
036import org.forgerock.opendj.config.client.MissingMandatoryPropertiesException;
037import org.forgerock.opendj.config.client.OperationRejectedException;
038import org.forgerock.opendj.config.conditions.Conditions;
039import org.forgerock.opendj.config.DefaultBehaviorProvider;
040import org.forgerock.opendj.config.DefinedDefaultBehaviorProvider;
041import org.forgerock.opendj.config.ManagedObjectAlreadyExistsException;
042import org.forgerock.opendj.config.ManagedObjectDefinition;
043import org.forgerock.opendj.config.PropertyOption;
044import org.forgerock.opendj.config.PropertyProvider;
045import org.forgerock.opendj.config.server.ConfigurationChangeListener;
046import org.forgerock.opendj.config.server.ServerManagedObject;
047import org.forgerock.opendj.config.Tag;
048import org.forgerock.opendj.config.UndefinedDefaultBehaviorProvider;
049import org.forgerock.opendj.ldap.DN;
050import org.forgerock.opendj.ldap.LdapException;
051import org.forgerock.opendj.server.config.client.CramMD5SASLMechanismHandlerCfgClient;
052import org.forgerock.opendj.server.config.client.IdentityMapperCfgClient;
053import org.forgerock.opendj.server.config.server.CramMD5SASLMechanismHandlerCfg;
054import org.forgerock.opendj.server.config.server.IdentityMapperCfg;
055import org.forgerock.opendj.server.config.server.SASLMechanismHandlerCfg;
056
057
058
059/**
060 * An interface for querying the Cram MD5 SASL Mechanism Handler
061 * managed object definition meta information.
062 * <p>
063 * The CRAM-MD5 SASL mechanism provides the ability for clients to
064 * perform password-based authentication in a manner that does not
065 * expose their password in the clear.
066 */
067public final class CramMD5SASLMechanismHandlerCfgDefn extends ManagedObjectDefinition<CramMD5SASLMechanismHandlerCfgClient, CramMD5SASLMechanismHandlerCfg> {
068
069  // The singleton configuration definition instance.
070  private static final CramMD5SASLMechanismHandlerCfgDefn INSTANCE = new CramMD5SASLMechanismHandlerCfgDefn();
071
072
073
074  // The "identity-mapper" property definition.
075  private static final AggregationPropertyDefinition<IdentityMapperCfgClient, IdentityMapperCfg> PD_IDENTITY_MAPPER;
076
077
078
079  // The "java-class" property definition.
080  private static final ClassPropertyDefinition PD_JAVA_CLASS;
081
082
083
084  // Build the "identity-mapper" property definition.
085  static {
086      AggregationPropertyDefinition.Builder<IdentityMapperCfgClient, IdentityMapperCfg> builder = AggregationPropertyDefinition.createBuilder(INSTANCE, "identity-mapper");
087      builder.setOption(PropertyOption.MANDATORY);
088      builder.setAdministratorAction(new AdministratorAction(AdministratorAction.Type.NONE, INSTANCE, "identity-mapper"));
089      builder.setDefaultBehaviorProvider(new UndefinedDefaultBehaviorProvider<String>());
090      builder.setParentPath("/");
091      builder.setRelationDefinition("identity-mapper");
092      builder.setTargetNeedsEnablingCondition(Conditions.contains("enabled", "true"));
093      builder.setTargetIsEnabledCondition(Conditions.contains("enabled", "true"));
094      PD_IDENTITY_MAPPER = builder.getInstance();
095      INSTANCE.registerPropertyDefinition(PD_IDENTITY_MAPPER);
096      INSTANCE.registerConstraint(PD_IDENTITY_MAPPER.getSourceConstraint());
097  }
098
099
100
101  // Build the "java-class" property definition.
102  static {
103      ClassPropertyDefinition.Builder builder = ClassPropertyDefinition.createBuilder(INSTANCE, "java-class");
104      builder.setOption(PropertyOption.MANDATORY);
105      builder.setOption(PropertyOption.ADVANCED);
106      builder.setAdministratorAction(new AdministratorAction(AdministratorAction.Type.COMPONENT_RESTART, INSTANCE, "java-class"));
107      DefaultBehaviorProvider<String> provider = new DefinedDefaultBehaviorProvider<String>("org.opends.server.extensions.CRAMMD5SASLMechanismHandler");
108      builder.setDefaultBehaviorProvider(provider);
109      builder.addInstanceOf("org.opends.server.api.SASLMechanismHandler");
110      PD_JAVA_CLASS = builder.getInstance();
111      INSTANCE.registerPropertyDefinition(PD_JAVA_CLASS);
112  }
113
114
115
116  // Register the tags associated with this managed object definition.
117  static {
118    INSTANCE.registerTag(Tag.valueOf("security"));
119  }
120
121
122
123  /**
124   * Get the Cram MD5 SASL Mechanism Handler configuration definition
125   * singleton.
126   *
127   * @return Returns the Cram MD5 SASL Mechanism Handler configuration
128   *         definition singleton.
129   */
130  public static CramMD5SASLMechanismHandlerCfgDefn getInstance() {
131    return INSTANCE;
132  }
133
134
135
136  /**
137   * Private constructor.
138   */
139  private CramMD5SASLMechanismHandlerCfgDefn() {
140    super("cram-md5-sasl-mechanism-handler", SASLMechanismHandlerCfgDefn.getInstance());
141  }
142
143
144
145  /**
146   * {@inheritDoc}
147   */
148  public CramMD5SASLMechanismHandlerCfgClient createClientConfiguration(
149      ManagedObject<? extends CramMD5SASLMechanismHandlerCfgClient> impl) {
150    return new CramMD5SASLMechanismHandlerCfgClientImpl(impl);
151  }
152
153
154
155  /**
156   * {@inheritDoc}
157   */
158  public CramMD5SASLMechanismHandlerCfg createServerConfiguration(
159      ServerManagedObject<? extends CramMD5SASLMechanismHandlerCfg> impl) {
160    return new CramMD5SASLMechanismHandlerCfgServerImpl(impl);
161  }
162
163
164
165  /**
166   * {@inheritDoc}
167   */
168  public Class<CramMD5SASLMechanismHandlerCfg> getServerConfigurationClass() {
169    return CramMD5SASLMechanismHandlerCfg.class;
170  }
171
172
173
174  /**
175   * Get the "enabled" property definition.
176   * <p>
177   * Indicates whether the SASL mechanism handler is enabled for use.
178   *
179   * @return Returns the "enabled" property definition.
180   */
181  public BooleanPropertyDefinition getEnabledPropertyDefinition() {
182    return SASLMechanismHandlerCfgDefn.getInstance().getEnabledPropertyDefinition();
183  }
184
185
186
187  /**
188   * Get the "identity-mapper" property definition.
189   * <p>
190   * Specifies the name of the identity mapper used with this SASL
191   * mechanism handler to match the authentication ID included in the
192   * SASL bind request to the corresponding user in the directory.
193   *
194   * @return Returns the "identity-mapper" property definition.
195   */
196  public AggregationPropertyDefinition<IdentityMapperCfgClient, IdentityMapperCfg> getIdentityMapperPropertyDefinition() {
197    return PD_IDENTITY_MAPPER;
198  }
199
200
201
202  /**
203   * Get the "java-class" property definition.
204   * <p>
205   * Specifies the fully-qualified name of the Java class that
206   * provides the SASL mechanism handler implementation.
207   *
208   * @return Returns the "java-class" property definition.
209   */
210  public ClassPropertyDefinition getJavaClassPropertyDefinition() {
211    return PD_JAVA_CLASS;
212  }
213
214
215
216  /**
217   * Managed object client implementation.
218   */
219  private static class CramMD5SASLMechanismHandlerCfgClientImpl implements
220    CramMD5SASLMechanismHandlerCfgClient {
221
222    // Private implementation.
223    private ManagedObject<? extends CramMD5SASLMechanismHandlerCfgClient> impl;
224
225
226
227    // Private constructor.
228    private CramMD5SASLMechanismHandlerCfgClientImpl(
229        ManagedObject<? extends CramMD5SASLMechanismHandlerCfgClient> impl) {
230      this.impl = impl;
231    }
232
233
234
235    /**
236     * {@inheritDoc}
237     */
238    public Boolean isEnabled() {
239      return impl.getPropertyValue(INSTANCE.getEnabledPropertyDefinition());
240    }
241
242
243
244    /**
245     * {@inheritDoc}
246     */
247    public void setEnabled(boolean value) {
248      impl.setPropertyValue(INSTANCE.getEnabledPropertyDefinition(), value);
249    }
250
251
252
253    /**
254     * {@inheritDoc}
255     */
256    public String getIdentityMapper() {
257      return impl.getPropertyValue(INSTANCE.getIdentityMapperPropertyDefinition());
258    }
259
260
261
262    /**
263     * {@inheritDoc}
264     */
265    public void setIdentityMapper(String value) {
266      impl.setPropertyValue(INSTANCE.getIdentityMapperPropertyDefinition(), value);
267    }
268
269
270
271    /**
272     * {@inheritDoc}
273     */
274    public String getJavaClass() {
275      return impl.getPropertyValue(INSTANCE.getJavaClassPropertyDefinition());
276    }
277
278
279
280    /**
281     * {@inheritDoc}
282     */
283    public void setJavaClass(String value) {
284      impl.setPropertyValue(INSTANCE.getJavaClassPropertyDefinition(), value);
285    }
286
287
288
289    /**
290     * {@inheritDoc}
291     */
292    public ManagedObjectDefinition<? extends CramMD5SASLMechanismHandlerCfgClient, ? extends CramMD5SASLMechanismHandlerCfg> definition() {
293      return INSTANCE;
294    }
295
296
297
298    /**
299     * {@inheritDoc}
300     */
301    public PropertyProvider properties() {
302      return impl;
303    }
304
305
306
307    /**
308     * {@inheritDoc}
309     */
310    public void commit() throws ManagedObjectAlreadyExistsException,
311        MissingMandatoryPropertiesException, ConcurrentModificationException,
312        OperationRejectedException, LdapException {
313      impl.commit();
314    }
315
316  }
317
318
319
320  /**
321   * Managed object server implementation.
322   */
323  private static class CramMD5SASLMechanismHandlerCfgServerImpl implements
324    CramMD5SASLMechanismHandlerCfg {
325
326    // Private implementation.
327    private ServerManagedObject<? extends CramMD5SASLMechanismHandlerCfg> impl;
328
329    // The value of the "enabled" property.
330    private final boolean pEnabled;
331
332    // The value of the "identity-mapper" property.
333    private final String pIdentityMapper;
334
335    // The value of the "java-class" property.
336    private final String pJavaClass;
337
338
339
340    // Private constructor.
341    private CramMD5SASLMechanismHandlerCfgServerImpl(ServerManagedObject<? extends CramMD5SASLMechanismHandlerCfg> impl) {
342      this.impl = impl;
343      this.pEnabled = impl.getPropertyValue(INSTANCE.getEnabledPropertyDefinition());
344      this.pIdentityMapper = impl.getPropertyValue(INSTANCE.getIdentityMapperPropertyDefinition());
345      this.pJavaClass = impl.getPropertyValue(INSTANCE.getJavaClassPropertyDefinition());
346    }
347
348
349
350    /**
351     * {@inheritDoc}
352     */
353    public void addCramMD5ChangeListener(
354        ConfigurationChangeListener<CramMD5SASLMechanismHandlerCfg> listener) {
355      impl.registerChangeListener(listener);
356    }
357
358
359
360    /**
361     * {@inheritDoc}
362     */
363    public void removeCramMD5ChangeListener(
364        ConfigurationChangeListener<CramMD5SASLMechanismHandlerCfg> listener) {
365      impl.deregisterChangeListener(listener);
366    }
367    /**
368     * {@inheritDoc}
369     */
370    public void addChangeListener(
371        ConfigurationChangeListener<SASLMechanismHandlerCfg> listener) {
372      impl.registerChangeListener(listener);
373    }
374
375
376
377    /**
378     * {@inheritDoc}
379     */
380    public void removeChangeListener(
381        ConfigurationChangeListener<SASLMechanismHandlerCfg> listener) {
382      impl.deregisterChangeListener(listener);
383    }
384
385
386
387    /**
388     * {@inheritDoc}
389     */
390    public boolean isEnabled() {
391      return pEnabled;
392    }
393
394
395
396    /**
397     * {@inheritDoc}
398     */
399    public String getIdentityMapper() {
400      return pIdentityMapper;
401    }
402
403
404
405    /**
406     * {@inheritDoc}
407     */
408    public DN getIdentityMapperDN() {
409      String value = getIdentityMapper();
410      if (value == null) return null;
411      return INSTANCE.getIdentityMapperPropertyDefinition().getChildDN(value);
412    }
413
414
415
416    /**
417     * {@inheritDoc}
418     */
419    public String getJavaClass() {
420      return pJavaClass;
421    }
422
423
424
425    /**
426     * {@inheritDoc}
427     */
428    public Class<? extends CramMD5SASLMechanismHandlerCfg> configurationClass() {
429      return CramMD5SASLMechanismHandlerCfg.class;
430    }
431
432
433
434    /**
435     * {@inheritDoc}
436     */
437    public DN dn() {
438      return impl.getDN();
439    }
440
441  }
442}