org.apache.hadoop.fs

Class TrashPolicyDefault

java.lang.Object

org.apache.hadoop.conf.Configured

org.apache.hadoop.fs.TrashPolicy

org.apache.hadoop.fs.TrashPolicyDefault

All Implemented Interfaces:

Configurable

@InterfaceAudience.Private
@InterfaceStability.Evolving
public class TrashPolicyDefault
extends TrashPolicy

Provides a trash feature. Files are moved to a user's trash directory, a subdirectory of their home directory named ".Trash". Files are initially moved to a current sub-directory of the trash directory. Within that sub-directory their original path is preserved. Periodically one may checkpoint the current trash and remove older checkpoints. (This design permits trash management without enumeration of the full trash content, without date support in the filesystem, and without clock synchronization.)

Field Summary

Fields inherited from class org.apache.hadoop.fs.TrashPolicy

deletionInterval, fs, trash

Constructor Summary

Constructors

Constructor and Description
TrashPolicyDefault()

Method Summary

Methods

Modifier and Type	Method and Description
void	createCheckpoint() Create a trash checkpoint.
void	deleteCheckpoint() Delete old trash checkpoint(s).
Path	getCurrentTrashDir() Get the current working directory of the Trash Policy
Runnable	getEmptier() Return a Runnable that periodically empties the trash of all users, intended to be run by the superuser.
void	initialize(Configuration conf, FileSystem fs, Path home) Used to setup the trash policy.
boolean	isEnabled() Returns whether the Trash Policy is enabled for this filesystem
boolean	moveToTrash(Path path) Move a file or directory to the current trash directory.

Methods inherited from class org.apache.hadoop.fs.TrashPolicy

getInstance

Methods inherited from class org.apache.hadoop.conf.Configured

getConf, setConf

Methods inherited from class java.lang.Object

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

Constructor Detail

TrashPolicyDefault

public TrashPolicyDefault()

Method Detail

initialize

public void initialize(Configuration conf,
              FileSystem fs,
              Path home)

Description copied from class: TrashPolicy

Used to setup the trash policy. Must be implemented by all TrashPolicy implementations

Specified by:

initialize in class TrashPolicy

Parameters:

conf - the configuration to be used

fs - the filesystem to be used

home - the home directory

isEnabled

public boolean isEnabled()

Description copied from class: TrashPolicy

Returns whether the Trash Policy is enabled for this filesystem

Specified by:

isEnabled in class TrashPolicy

moveToTrash

public boolean moveToTrash(Path path)
                    throws IOException

Description copied from class: TrashPolicy

Move a file or directory to the current trash directory.

Specified by:

moveToTrash in class TrashPolicy

Returns:

false if the item is already in the trash or trash is disabled

Throws:

IOException

createCheckpoint

public void createCheckpoint()
                      throws IOException

Description copied from class: TrashPolicy

Create a trash checkpoint.

Specified by:

createCheckpoint in class TrashPolicy

Throws:

IOException

deleteCheckpoint

public void deleteCheckpoint()
                      throws IOException

Description copied from class: TrashPolicy

Delete old trash checkpoint(s).

Specified by:

deleteCheckpoint in class TrashPolicy

Throws:

IOException

getCurrentTrashDir

public Path getCurrentTrashDir()

Description copied from class: TrashPolicy

Get the current working directory of the Trash Policy

Specified by:

getCurrentTrashDir in class TrashPolicy

getEmptier

public Runnable getEmptier()
                    throws IOException

Description copied from class: TrashPolicy

Return a Runnable that periodically empties the trash of all users, intended to be run by the superuser.

Specified by:

getEmptier in class TrashPolicy

Throws:

IOException