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.client;
027
028
029
030import org.opends.server.admin.ManagedObjectDefinition;
031import org.opends.server.admin.PropertyException;
032import org.opends.server.admin.std.server.FreeDiskSpaceLogRetentionPolicyCfg;
033
034
035
036/**
037 * A client-side interface for reading and modifying Free Disk Space
038 * Log Retention Policy settings.
039 * <p>
040 * Retention policy based on the free disk space available.
041 */
042public interface FreeDiskSpaceLogRetentionPolicyCfgClient extends LogRetentionPolicyCfgClient {
043
044  /**
045   * Get the configuration definition associated with this Free Disk Space Log Retention Policy.
046   *
047   * @return Returns the configuration definition associated with this Free Disk Space Log Retention Policy.
048   */
049  ManagedObjectDefinition<? extends FreeDiskSpaceLogRetentionPolicyCfgClient, ? extends FreeDiskSpaceLogRetentionPolicyCfg> definition();
050
051
052
053  /**
054   * Gets the "free-disk-space" property.
055   * <p>
056   * Specifies the minimum amount of free disk space that should be
057   * available on the file system on which the archived log files are
058   * stored.
059   *
060   * @return Returns the value of the "free-disk-space" property.
061   */
062  Long getFreeDiskSpace();
063
064
065
066  /**
067   * Sets the "free-disk-space" property.
068   * <p>
069   * Specifies the minimum amount of free disk space that should be
070   * available on the file system on which the archived log files are
071   * stored.
072   *
073   * @param value The value of the "free-disk-space" property.
074   * @throws PropertyException
075   *           If the new value is invalid.
076   */
077  void setFreeDiskSpace(long value) throws PropertyException;
078
079
080
081  /**
082   * Gets the "java-class" property.
083   * <p>
084   * Specifies the fully-qualified name of the Java class that
085   * provides the Free Disk Space Log Retention Policy implementation.
086   *
087   * @return Returns the value of the "java-class" property.
088   */
089  String getJavaClass();
090
091
092
093  /**
094   * Sets the "java-class" property.
095   * <p>
096   * Specifies the fully-qualified name of the Java class that
097   * provides the Free Disk Space Log Retention Policy implementation.
098   *
099   * @param value The value of the "java-class" property.
100   * @throws PropertyException
101   *           If the new value is invalid.
102   */
103  void setJavaClass(String value) throws PropertyException;
104
105}