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 java.util.List;
21  import java.util.Map;
22
23  import org.apache.hadoop.hbase.classification.InterfaceAudience;
24  import org.apache.hadoop.conf.Configuration;
25  import org.apache.hadoop.fs.FileSystem;
26  import org.apache.hadoop.fs.Path;
27  import org.apache.hadoop.hbase.Stoppable;
28  import org.apache.hadoop.hbase.io.HFileLink;
29  import org.apache.hadoop.hbase.regionserver.StoreFileInfo;
30  /**
31   * This Chore, every time it runs, will clear the HFiles in the hfile archive
32   * folder that are deletable for each HFile cleaner in the chain.
33   */
34  @InterfaceAudience.Private
35  public class HFileCleaner extends CleanerChore<BaseHFileCleanerDelegate> {
36
37    public static final String MASTER_HFILE_CLEANER_PLUGINS = "hbase.master.hfilecleaner.plugins";
38
39    public HFileCleaner(final int period, final Stoppable stopper, Configuration conf, FileSystem fs,
40        Path directory) {
41      this(period, stopper, conf, fs, directory, null);
42    }
43
44    /**
45     * @param period the period of time to sleep between each run
46     * @param stopper the stopper
47     * @param conf configuration to use
48     * @param fs handle to the FS
49     * @param directory directory to be cleaned
50     * @param params params could be used in subclass of BaseHFileCleanerDelegate
51     */
52    public HFileCleaner(final int period, final Stoppable stopper, Configuration conf, FileSystem fs,
53                        Path directory, Map<String, Object> params) {
54      super("HFileCleaner", period, stopper, conf, fs,
55        directory, MASTER_HFILE_CLEANER_PLUGINS, params);
56    }
57  
58    @Override
59    protected boolean validate(Path file) {
60      if (HFileLink.isBackReferencesDir(file) || HFileLink.isBackReferencesDir(file.getParent())) {
61        return true;
62      }
63      return StoreFileInfo.validateStoreFileName(file.getName());
64    }
65
66    /**
67     * Exposed for TESTING!
68     */
69    public List<BaseHFileCleanerDelegate> getDelegatesForTesting() {
70      return this.cleanersChain;
71    }
72  }