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