001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.apache.hadoop.hbase.quotas;
019
020import java.io.IOException;
021import java.util.Collection;
022import java.util.Map.Entry;
023import java.util.Set;
024import org.apache.yetus.audience.InterfaceAudience;
025
026/**
027 * Interface allowing various implementations of tracking files that have recently been archived to
028 * allow for the Master to notice changes to snapshot sizes for space quotas. This object needs to
029 * ensure that {@link #addArchivedFiles(Set)} and {@link #computeAndStoreSnapshotSizes(Collection)}
030 * are mutually exclusive. If a "full" computation is in progress, new changes being archived should
031 * be held.
032 */
033@InterfaceAudience.Private
034public interface FileArchiverNotifier {
035
036  /**
037   * Records a file and its size in bytes being moved to the archive directory.
038   * @param fileSizes A collection of file name to size in bytes
039   * @throws IOException If there was an IO-related error persisting the file size(s)
040   */
041  void addArchivedFiles(Set<Entry<String, Long>> fileSizes) throws IOException;
042
043  /**
044   * Computes the size of a table and all of its snapshots, recording new "full" sizes for each.
045   * @param currentSnapshots the current list of snapshots against this table
046   * @return The total size of all snapshots against this table.
047   * @throws IOException If there was an IO-related error computing or persisting the sizes.
048   */
049  long computeAndStoreSnapshotSizes(Collection<String> currentSnapshots) throws IOException;
050}