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