View Javadoc

1   /**
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *     http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing, software
13   * distributed under the License is distributed on an "AS IS" BASIS,
14   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   * See the License for the specific language governing permissions and
16   * limitations under the License.
17   */
18  package org.apache.hadoop.hbase.master.cleaner;
19  
20  import org.apache.hadoop.hbase.classification.InterfaceAudience;
21  import org.apache.hadoop.conf.Configurable;
22  import org.apache.hadoop.fs.FileStatus;
23  import org.apache.hadoop.hbase.Stoppable;
24  
25  import java.util.Map;
26
27  /**
28   * General interface for cleaning files from a folder (generally an archive or
29   * backup folder). These are chained via the {@link CleanerChore} to determine
30   * if a given file should be deleted.
31   */
32  @InterfaceAudience.Private
33  public interface FileCleanerDelegate extends Configurable, Stoppable {
34
35    /**
36     * Determines which of the given files are safe to delete
37     * @param files files to check for deletion
38     * @return files that are ok to delete according to this cleaner
39     */
40    Iterable<FileStatus> getDeletableFiles(Iterable<FileStatus> files);
41
42
43    /**
44     * this method is used to pass some instance into subclass
45     * */
46    void init(Map<String, Object> params);
47  }