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 2010 Sun Microsystems, Inc. 015 * Portions Copyright 2015 ForgeRock AS. 016 */ 017 018package org.opends.server.api; 019 020import java.io.File; 021 022 023/** 024 * This interface defines the set of methods that must be implemented 025 * for a DiskSpaceMonitorHandler. Disk space monitor handlers are 026 * used to receive notifications from the DiskSpaceMonitor service 027 * when the registered thresholds have been reached. 028 */ 029public interface DiskSpaceMonitorHandler { 030 031 /** 032 * Notifies that the registered "low" threshold have been reached. 033 * 034 * @param directory the directory for which the threshold has been triggered 035 * @param thresholdInBytes the threshold value in bytes 036 */ 037 void diskLowThresholdReached(File directory, long thresholdInBytes); 038 039 /** 040 * Notifies that the registered "full" threshold have been reached. 041 * 042 * @param directory the directory for which the threshold has been triggered 043 * @param thresholdInBytes the threshold value in bytes 044 */ 045 void diskFullThresholdReached(File directory, long thresholdInBytes); 046 047 /** 048 * Notifies that the free disk space is now above both "low" and "full" thresholds. 049 * 050 * @param directory the directory for which the threshold has been triggeredTODO 051 * 052 * @param lowThresholdInBytes the low threshold value in bytes 053 * @param fullThresholdInBytes the full threshold value in bytes 054 */ 055 void diskSpaceRestored(File directory, long lowThresholdInBytes, long fullThresholdInBytes); 056}