LogCleaner (Apache HBase 1.4.11 API)

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

All Implemented Interfaces:

Runnable, ConfigurationObserver
```
@InterfaceAudience.Private
public class LogCleaner
extends CleanerChore<BaseLogCleanerDelegate>
implements ConfigurationObserver
```
This Chore, every time it runs, will attempt to delete the WALs in the old logs folder. The WAL is only deleted if none of the cleaner delegates says otherwise.

See Also:
BaseLogCleanerDelegate

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_OLD_WALS_CLEANER_THREAD_SIZE`
`static String`	`OLD_WALS_CLEANER_THREAD_CHECK_INTERVAL_MSEC`
`static String`	`OLD_WALS_CLEANER_THREAD_SIZE`
`static String`	`OLD_WALS_CLEANER_THREAD_TIMEOUT_MSEC`

Fields inherited from class org.apache.hadoop.hbase.master.cleaner.CleanerChore
CHORE_POOL_SIZE, cleanersChain, fs, params

Constructor Summary

Constructors
Constructor and Description
`LogCleaner(int p, Stoppable s, org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.fs.Path oldLogDir, DirScanPool pool)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`cancel(boolean mayInterruptIfRunning)`
`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
`void`	`onConfigurationChange(org.apache.hadoop.conf.Configuration conf)` This method would be called by the `ConfigurationManager` object when the `Configuration` object is reloaded from disk.
`protected 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.master.cleaner.CleanerChore
chore, getEnabled, runCleaner, setEnabled

Methods inherited from class org.apache.hadoop.hbase.ScheduledChore
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
  - OLD_WALS_CLEANER_THREAD_SIZE
```
public static final String OLD_WALS_CLEANER_THREAD_SIZE
```
    See Also:
    Constant Field Values
  - DEFAULT_OLD_WALS_CLEANER_THREAD_SIZE
```
public static final int DEFAULT_OLD_WALS_CLEANER_THREAD_SIZE
```
    See Also:
    Constant Field Values
  - OLD_WALS_CLEANER_THREAD_TIMEOUT_MSEC
```
public static final String OLD_WALS_CLEANER_THREAD_TIMEOUT_MSEC
```
    See Also:
    Constant Field Values
  - OLD_WALS_CLEANER_THREAD_CHECK_INTERVAL_MSEC
```
public static final String OLD_WALS_CLEANER_THREAD_CHECK_INTERVAL_MSEC
```
    See Also:
    Constant Field Values
- Constructor Detail
  - LogCleaner
```
public LogCleaner(int p,
          Stoppable s,
          org.apache.hadoop.conf.Configuration conf,
          org.apache.hadoop.fs.FileSystem fs,
          org.apache.hadoop.fs.Path oldLogDir,
          DirScanPool pool)
```
    Parameters:
    p - the period of time to sleep between each run
    s - the stopper
    conf - configuration to use
    fs - handle to the FS
    oldLogDir - the path to the archived logs
- Method Detail
  - validate
```
protected boolean validate(org.apache.hadoop.fs.Path file)
```
    Description copied from class: CleanerChore
    
    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.
    
    Specified by:
    
    validate in class CleanerChore<BaseLogCleanerDelegate>
    
    Parameters:
    file - full Path of the file to be checked
    
    Returns:
    true if the file is valid, false otherwise
  - onConfigurationChange
```
public void onConfigurationChange(org.apache.hadoop.conf.Configuration conf)
```
    Description copied from interface: ConfigurationObserver
    
    This method would be called by the ConfigurationManager object when the Configuration object is reloaded from disk.
    
    Specified by:
    
    onConfigurationChange in interface ConfigurationObserver
  - deleteFiles
```
protected int deleteFiles(Iterable<org.apache.hadoop.fs.FileStatus> filesToDelete)
```
    Description copied from class: CleanerChore
    
    Delete the given files
    
    Overrides:
    
    deleteFiles in class CleanerChore<BaseLogCleanerDelegate>
    
    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 CleanerChore<BaseLogCleanerDelegate>
  - cancel
```
public void cancel(boolean mayInterruptIfRunning)
```
    Overrides:
    
    cancel in class ScheduledChore

Class LogCleaner

Field Summary

Fields inherited from class org.apache.hadoop.hbase.master.cleaner.CleanerChore

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Field Detail

OLD_WALS_CLEANER_THREAD_SIZE

DEFAULT_OLD_WALS_CLEANER_THREAD_SIZE

OLD_WALS_CLEANER_THREAD_TIMEOUT_MSEC

OLD_WALS_CLEANER_THREAD_CHECK_INTERVAL_MSEC

Constructor Detail

LogCleaner

Method Detail

validate

onConfigurationChange

deleteFiles

cleanup

cancel