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.master.cleaner;
019
020import java.util.Map;
021import org.apache.hadoop.fs.FileStatus;
022import org.apache.hadoop.hbase.BaseConfigurable;
023import org.apache.yetus.audience.InterfaceAudience;
024
025import org.apache.hbase.thirdparty.com.google.common.collect.Iterables;
026
027/**
028 * Base class for file cleaners which allows subclasses to implement a simple isFileDeletable method
029 * (which used to be the FileCleanerDelegate contract).
030 */
031@InterfaceAudience.Private
032public abstract class BaseFileCleanerDelegate extends BaseConfigurable
033  implements FileCleanerDelegate {
034
035  @Override
036  public Iterable<FileStatus> getDeletableFiles(Iterable<FileStatus> files) {
037    return Iterables.filter(files, this::isFileDeletable);
038  }
039
040  @Override
041  public void init(Map<String, Object> params) {
042    // subclass could override it if needed.
043  }
044
045  /**
046   * Should the master delete the file or keep it?
047   * @param fStat file status of the file to check
048   * @return <tt>true</tt> if the file is deletable, <tt>false</tt> if not
049   */
050  protected abstract boolean isFileDeletable(FileStatus fStat);
051
052}