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