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 legal-notices/CDDLv1_0.txt
010 * or http://forgerock.org/license/CDDLv1.0.html.
011 * See the License for the specific language governing permissions
012 * and limitations under the License.
013 *
014 * When distributing Covered Code, include this CDDL HEADER in each
015 * file and include the License file at legal-notices/CDDLv1_0.txt.
016 * If applicable, add the following below this CDDL HEADER, with the
017 * fields enclosed by brackets "[]" replaced with your own identifying
018 * information:
019 *      Portions Copyright [yyyy] [name of copyright owner]
020 *
021 * CDDL HEADER END
022 *
023 *
024 *      Copyright 2010 Sun Microsystems, Inc.
025 *      Portions Copyright 2015 ForgeRock AS
026 */
027
028package org.opends.server.api;
029
030import java.io.File;
031
032
033/**
034 * This interface defines the set of methods that must be implemented
035 * for a DiskSpaceMonitorHandler.  Disk space monitor handlers are
036 * used to receive notifications from the DiskSpaceMonitor service
037 * when the registered thresholds have been reached.
038 */
039public interface DiskSpaceMonitorHandler {
040
041  /**
042   * Notifies that the registered "low" threshold have been reached.
043   *
044   * @param directory the directory for which the threshold has been triggered
045   * @param thresholdInBytes the threshold value in bytes
046   */
047  void diskLowThresholdReached(File directory, long thresholdInBytes);
048
049  /**
050   * Notifies that the registered "full" threshold have been reached.
051   *
052   * @param directory the directory for which the threshold has been triggered
053   * @param thresholdInBytes the threshold value in bytes
054   */
055  void diskFullThresholdReached(File directory, long thresholdInBytes);
056
057  /**
058   * Notifies that the free disk space is now above both "low" and "full" thresholds.
059   *
060   * @param directory the directory for which the threshold has been triggeredTODO
061   *
062   * @param lowThresholdInBytes the low threshold value in bytes
063   * @param fullThresholdInBytes the full threshold value in bytes
064   */
065  void diskSpaceRestored(File directory, long lowThresholdInBytes, long fullThresholdInBytes);
066}