org.apache.hadoop.hbase.master.cleaner

Class CleanerChore<T extends FileCleanerDelegate>

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:

java.lang.Runnable

Direct Known Subclasses:

HFileCleaner, LogCleaner

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
protected java.util.List<T>	cleanersChain
protected FileSystem	fs

Constructor Summary

Constructors

Constructor and Description
CleanerChore(java.lang.String name, int sleepPeriod, Stoppable s, Configuration conf, FileSystem fs, Path oldFileDir, java.lang.String confKey)

Method Summary

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(java.lang.Iterable<FileStatus> filesToDelete) Delete the given files
protected abstract boolean	validate(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

fs

protected final FileSystem fs

cleanersChain

protected java.util.List<T extends FileCleanerDelegate> cleanersChain

Constructor Detail

CleanerChore

public CleanerChore(java.lang.String name,
                    int sleepPeriod,
                    Stoppable s,
                    Configuration conf,
                    FileSystem fs,
                    Path oldFileDir,
                    java.lang.String confKey)

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

Method Detail

validate

protected abstract boolean validate(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

deleteFiles

protected int deleteFiles(java.lang.Iterable<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