HFileCleaner (Apache HBase 1.2.12 API)

java.lang.Object
- org.apache.hadoop.hbase.ScheduledChore
- - org.apache.hadoop.hbase.master.cleaner.CleanerChore<BaseHFileCleanerDelegate>
  - - org.apache.hadoop.hbase.master.cleaner.HFileCleaner

All Implemented Interfaces:

Runnable
```
@InterfaceAudience.Private
public class HFileCleaner
extends CleanerChore<BaseHFileCleanerDelegate>
```
This Chore, every time it runs, will clear the HFiles in the hfile archive folder that are deletable for each HFile cleaner in the chain.

Field Summary

Fields
Modifier and Type Field and Description

static String MASTER_HFILE_CLEANER_PLUGINS
- Fields inherited from class org.apache.hadoop.hbase.master.cleaner.CleanerChore
  cleanersChain, params

Fields
Modifier and Type	Field and Description
`static String`	`MASTER_HFILE_CLEANER_PLUGINS`

Constructor Summary

Constructors
Constructor and Description
`HFileCleaner(int period, Stoppable stopper, org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.fs.Path directory)`
`HFileCleaner(int period, Stoppable stopper, org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.fs.Path directory, Map<String,Object> params)`

Method Summary

Methods
Modifier and Type	Method and Description
`List<BaseHFileCleanerDelegate>`	`getDelegatesForTesting()` Exposed for TESTING!
`protected boolean`	`validate(org.apache.hadoop.fs.Path file)` Validate the file to see if it even belongs in the directory.

Methods inherited from class org.apache.hadoop.hbase.master.cleaner.CleanerChore
checkAndDeleteDirectory, chore, cleanup

Methods inherited from class org.apache.hadoop.hbase.ScheduledChore
cancel, cancel, choreForTesting, getInitialDelay, getName, getPeriod, getStopper, getTimeUnit, initialChore, isInitialChoreComplete, isScheduled, run, toString, triggerNow

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - MASTER_HFILE_CLEANER_PLUGINS
```
public static final String MASTER_HFILE_CLEANER_PLUGINS
```
    See Also:
    Constant Field Values
- Constructor Detail
  - HFileCleaner
```
public HFileCleaner(int period,
            Stoppable stopper,
            org.apache.hadoop.conf.Configuration conf,
            org.apache.hadoop.fs.FileSystem fs,
            org.apache.hadoop.fs.Path directory)
```
  - HFileCleaner
```
public HFileCleaner(int period,
            Stoppable stopper,
            org.apache.hadoop.conf.Configuration conf,
            org.apache.hadoop.fs.FileSystem fs,
            org.apache.hadoop.fs.Path directory,
            Map<String,Object> params)
```
    Parameters:
    period - the period of time to sleep between each run
    stopper - the stopper
    conf - configuration to use
    fs - handle to the FS
    directory - directory to be cleaned
    params - params could be used in subclass of BaseHFileCleanerDelegate
- Method Detail
  - validate
```
protected boolean validate(org.apache.hadoop.fs.Path file)
```
    Description copied from class: CleanerChore
    
    Validate the file to see if it even belongs in the directory. If it is valid, then the file will go through the cleaner delegates, but otherwise the file is just deleted.
    
    Specified by:
    
    validate in class CleanerChore<BaseHFileCleanerDelegate>
    
    Parameters:
    file - full Path of the file to be checked
    
    Returns:
    true if the file is valid, false otherwise
  - getDelegatesForTesting
```
public List<BaseHFileCleanerDelegate> getDelegatesForTesting()
```
    Exposed for TESTING!

Class HFileCleaner

Field Summary

Fields inherited from class org.apache.hadoop.hbase.master.cleaner.CleanerChore

Constructor Summary

Method Summary

Methods inherited from class org.apache.hadoop.hbase.master.cleaner.CleanerChore

Methods inherited from class org.apache.hadoop.hbase.ScheduledChore

Methods inherited from class java.lang.Object

Field Detail

MASTER_HFILE_CLEANER_PLUGINS

Constructor Detail

HFileCleaner

HFileCleaner

Method Detail

validate

getDelegatesForTesting