SnapshotLogCleaner (Apache HBase 1.2.12 API)

java.lang.Object
- org.apache.hadoop.hbase.BaseConfigurable
- - org.apache.hadoop.hbase.master.cleaner.BaseFileCleanerDelegate
  - - org.apache.hadoop.hbase.master.cleaner.BaseLogCleanerDelegate
    - - org.apache.hadoop.hbase.master.snapshot.SnapshotLogCleaner

All Implemented Interfaces:

org.apache.hadoop.conf.Configurable, FileCleanerDelegate, Stoppable
```
@InterfaceAudience.LimitedPrivate(value="Configuration")
@InterfaceStability.Evolving
public class SnapshotLogCleaner
extends BaseLogCleanerDelegate
```
Implementation of a log cleaner that checks if a log is still used by snapshots of HBase tables.

Field Summary

Fields
Modifier and Type	Field and Description
`private SnapshotFileCache`	`cache`
`private static long`	`DEFAULT_WAL_CACHE_REFRESH_PERIOD` Refresh cache, by default, every 5 minutes
`private static org.apache.commons.logging.Log`	`LOG`
`private HMaster`	`master`
`(package private) static String`	`WAL_CACHE_REFRESH_PERIOD_CONF_KEY` Conf key for the frequency to attempt to refresh the cache of hfiles currently used in snapshots (ms)

Constructor Summary

Constructors
Constructor and Description

SnapshotLogCleaner()

Constructors
Constructor and Description
`SnapshotLogCleaner()`

Method Summary

Methods
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
`void`	`init(Map<String,Object> params)` this method is used to pass some instance into subclass
`boolean`	`isStopped()`
`void`	`setConf(org.apache.hadoop.conf.Configuration conf)` This method should only be called once, as it starts a thread to keep the cache up-to-date.
`void`	`stop(String why)` Stop this service.

Methods inherited from class org.apache.hadoop.hbase.master.cleaner.BaseLogCleanerDelegate
isFileDeletable, isLogDeletable

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

- Field Detail
  - LOG
```
private static final org.apache.commons.logging.Log LOG
```
  - WAL_CACHE_REFRESH_PERIOD_CONF_KEY
```
static final String WAL_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_WAL_CACHE_REFRESH_PERIOD
```
private static final long DEFAULT_WAL_CACHE_REFRESH_PERIOD
```
    Refresh cache, by default, every 5 minutes
    
    See Also:
    Constant Field Values
  - cache
```
private SnapshotFileCache cache
```
  - master
```
private HMaster master
```
- Constructor Detail
  - SnapshotLogCleaner
```
public SnapshotLogCleaner()
```
- 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
  - setConf
```
public void setConf(org.apache.hadoop.conf.Configuration conf)
```
    This method should only be called once, as it starts a thread to keep the cache up-to-date.
    
    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.
    
    Parameters:
    why - Why we're stopping.
  - isStopped
```
public boolean isStopped()
```
    Returns:
    True if Stoppable.stop(String) has been closed.

Class SnapshotLogCleaner

Field Summary

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

Field Detail

LOG

WAL_CACHE_REFRESH_PERIOD_CONF_KEY

DEFAULT_WAL_CACHE_REFRESH_PERIOD

cache

master

Constructor Detail

SnapshotLogCleaner

Method Detail

getDeletableFiles

init

setConf

stop

isStopped