org.apache.hadoop.hbase.master.snapshot

Class SnapshotHFileCleaner

java.lang.Object

org.apache.hadoop.hbase.BaseConfigurable

org.apache.hadoop.hbase.master.cleaner.BaseFileCleanerDelegate

org.apache.hadoop.hbase.master.cleaner.BaseHFileCleanerDelegate

org.apache.hadoop.hbase.master.snapshot.SnapshotHFileCleaner

All Implemented Interfaces:

org.apache.hadoop.conf.Configurable, FileCleanerDelegate, Stoppable

@InterfaceAudience.LimitedPrivate(value="Configuration")
 @InterfaceStability.Evolving
public class SnapshotHFileCleaner
extends BaseHFileCleanerDelegate

Implementation of a file cleaner that checks if a hfile is still used by snapshots of HBase tables.

Field Summary

Fields

Modifier and Type	Field and Description
private SnapshotFileCache	cache File cache for HFiles in the completed and currently running snapshots
private static long	DEFAULT_HFILE_CACHE_REFRESH_PERIOD Refresh cache, by default, every 5 minutes
static String	HFILE_CACHE_REFRESH_PERIOD_CONF_KEY Conf key for the frequency to attempt to refresh the cache of hfiles currently used in snapshots (ms)
private static org.slf4j.Logger	LOG
private MasterServices	master

Constructor Summary

Constructors

Constructor and Description
SnapshotHFileCleaner()

Method Summary

Modifier and Type	Method and Description
Iterable<org.apache.hadoop.fs.FileStatus>	getDeletableFiles(Iterable<org.apache.hadoop.fs.FileStatus> files) Determines which of the given files are safe to delete
SnapshotFileCache	getFileCacheForTesting() Exposed for Testing!
void	init(Map<String,Object> params) this method is used to pass some instance into subclass
protected boolean	isFileDeletable(org.apache.hadoop.fs.FileStatus fStat) Should the master delete the file or keep it?
boolean	isStopped()
void	setConf(org.apache.hadoop.conf.Configuration conf)
void	stop(String why) Stop this service.

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

getConf

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.hadoop.hbase.master.cleaner.FileCleanerDelegate

isEmptyDirDeletable, preClean

Methods inherited from interface org.apache.hadoop.conf.Configurable

getConf

Field Detail

LOG

private static final org.slf4j.Logger LOG

HFILE_CACHE_REFRESH_PERIOD_CONF_KEY

public static final String HFILE_CACHE_REFRESH_PERIOD_CONF_KEY

Conf key for the frequency to attempt to refresh the cache of hfiles currently used in snapshots (ms)

See Also:

Constant Field Values

DEFAULT_HFILE_CACHE_REFRESH_PERIOD

private static final long DEFAULT_HFILE_CACHE_REFRESH_PERIOD

Refresh cache, by default, every 5 minutes

See Also:

Constant Field Values

cache

private SnapshotFileCache cache

File cache for HFiles in the completed and currently running snapshots

master

private MasterServices master

Constructor Detail

SnapshotHFileCleaner

public SnapshotHFileCleaner()

Method Detail

getDeletableFiles

public Iterable<org.apache.hadoop.fs.FileStatus> getDeletableFiles(Iterable<org.apache.hadoop.fs.FileStatus> files)

Description copied from interface: FileCleanerDelegate

Determines which of the given files are safe to delete

Specified by:

getDeletableFiles in interface FileCleanerDelegate

Overrides:

getDeletableFiles in class BaseFileCleanerDelegate

Parameters:

files - files to check for deletion

Returns:

files that are ok to delete according to this cleaner

init

public void init(Map<String,Object> params)

Description copied from interface: FileCleanerDelegate

this method is used to pass some instance into subclass

Specified by:

init in interface FileCleanerDelegate

Overrides:

init in class BaseFileCleanerDelegate

isFileDeletable

protected boolean isFileDeletable(org.apache.hadoop.fs.FileStatus fStat)

Description copied from class: BaseFileCleanerDelegate

Should the master delete the file or keep it?

Specified by:

isFileDeletable in class BaseFileCleanerDelegate

Parameters:

fStat - file status of the file to check

Returns:

true if the file is deletable, false if not

setConf

public void setConf(org.apache.hadoop.conf.Configuration conf)

Specified by:

setConf in interface org.apache.hadoop.conf.Configurable

Overrides:

setConf in class BaseConfigurable

stop

public void stop(String why)

Description copied from interface: Stoppable

Stop this service. Implementers should favor logging errors over throwing RuntimeExceptions.

Specified by:

stop in interface Stoppable

Overrides:

stop in class BaseHFileCleanerDelegate

Parameters:

why - Why we're stopping.

isStopped

public boolean isStopped()

Specified by:

isStopped in interface Stoppable

Overrides:

isStopped in class BaseHFileCleanerDelegate

Returns:

True if Stoppable.stop(String) has been closed.

getFileCacheForTesting

public SnapshotFileCache getFileCacheForTesting()

Exposed for Testing!

Returns:

the cache of all hfiles