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