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