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.ManagedObjectAlreadyExistsException;
038import org.forgerock.opendj.config.ManagedObjectDefinition;
039import org.forgerock.opendj.config.PropertyOption;
040import org.forgerock.opendj.config.PropertyProvider;
041import org.forgerock.opendj.config.server.ConfigurationChangeListener;
042import org.forgerock.opendj.config.server.ServerManagedObject;
043import org.forgerock.opendj.config.Tag;
044import org.forgerock.opendj.config.TopCfgDefn;
045import org.forgerock.opendj.config.UndefinedDefaultBehaviorProvider;
046import org.forgerock.opendj.ldap.DN;
047import org.forgerock.opendj.ldap.LdapException;
048import org.forgerock.opendj.server.config.client.IdentityMapperCfgClient;
049import org.forgerock.opendj.server.config.server.IdentityMapperCfg;
050
051
052
053/**
054 * An interface for querying the Identity Mapper managed object
055 * definition meta information.
056 * <p>
057 * Identity Mappers are responsible for establishing a mapping between
058 * an identifier string provided by a client, and the entry for the
059 * user that corresponds to that identifier. Identity Mappers are used
060 * to process several SASL mechanisms to map an authorization ID (e.g.,
061 * a Kerberos principal when using GSSAPI) to a directory user. They
062 * are also used when processing requests with the proxied
063 * authorization control.
064 */
065public final class IdentityMapperCfgDefn extends ManagedObjectDefinition<IdentityMapperCfgClient, IdentityMapperCfg> {
066
067  // The singleton configuration definition instance.
068  private static final IdentityMapperCfgDefn INSTANCE = new IdentityMapperCfgDefn();
069
070
071
072  // The "enabled" property definition.
073  private static final BooleanPropertyDefinition PD_ENABLED;
074
075
076
077  // The "java-class" property definition.
078  private static final ClassPropertyDefinition PD_JAVA_CLASS;
079
080
081
082  // Build the "enabled" property definition.
083  static {
084      BooleanPropertyDefinition.Builder builder = BooleanPropertyDefinition.createBuilder(INSTANCE, "enabled");
085      builder.setOption(PropertyOption.MANDATORY);
086      builder.setAdministratorAction(new AdministratorAction(AdministratorAction.Type.NONE, INSTANCE, "enabled"));
087      builder.setDefaultBehaviorProvider(new UndefinedDefaultBehaviorProvider<Boolean>());
088      PD_ENABLED = builder.getInstance();
089      INSTANCE.registerPropertyDefinition(PD_ENABLED);
090  }
091
092
093
094  // Build the "java-class" property definition.
095  static {
096      ClassPropertyDefinition.Builder builder = ClassPropertyDefinition.createBuilder(INSTANCE, "java-class");
097      builder.setOption(PropertyOption.MANDATORY);
098      builder.setAdministratorAction(new AdministratorAction(AdministratorAction.Type.COMPONENT_RESTART, INSTANCE, "java-class"));
099      builder.setDefaultBehaviorProvider(new UndefinedDefaultBehaviorProvider<String>());
100      builder.addInstanceOf("org.opends.server.api.IdentityMapper");
101      PD_JAVA_CLASS = builder.getInstance();
102      INSTANCE.registerPropertyDefinition(PD_JAVA_CLASS);
103  }
104
105
106
107  // Register the tags associated with this managed object definition.
108  static {
109    INSTANCE.registerTag(Tag.valueOf("security"));
110    INSTANCE.registerTag(Tag.valueOf("user-management"));
111  }
112
113
114
115  /**
116   * Get the Identity Mapper configuration definition singleton.
117   *
118   * @return Returns the Identity Mapper configuration definition
119   *         singleton.
120   */
121  public static IdentityMapperCfgDefn getInstance() {
122    return INSTANCE;
123  }
124
125
126
127  /**
128   * Private constructor.
129   */
130  private IdentityMapperCfgDefn() {
131    super("identity-mapper", TopCfgDefn.getInstance());
132  }
133
134
135
136  /**
137   * {@inheritDoc}
138   */
139  public IdentityMapperCfgClient createClientConfiguration(
140      ManagedObject<? extends IdentityMapperCfgClient> impl) {
141    return new IdentityMapperCfgClientImpl(impl);
142  }
143
144
145
146  /**
147   * {@inheritDoc}
148   */
149  public IdentityMapperCfg createServerConfiguration(
150      ServerManagedObject<? extends IdentityMapperCfg> impl) {
151    return new IdentityMapperCfgServerImpl(impl);
152  }
153
154
155
156  /**
157   * {@inheritDoc}
158   */
159  public Class<IdentityMapperCfg> getServerConfigurationClass() {
160    return IdentityMapperCfg.class;
161  }
162
163
164
165  /**
166   * Get the "enabled" property definition.
167   * <p>
168   * Indicates whether the Identity Mapper is enabled for use.
169   *
170   * @return Returns the "enabled" property definition.
171   */
172  public BooleanPropertyDefinition getEnabledPropertyDefinition() {
173    return PD_ENABLED;
174  }
175
176
177
178  /**
179   * Get the "java-class" property definition.
180   * <p>
181   * Specifies the fully-qualified name of the Java class that
182   * provides the Identity Mapper implementation.
183   *
184   * @return Returns the "java-class" property definition.
185   */
186  public ClassPropertyDefinition getJavaClassPropertyDefinition() {
187    return PD_JAVA_CLASS;
188  }
189
190
191
192  /**
193   * Managed object client implementation.
194   */
195  private static class IdentityMapperCfgClientImpl implements
196    IdentityMapperCfgClient {
197
198    // Private implementation.
199    private ManagedObject<? extends IdentityMapperCfgClient> impl;
200
201
202
203    // Private constructor.
204    private IdentityMapperCfgClientImpl(
205        ManagedObject<? extends IdentityMapperCfgClient> impl) {
206      this.impl = impl;
207    }
208
209
210
211    /**
212     * {@inheritDoc}
213     */
214    public Boolean isEnabled() {
215      return impl.getPropertyValue(INSTANCE.getEnabledPropertyDefinition());
216    }
217
218
219
220    /**
221     * {@inheritDoc}
222     */
223    public void setEnabled(boolean value) {
224      impl.setPropertyValue(INSTANCE.getEnabledPropertyDefinition(), value);
225    }
226
227
228
229    /**
230     * {@inheritDoc}
231     */
232    public String getJavaClass() {
233      return impl.getPropertyValue(INSTANCE.getJavaClassPropertyDefinition());
234    }
235
236
237
238    /**
239     * {@inheritDoc}
240     */
241    public void setJavaClass(String value) {
242      impl.setPropertyValue(INSTANCE.getJavaClassPropertyDefinition(), value);
243    }
244
245
246
247    /**
248     * {@inheritDoc}
249     */
250    public ManagedObjectDefinition<? extends IdentityMapperCfgClient, ? extends IdentityMapperCfg> definition() {
251      return INSTANCE;
252    }
253
254
255
256    /**
257     * {@inheritDoc}
258     */
259    public PropertyProvider properties() {
260      return impl;
261    }
262
263
264
265    /**
266     * {@inheritDoc}
267     */
268    public void commit() throws ManagedObjectAlreadyExistsException,
269        MissingMandatoryPropertiesException, ConcurrentModificationException,
270        OperationRejectedException, LdapException {
271      impl.commit();
272    }
273
274  }
275
276
277
278  /**
279   * Managed object server implementation.
280   */
281  private static class IdentityMapperCfgServerImpl implements
282    IdentityMapperCfg {
283
284    // Private implementation.
285    private ServerManagedObject<? extends IdentityMapperCfg> impl;
286
287    // The value of the "enabled" property.
288    private final boolean pEnabled;
289
290    // The value of the "java-class" property.
291    private final String pJavaClass;
292
293
294
295    // Private constructor.
296    private IdentityMapperCfgServerImpl(ServerManagedObject<? extends IdentityMapperCfg> impl) {
297      this.impl = impl;
298      this.pEnabled = impl.getPropertyValue(INSTANCE.getEnabledPropertyDefinition());
299      this.pJavaClass = impl.getPropertyValue(INSTANCE.getJavaClassPropertyDefinition());
300    }
301
302
303
304    /**
305     * {@inheritDoc}
306     */
307    public void addChangeListener(
308        ConfigurationChangeListener<IdentityMapperCfg> listener) {
309      impl.registerChangeListener(listener);
310    }
311
312
313
314    /**
315     * {@inheritDoc}
316     */
317    public void removeChangeListener(
318        ConfigurationChangeListener<IdentityMapperCfg> 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 IdentityMapperCfg> configurationClass() {
346      return IdentityMapperCfg.class;
347    }
348
349
350
351    /**
352     * {@inheritDoc}
353     */
354    public DN dn() {
355      return impl.getDN();
356    }
357
358  }
359}