1 /*
2 * Licensed to The Apereo Foundation under one or more contributor license
3 * agreements. See the NOTICE file distributed with this work for additional
4 * information regarding copyright ownership.
5 *
6 *
7 * The Apereo Foundation licenses this file to you under the Educational
8 * Community License, Version 2.0 (the "License"); you may not use this file
9 * except in compliance with the License. You may obtain a copy of the License
10 * at:
11 *
12 * http://opensource.org/licenses/ecl2.txt
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
17 * License for the specific language governing permissions and limitations under
18 * the License.
19 *
20 */
21
22 package org.opencastproject.storage;
23
24 import java.util.Optional;
25
26 /**
27 * Provides access to storage usage information
28 */
29 public interface StorageUsage {
30
31 /**
32 * Gets the total space of storage in Bytes
33 *
34 * @return Number of all bytes in storage
35 */
36 Optional<Long> getTotalSpace();
37
38 /**
39 * Gets the available space of storage in Bytes This is free storage that is not reserved
40 *
41 * @return Number of available bytes in storage
42 */
43 Optional<Long> getUsableSpace();
44
45 /**
46 * Gets the used space of storage in Bytes
47 *
48 * @return Number of used bytes in storage
49 */
50 Optional<Long> getUsedSpace();
51
52 }