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