org.apache.hadoop.hbase.master.cleaner

Class BaseLogCleanerDelegate

java.lang.Object

org.apache.hadoop.hbase.BaseConfigurable

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

org.apache.hadoop.hbase.master.cleaner.BaseLogCleanerDelegate

All Implemented Interfaces:

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

Direct Known Subclasses:

ReplicationLogCleaner, SnapshotLogCleaner, TimeToLiveLogCleaner

@InterfaceAudience.Private
public abstract class BaseLogCleanerDelegate
extends BaseFileCleanerDelegate

Base class for the log cleaning function inside the master. By default, two cleaners: TimeToLiveLogCleaner and ReplicationLogCleaner are called in order. So if other effects are needed, implement your own LogCleanerDelegate and add it to the configuration "hbase.master.logcleaner.plugins", which is a comma-separated list of fully qualified class names. LogsCleaner will add it to the chain.

HBase ships with LogsCleaner as the default implementation.

This interface extends Configurable, so setConf needs to be called once before using the cleaner. Since LogCleanerDelegates are created in LogsCleaner by reflection. Classes that implements this interface should provide a default constructor.

Constructor Summary

Constructors

Constructor and Description
BaseLogCleanerDelegate()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isFileDeletable(org.apache.hadoop.fs.FileStatus fStat) Should the master delete the file or keep it?
boolean	isLogDeletable(org.apache.hadoop.fs.FileStatus fStat) Deprecated.

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

getDeletableFiles

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

getConf, setConf

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.conf.Configurable

getConf, setConf

Methods inherited from interface org.apache.hadoop.hbase.Stoppable

isStopped, stop

Constructor Detail

BaseLogCleanerDelegate

public BaseLogCleanerDelegate()

Method Detail

isFileDeletable

public 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

isLogDeletable

@Deprecated
public boolean isLogDeletable(org.apache.hadoop.fs.FileStatus fStat)

Deprecated.

Should the master delete the log or keep it?

Implementing classes should override isFileDeletable(FileStatus) instead.

Parameters:

fStat - file status of the file

Returns:

true if the log is deletable, false (default) if not