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