StorageUsage.java

/**
 * Licensed to The Apereo Foundation under one or more contributor license
 * agreements. See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 *
 * The Apereo Foundation licenses this file to you under the Educational
 * Community License, Version 2.0 (the "License"); you may not use this file
 * except in compliance with the License. You may obtain a copy of the License
 * at:
 *
 *   http://opensource.org/licenses/ecl2.txt
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
 * License for the specific language governing permissions and limitations under
 * the License.
 *
 */

package org.opencastproject.storage;

import org.opencastproject.util.data.Option;

/**
 * Provides access to storage usage information
 */
public interface StorageUsage {

  /**
   * Gets the total space of storage in Bytes
   *
   * @return Number of all bytes in storage
   */
  Option<Long> getTotalSpace();

  /**
   * Gets the available space of storage in Bytes This is free storage that is not reserved
   *
   * @return Number of available bytes in storage
   */
  Option<Long> getUsableSpace();

  /**
   * Gets the used space of storage in Bytes
   *
   * @return Number of used bytes in storage
   */
  Option<Long> getUsedSpace();

}