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