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.SizeLimitLogRetentionPolicyCfg;
034    
035    
036    
037    /**
038     * A client-side interface for reading and modifying Size Limit Log
039     * Retention Policy settings.
040     * <p>
041     * Retention policy based on the amount of space taken by all the log
042     * files on disk.
043     */
044    public interface SizeLimitLogRetentionPolicyCfgClient extends LogRetentionPolicyCfgClient {
045    
046      /**
047       * Get the configuration definition associated with this Size Limit Log Retention Policy.
048       *
049       * @return Returns the configuration definition associated with this Size Limit Log Retention Policy.
050       */
051      ManagedObjectDefinition<? extends SizeLimitLogRetentionPolicyCfgClient, ? extends SizeLimitLogRetentionPolicyCfg> definition();
052    
053    
054    
055      /**
056       * Gets the "disk-space-used" property.
057       * <p>
058       * Specifies the maximum total disk space used by the log files.
059       *
060       * @return Returns the value of the "disk-space-used" property.
061       */
062      Long getDiskSpaceUsed();
063    
064    
065    
066      /**
067       * Sets the "disk-space-used" property.
068       * <p>
069       * Specifies the maximum total disk space used by the log files.
070       *
071       * @param value The value of the "disk-space-used" property.
072       * @throws IllegalPropertyValueException
073       *           If the new value is invalid.
074       */
075      void setDiskSpaceUsed(long value) throws IllegalPropertyValueException;
076    
077    
078    
079      /**
080       * Gets the "java-class" property.
081       * <p>
082       * Specifies the fully-qualified name of the Java class that
083       * provides the Size Limit Log Retention Policy implementation.
084       *
085       * @return Returns the value of the "java-class" property.
086       */
087      String getJavaClass();
088    
089    
090    
091      /**
092       * Sets the "java-class" property.
093       * <p>
094       * Specifies the fully-qualified name of the Java class that
095       * provides the Size Limit Log Retention Policy implementation.
096       *
097       * @param value The value of the "java-class" property.
098       * @throws IllegalPropertyValueException
099       *           If the new value is invalid.
100       */
101      void setJavaClass(String value) throws IllegalPropertyValueException;
102    
103    }