CleanerChore (Apache HBase 1.4.11 API)

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

Type Parameters:
T - Cleaner delegate class that is dynamically loaded from configuration

All Implemented Interfaces:

Runnable

Direct Known Subclasses:

HFileCleaner, LogCleaner
```
@InterfaceAudience.Private
public abstract class CleanerChore<T extends FileCleanerDelegate>
extends ScheduledChore
```
Abstract Cleaner that uses a chain of delegates to clean a directory of files

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CHORE_POOL_SIZE` If it is an integer and >= 1, it would be the size; if 0.0 < size <= 1.0, size would be available processors * size.
`protected List<T>`	`cleanersChain`
`protected org.apache.hadoop.fs.FileSystem`	`fs`
`protected Map<String,Object>`	`params`

Constructor Summary

Constructors
Constructor and Description
`CleanerChore(String name, int sleepPeriod, Stoppable s, org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.fs.Path oldFileDir, String confKey, DirScanPool pool)`
`CleanerChore(String name, int sleepPeriod, Stoppable s, org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.fs.Path oldFileDir, String confKey, DirScanPool pool, Map<String,Object> params)`

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`chore()` The task to execute on each scheduled execution of the Chore
`void`	`cleanup()` Override to run cleanup tasks when the Chore encounters an error and must stop running
`protected int`	`deleteFiles(Iterable<org.apache.hadoop.fs.FileStatus> filesToDelete)` Delete the given files
`boolean`	`getEnabled()`
`boolean`	`runCleaner()`
`boolean`	`setEnabled(boolean enabled)`
`protected abstract 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.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
  - CHORE_POOL_SIZE
```
public static final String CHORE_POOL_SIZE
```
    If it is an integer and >= 1, it would be the size; if 0.0 < size <= 1.0, size would be available processors * size. Pay attention that 1.0 is different from 1, former indicates it will use 100% of cores, while latter will use only 1 thread for chore to scan dir.
    
    See Also:
    Constant Field Values
  - fs
```
protected final org.apache.hadoop.fs.FileSystem fs
```
  - cleanersChain
```
protected List<T extends FileCleanerDelegate> cleanersChain
```
  - params
```
protected Map<String,Object> params
```
- Constructor Detail
  - CleanerChore
```
public CleanerChore(String name,
            int sleepPeriod,
            Stoppable s,
            org.apache.hadoop.conf.Configuration conf,
            org.apache.hadoop.fs.FileSystem fs,
            org.apache.hadoop.fs.Path oldFileDir,
            String confKey,
            DirScanPool pool)
```
  - CleanerChore
```
public CleanerChore(String name,
            int sleepPeriod,
            Stoppable s,
            org.apache.hadoop.conf.Configuration conf,
            org.apache.hadoop.fs.FileSystem fs,
            org.apache.hadoop.fs.Path oldFileDir,
            String confKey,
            DirScanPool pool,
            Map<String,Object> params)
```
    Parameters:
    name - name of the chore being run
    sleepPeriod - the period of time to sleep between each run
    s - the stopper
    conf - configuration to use
    fs - handle to the FS
    oldFileDir - the path to the archived files
    confKey - configuration key for the classes to instantiate
    pool - the thread pool used to scan directories
    params - members could be used in cleaner
- Method Detail
  - validate
```
protected abstract boolean validate(org.apache.hadoop.fs.Path file)
```
    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.
    
    Parameters:
    file - full Path of the file to be checked
    
    Returns:
    true if the file is valid, false otherwise
  - chore
```
protected void chore()
```
    Description copied from class: ScheduledChore
    
    The task to execute on each scheduled execution of the Chore
    
    Specified by:
    
    chore in class ScheduledChore
  - runCleaner
```
public boolean runCleaner()
```
  - deleteFiles
```
protected int deleteFiles(Iterable<org.apache.hadoop.fs.FileStatus> filesToDelete)
```
    Delete the given files
    
    Parameters:
    filesToDelete - files to delete
    
    Returns:
    number of deleted files
  - cleanup
```
public void cleanup()
```
    Description copied from class: ScheduledChore
    
    Override to run cleanup tasks when the Chore encounters an error and must stop running
    
    Overrides:
    
    cleanup in class ScheduledChore
  - setEnabled
```
public boolean setEnabled(boolean enabled)
```
    Parameters:
    enabled -
  - getEnabled
```
public boolean getEnabled()
```

Class CleanerChore<T extends FileCleanerDelegate>

Field Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

CHORE_POOL_SIZE

fs

cleanersChain

params

Constructor Detail

CleanerChore

CleanerChore

Method Detail

validate

chore

runCleaner

deleteFiles

cleanup

setEnabled

getEnabled