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 java.util.Collection;
031import java.util.SortedSet;
032import org.forgerock.opendj.config.ACIPropertyDefinition;
033import org.forgerock.opendj.config.AdministratorAction;
034import org.forgerock.opendj.config.AliasDefaultBehaviorProvider;
035import org.forgerock.opendj.config.BooleanPropertyDefinition;
036import org.forgerock.opendj.config.ClassPropertyDefinition;
037import org.forgerock.opendj.config.client.ConcurrentModificationException;
038import org.forgerock.opendj.config.client.ManagedObject;
039import org.forgerock.opendj.config.client.MissingMandatoryPropertiesException;
040import org.forgerock.opendj.config.client.OperationRejectedException;
041import org.forgerock.opendj.config.DefaultBehaviorProvider;
042import org.forgerock.opendj.config.DefinedDefaultBehaviorProvider;
043import org.forgerock.opendj.config.ManagedObjectAlreadyExistsException;
044import org.forgerock.opendj.config.ManagedObjectDefinition;
045import org.forgerock.opendj.config.PropertyOption;
046import org.forgerock.opendj.config.PropertyProvider;
047import org.forgerock.opendj.config.server.ConfigurationChangeListener;
048import org.forgerock.opendj.config.server.ServerManagedObject;
049import org.forgerock.opendj.config.Tag;
050import org.forgerock.opendj.ldap.DN;
051import org.forgerock.opendj.ldap.LdapException;
052import org.forgerock.opendj.server.config.client.DseeCompatAccessControlHandlerCfgClient;
053import org.forgerock.opendj.server.config.server.AccessControlHandlerCfg;
054import org.forgerock.opendj.server.config.server.DseeCompatAccessControlHandlerCfg;
055
056
057
058/**
059 * An interface for querying the Dsee Compat Access Control Handler
060 * managed object definition meta information.
061 * <p>
062 * The Dsee Compat Access Control Handler provides an implementation
063 * that uses syntax compatible with the Sun Java System Directory
064 * Server Enterprise Edition access control handlers.
065 */
066public final class DseeCompatAccessControlHandlerCfgDefn extends ManagedObjectDefinition<DseeCompatAccessControlHandlerCfgClient, DseeCompatAccessControlHandlerCfg> {
067
068  /** The singleton configuration definition instance. */
069  private static final DseeCompatAccessControlHandlerCfgDefn INSTANCE = new DseeCompatAccessControlHandlerCfgDefn();
070
071
072
073  /** The "global-aci" property definition. */
074  private static final ACIPropertyDefinition PD_GLOBAL_ACI;
075
076
077
078  /** The "java-class" property definition. */
079  private static final ClassPropertyDefinition PD_JAVA_CLASS;
080
081
082
083  /** Build the "global-aci" property definition. */
084  static {
085      ACIPropertyDefinition.Builder builder = ACIPropertyDefinition.createBuilder(INSTANCE, "global-aci");
086      builder.setOption(PropertyOption.MULTI_VALUED);
087      builder.setAdministratorAction(new AdministratorAction(AdministratorAction.Type.NONE, INSTANCE, "global-aci"));
088      builder.setDefaultBehaviorProvider(new AliasDefaultBehaviorProvider<String>(INSTANCE, "global-aci"));
089      PD_GLOBAL_ACI = builder.getInstance();
090      INSTANCE.registerPropertyDefinition(PD_GLOBAL_ACI);
091  }
092
093
094
095  /** Build the "java-class" property definition. */
096  static {
097      ClassPropertyDefinition.Builder builder = ClassPropertyDefinition.createBuilder(INSTANCE, "java-class");
098      builder.setOption(PropertyOption.MANDATORY);
099      builder.setOption(PropertyOption.ADVANCED);
100      builder.setAdministratorAction(new AdministratorAction(AdministratorAction.Type.COMPONENT_RESTART, INSTANCE, "java-class"));
101      DefaultBehaviorProvider<String> provider = new DefinedDefaultBehaviorProvider<String>("org.opends.server.authorization.dseecompat.AciHandler");
102      builder.setDefaultBehaviorProvider(provider);
103      builder.addInstanceOf("org.opends.server.api.AccessControlHandler");
104      PD_JAVA_CLASS = builder.getInstance();
105      INSTANCE.registerPropertyDefinition(PD_JAVA_CLASS);
106  }
107
108
109
110  // Register the tags associated with this managed object definition.
111  static {
112    INSTANCE.registerTag(Tag.valueOf("security"));
113  }
114
115
116
117  /**
118   * Get the Dsee Compat Access Control Handler configuration
119   * definition singleton.
120   *
121   * @return Returns the Dsee Compat Access Control Handler
122   *         configuration definition singleton.
123   */
124  public static DseeCompatAccessControlHandlerCfgDefn getInstance() {
125    return INSTANCE;
126  }
127
128
129
130  /**
131   * Private constructor.
132   */
133  private DseeCompatAccessControlHandlerCfgDefn() {
134    super("dsee-compat-access-control-handler", AccessControlHandlerCfgDefn.getInstance());
135  }
136
137
138
139  /** {@inheritDoc} */
140  public DseeCompatAccessControlHandlerCfgClient createClientConfiguration(
141      ManagedObject<? extends DseeCompatAccessControlHandlerCfgClient> impl) {
142    return new DseeCompatAccessControlHandlerCfgClientImpl(impl);
143  }
144
145
146
147  /** {@inheritDoc} */
148  public DseeCompatAccessControlHandlerCfg createServerConfiguration(
149      ServerManagedObject<? extends DseeCompatAccessControlHandlerCfg> impl) {
150    return new DseeCompatAccessControlHandlerCfgServerImpl(impl);
151  }
152
153
154
155  /** {@inheritDoc} */
156  public Class<DseeCompatAccessControlHandlerCfg> getServerConfigurationClass() {
157    return DseeCompatAccessControlHandlerCfg.class;
158  }
159
160
161
162  /**
163   * Get the "enabled" property definition.
164   * <p>
165   * Indicates whether the Dsee Compat Access Control Handler is
166   * enabled. If set to FALSE, then no access control is enforced, and
167   * any client (including unauthenticated or anonymous clients) could
168   * be allowed to perform any operation if not subject to other
169   * restrictions, such as those enforced by the privilege subsystem.
170   *
171   * @return Returns the "enabled" property definition.
172   */
173  public BooleanPropertyDefinition getEnabledPropertyDefinition() {
174    return AccessControlHandlerCfgDefn.getInstance().getEnabledPropertyDefinition();
175  }
176
177
178
179  /**
180   * Get the "global-aci" property definition.
181   * <p>
182   * Defines global access control rules.
183   * <p>
184   * Global access control rules apply to all entries anywhere in the
185   * data managed by the OpenDJ directory server. The global access
186   * control rules may be overridden by more specific access control
187   * rules placed in the data.
188   *
189   * @return Returns the "global-aci" property definition.
190   */
191  public ACIPropertyDefinition getGlobalACIPropertyDefinition() {
192    return PD_GLOBAL_ACI;
193  }
194
195
196
197  /**
198   * Get the "java-class" property definition.
199   * <p>
200   * Specifies the fully-qualified name of the Java class that
201   * provides the Dsee Compat Access Control Handler implementation.
202   *
203   * @return Returns the "java-class" property definition.
204   */
205  public ClassPropertyDefinition getJavaClassPropertyDefinition() {
206    return PD_JAVA_CLASS;
207  }
208
209
210
211  /**
212   * Managed object client implementation.
213   */
214  private static class DseeCompatAccessControlHandlerCfgClientImpl implements
215    DseeCompatAccessControlHandlerCfgClient {
216
217    /** Private implementation. */
218    private ManagedObject<? extends DseeCompatAccessControlHandlerCfgClient> impl;
219
220
221
222    /** Private constructor. */
223    private DseeCompatAccessControlHandlerCfgClientImpl(
224        ManagedObject<? extends DseeCompatAccessControlHandlerCfgClient> impl) {
225      this.impl = impl;
226    }
227
228
229
230    /** {@inheritDoc} */
231    public Boolean isEnabled() {
232      return impl.getPropertyValue(INSTANCE.getEnabledPropertyDefinition());
233    }
234
235
236
237    /** {@inheritDoc} */
238    public void setEnabled(boolean value) {
239      impl.setPropertyValue(INSTANCE.getEnabledPropertyDefinition(), value);
240    }
241
242
243
244    /** {@inheritDoc} */
245    public SortedSet<String> getGlobalACI() {
246      return impl.getPropertyValues(INSTANCE.getGlobalACIPropertyDefinition());
247    }
248
249
250
251    /** {@inheritDoc} */
252    public void setGlobalACI(Collection<String> values) {
253      impl.setPropertyValues(INSTANCE.getGlobalACIPropertyDefinition(), values);
254    }
255
256
257
258    /** {@inheritDoc} */
259    public String getJavaClass() {
260      return impl.getPropertyValue(INSTANCE.getJavaClassPropertyDefinition());
261    }
262
263
264
265    /** {@inheritDoc} */
266    public void setJavaClass(String value) {
267      impl.setPropertyValue(INSTANCE.getJavaClassPropertyDefinition(), value);
268    }
269
270
271
272    /** {@inheritDoc} */
273    public ManagedObjectDefinition<? extends DseeCompatAccessControlHandlerCfgClient, ? extends DseeCompatAccessControlHandlerCfg> definition() {
274      return INSTANCE;
275    }
276
277
278
279    /** {@inheritDoc} */
280    public PropertyProvider properties() {
281      return impl;
282    }
283
284
285
286    /** {@inheritDoc} */
287    public void commit() throws ManagedObjectAlreadyExistsException,
288        MissingMandatoryPropertiesException, ConcurrentModificationException,
289        OperationRejectedException, LdapException {
290      impl.commit();
291    }
292
293
294
295    /** {@inheritDoc} */
296    public String toString() {
297      return impl.toString();
298    }
299  }
300
301
302
303  /**
304   * Managed object server implementation.
305   */
306  private static class DseeCompatAccessControlHandlerCfgServerImpl implements
307    DseeCompatAccessControlHandlerCfg {
308
309    /** Private implementation. */
310    private ServerManagedObject<? extends DseeCompatAccessControlHandlerCfg> impl;
311
312    /** The value of the "enabled" property. */
313    private final boolean pEnabled;
314
315    /** The value of the "global-aci" property. */
316    private final SortedSet<String> pGlobalACI;
317
318    /** The value of the "java-class" property. */
319    private final String pJavaClass;
320
321
322
323    /** Private constructor. */
324    private DseeCompatAccessControlHandlerCfgServerImpl(ServerManagedObject<? extends DseeCompatAccessControlHandlerCfg> impl) {
325      this.impl = impl;
326      this.pEnabled = impl.getPropertyValue(INSTANCE.getEnabledPropertyDefinition());
327      this.pGlobalACI = impl.getPropertyValues(INSTANCE.getGlobalACIPropertyDefinition());
328      this.pJavaClass = impl.getPropertyValue(INSTANCE.getJavaClassPropertyDefinition());
329    }
330
331
332
333    /** {@inheritDoc} */
334    public void addDseeCompatChangeListener(
335        ConfigurationChangeListener<DseeCompatAccessControlHandlerCfg> listener) {
336      impl.registerChangeListener(listener);
337    }
338
339
340
341    /** {@inheritDoc} */
342    public void removeDseeCompatChangeListener(
343        ConfigurationChangeListener<DseeCompatAccessControlHandlerCfg> listener) {
344      impl.deregisterChangeListener(listener);
345    }
346    /** {@inheritDoc} */
347    public void addChangeListener(
348        ConfigurationChangeListener<AccessControlHandlerCfg> listener) {
349      impl.registerChangeListener(listener);
350    }
351
352
353
354    /** {@inheritDoc} */
355    public void removeChangeListener(
356        ConfigurationChangeListener<AccessControlHandlerCfg> listener) {
357      impl.deregisterChangeListener(listener);
358    }
359
360
361
362    /** {@inheritDoc} */
363    public boolean isEnabled() {
364      return pEnabled;
365    }
366
367
368
369    /** {@inheritDoc} */
370    public SortedSet<String> getGlobalACI() {
371      return pGlobalACI;
372    }
373
374
375
376    /** {@inheritDoc} */
377    public String getJavaClass() {
378      return pJavaClass;
379    }
380
381
382
383    /** {@inheritDoc} */
384    public Class<? extends DseeCompatAccessControlHandlerCfg> configurationClass() {
385      return DseeCompatAccessControlHandlerCfg.class;
386    }
387
388
389
390    /** {@inheritDoc} */
391    public DN dn() {
392      return impl.getDN();
393    }
394
395
396
397    /** {@inheritDoc} */
398    public String toString() {
399      return impl.toString();
400    }
401  }
402}