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 static org.apache.hadoop.hbase.HConstants.HBASE_MASTER_LOGCLEANER_PLUGINS;
21  
22  import org.apache.commons.logging.Log;
23  import org.apache.commons.logging.LogFactory;
24  import org.apache.hadoop.classification.InterfaceAudience;
25  import org.apache.hadoop.conf.Configuration;
26  import org.apache.hadoop.fs.FileSystem;
27  import org.apache.hadoop.fs.Path;
28  import org.apache.hadoop.hbase.Stoppable;
29  import org.apache.hadoop.hbase.regionserver.wal.HLogUtil;
30  
31  /**
32   * This Chore, every time it runs, will attempt to delete the HLogs in the old logs folder. The HLog
33   * is only deleted if none of the cleaner delegates says otherwise.
34   * @see BaseLogCleanerDelegate
35   */
36  @InterfaceAudience.Private
37  public class LogCleaner extends CleanerChore<BaseLogCleanerDelegate> {
38    static final Log LOG = LogFactory.getLog(LogCleaner.class.getName());
39  
40    /**
41     * @param p the period of time to sleep between each run
42     * @param s the stopper
43     * @param conf configuration to use
44     * @param fs handle to the FS
45     * @param oldLogDir the path to the archived logs
46     */
47    public LogCleaner(final int p, final Stoppable s, Configuration conf, FileSystem fs,
48        Path oldLogDir) {
49      super("LogsCleaner", p, s, conf, fs, oldLogDir, HBASE_MASTER_LOGCLEANER_PLUGINS);
50    }
51  
52    @Override
53    protected boolean validate(Path file) {
54      return HLogUtil.validateHLogFilename(file.getName());
55    }
56  }