001/* 002 * The contents of this file are subject to the terms of the Common Development and 003 * Distribution License (the License). You may not use this file except in compliance with the 004 * License. 005 * 006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the 007 * specific language governing permission and limitations under the License. 008 * 009 * When distributing Covered Software, include this CDDL Header Notice in each file and include 010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL 011 * Header, with the fields enclosed by brackets [] replaced by your own identifying 012 * information: "Portions Copyright [year] [name of copyright owner]". 013 * 014 * Copyright 2008 Sun Microsystems, Inc. 015 */ 016package org.forgerock.opendj.server.config.client; 017 018 019 020import org.forgerock.opendj.config.ManagedObjectDefinition; 021import org.forgerock.opendj.config.PropertyException; 022import org.forgerock.opendj.server.config.server.FreeDiskSpaceLogRetentionPolicyCfg; 023 024 025 026/** 027 * A client-side interface for reading and modifying Free Disk Space 028 * Log Retention Policy settings. 029 * <p> 030 * Retention policy based on the free disk space available. 031 */ 032public interface FreeDiskSpaceLogRetentionPolicyCfgClient extends LogRetentionPolicyCfgClient { 033 034 /** 035 * Get the configuration definition associated with this Free Disk Space Log Retention Policy. 036 * 037 * @return Returns the configuration definition associated with this Free Disk Space Log Retention Policy. 038 */ 039 ManagedObjectDefinition<? extends FreeDiskSpaceLogRetentionPolicyCfgClient, ? extends FreeDiskSpaceLogRetentionPolicyCfg> definition(); 040 041 042 043 /** 044 * Gets the "free-disk-space" property. 045 * <p> 046 * Specifies the minimum amount of free disk space that should be 047 * available on the file system on which the archived log files are 048 * stored. 049 * 050 * @return Returns the value of the "free-disk-space" property. 051 */ 052 Long getFreeDiskSpace(); 053 054 055 056 /** 057 * Sets the "free-disk-space" property. 058 * <p> 059 * Specifies the minimum amount of free disk space that should be 060 * available on the file system on which the archived log files are 061 * stored. 062 * 063 * @param value The value of the "free-disk-space" property. 064 * @throws PropertyException 065 * If the new value is invalid. 066 */ 067 void setFreeDiskSpace(long value) throws PropertyException; 068 069 070 071 /** 072 * Gets the "java-class" property. 073 * <p> 074 * Specifies the fully-qualified name of the Java class that 075 * provides the Free Disk Space Log Retention Policy implementation. 076 * 077 * @return Returns the value of the "java-class" property. 078 */ 079 String getJavaClass(); 080 081 082 083 /** 084 * Sets the "java-class" property. 085 * <p> 086 * Specifies the fully-qualified name of the Java class that 087 * provides the Free Disk Space Log Retention Policy implementation. 088 * 089 * @param value The value of the "java-class" property. 090 * @throws PropertyException 091 * If the new value is invalid. 092 */ 093 void setJavaClass(String value) throws PropertyException; 094 095}