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.server;
027
028
029
030import org.opends.server.admin.server.ConfigurationChangeListener;
031
032
033
034/**
035 * A server-side interface for querying Free Disk Space Log Retention
036 * Policy settings.
037 * <p>
038 * Retention policy based on the free disk space available.
039 */
040public interface FreeDiskSpaceLogRetentionPolicyCfg extends LogRetentionPolicyCfg {
041
042  /**
043   * Gets the configuration class associated with this Free Disk Space Log Retention Policy.
044   *
045   * @return Returns the configuration class associated with this Free Disk Space Log Retention Policy.
046   */
047  Class<? extends FreeDiskSpaceLogRetentionPolicyCfg> configurationClass();
048
049
050
051  /**
052   * Register to be notified when this Free Disk Space Log Retention Policy is changed.
053   *
054   * @param listener
055   *          The Free Disk Space Log Retention Policy configuration change listener.
056   */
057  void addFreeDiskSpaceChangeListener(ConfigurationChangeListener<FreeDiskSpaceLogRetentionPolicyCfg> listener);
058
059
060
061  /**
062   * Deregister an existing Free Disk Space Log Retention Policy configuration change listener.
063   *
064   * @param listener
065   *          The Free Disk Space Log Retention Policy configuration change listener.
066   */
067  void removeFreeDiskSpaceChangeListener(ConfigurationChangeListener<FreeDiskSpaceLogRetentionPolicyCfg> listener);
068
069
070
071  /**
072   * Gets the "free-disk-space" property.
073   * <p>
074   * Specifies the minimum amount of free disk space that should be
075   * available on the file system on which the archived log files are
076   * stored.
077   *
078   * @return Returns the value of the "free-disk-space" property.
079   */
080  long getFreeDiskSpace();
081
082
083
084  /**
085   * Gets the "java-class" property.
086   * <p>
087   * Specifies the fully-qualified name of the Java class that
088   * provides the Free Disk Space Log Retention Policy implementation.
089   *
090   * @return Returns the value of the "java-class" property.
091   */
092  String getJavaClass();
093
094}