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
010     * trunk/opends/resource/legal-notices/OpenDS.LICENSE
011     * or https://OpenDS.dev.java.net/OpenDS.LICENSE.
012     * See the License for the specific language governing permissions
013     * and limitations under the License.
014     *
015     * When distributing Covered Code, include this CDDL HEADER in each
016     * file and include the License file at
017     * trunk/opends/resource/legal-notices/OpenDS.LICENSE.  If applicable,
018     * add the following below this CDDL HEADER, with the fields enclosed
019     * by brackets "[]" replaced with your own identifying information:
020     *      Portions Copyright [yyyy] [name of copyright owner]
021     *
022     * CDDL HEADER END
023     *
024     *
025     *      Copyright 2008 Sun Microsystems, Inc.
026     */
027    package org.opends.server.admin.std.client;
028    
029    
030    
031    import org.opends.server.admin.IllegalPropertyValueException;
032    import org.opends.server.admin.ManagedObjectDefinition;
033    import org.opends.server.admin.std.server.FreeDiskSpaceLogRetentionPolicyCfg;
034    
035    
036    
037    /**
038     * A client-side interface for reading and modifying Free Disk Space
039     * Log Retention Policy settings.
040     * <p>
041     * Retention policy based on the free disk space available.
042     */
043    public interface FreeDiskSpaceLogRetentionPolicyCfgClient extends LogRetentionPolicyCfgClient {
044    
045      /**
046       * Get the configuration definition associated with this Free Disk Space Log Retention Policy.
047       *
048       * @return Returns the configuration definition associated with this Free Disk Space Log Retention Policy.
049       */
050      ManagedObjectDefinition<? extends FreeDiskSpaceLogRetentionPolicyCfgClient, ? extends FreeDiskSpaceLogRetentionPolicyCfg> definition();
051    
052    
053    
054      /**
055       * Gets the "free-disk-space" property.
056       * <p>
057       * Specifies the minimum amount of free disk space that should be
058       * available on the file system on which the archived log files are
059       * stored.
060       *
061       * @return Returns the value of the "free-disk-space" property.
062       */
063      Long getFreeDiskSpace();
064    
065    
066    
067      /**
068       * Sets the "free-disk-space" property.
069       * <p>
070       * Specifies the minimum amount of free disk space that should be
071       * available on the file system on which the archived log files are
072       * stored.
073       *
074       * @param value The value of the "free-disk-space" property.
075       * @throws IllegalPropertyValueException
076       *           If the new value is invalid.
077       */
078      void setFreeDiskSpace(long value) throws IllegalPropertyValueException;
079    
080    
081    
082      /**
083       * Gets the "java-class" property.
084       * <p>
085       * Specifies the fully-qualified name of the Java class that
086       * provides the Free Disk Space Log Retention Policy implementation.
087       *
088       * @return Returns the value of the "java-class" property.
089       */
090      String getJavaClass();
091    
092    
093    
094      /**
095       * Sets the "java-class" property.
096       * <p>
097       * Specifies the fully-qualified name of the Java class that
098       * provides the Free Disk Space Log Retention Policy implementation.
099       *
100       * @param value The value of the "java-class" property.
101       * @throws IllegalPropertyValueException
102       *           If the new value is invalid.
103       */
104      void setJavaClass(String value) throws IllegalPropertyValueException;
105    
106    }