org.apache.hadoop.fs.shell

Class WowMoveCommands.Rename

java.lang.Object

org.apache.hadoop.conf.Configured

org.apache.hadoop.fs.shell.Command

org.apache.hadoop.fs.shell.WowFsCommand

org.apache.hadoop.fs.shell.WowMoveCommands.Rename

All Implemented Interfaces:

org.apache.hadoop.conf.Configurable

Enclosing class:

WowMoveCommands

public static class WowMoveCommands.Rename
extends WowFsCommand

move/rename paths on the same fileystem

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	WowCommandWithDestination.FileAttribute

Field Summary

Fields

Modifier and Type	Field and Description
static String	DESCRIPTION
protected org.apache.hadoop.fs.shell.PathData	dst
static String	NAME
static String	USAGE

Fields inherited from class org.apache.hadoop.fs.shell.WowFsCommand

basePath

Fields inherited from class org.apache.hadoop.fs.shell.Command

args, err, exceptions, exitCode, name, numErrors, out, recursive

Constructor Summary

Constructors

Constructor and Description
Rename(org.apache.hadoop.conf.Configuration conf, String basePath, PrintStream out, PrintStream error)

Method Summary

Modifier and Type	Method and Description
protected void	copyFileToTarget(org.apache.hadoop.fs.shell.PathData src, org.apache.hadoop.fs.shell.PathData target) Copies the source file to the target.
protected void	copyStreamToTarget(InputStream in, org.apache.hadoop.fs.shell.PathData target) Copies the stream contents to a temporary file.
protected void	getLocalDestination(LinkedList<String> args) The last arg is expected to be a local path, if only one argument is given then the destination will be the current directory
protected void	getRemoteDestination(LinkedList<String> args) The last arg is expected to be a remote path, if only one argument is given then the destination will be the remote user's directory
protected org.apache.hadoop.fs.shell.PathData	getTargetPath(org.apache.hadoop.fs.shell.PathData src)
protected void	preserve(WowCommandWithDestination.FileAttribute fileAttribute) Add file attributes that need to be preserved.
protected void	preserveAttributes(org.apache.hadoop.fs.shell.PathData src, org.apache.hadoop.fs.shell.PathData target, boolean preserveRawXAttrs) Preserve the attributes of the source to the target.
protected void	processArguments(LinkedList<org.apache.hadoop.fs.shell.PathData> args)
protected void	processOptions(LinkedList<String> args)
protected void	processPath(org.apache.hadoop.fs.shell.PathData src)
protected void	processPath(org.apache.hadoop.fs.shell.PathData src, org.apache.hadoop.fs.shell.PathData target) Called with a source and target destination pair
protected void	processPathArgument(org.apache.hadoop.fs.shell.PathData src)
protected void	recursePath(org.apache.hadoop.fs.shell.PathData src)
protected void	setLazyPersist(boolean flag)
protected void	setOverwrite(boolean flag) This method is used to enable the force(-f) option while copying the files.
protected void	setPreserve(boolean preserve) If true, the last modified time, last access time, owner, group and permission information of the source file will be preserved as far as target FileSystem implementation allows.
protected void	setVerifyChecksum(boolean flag)
protected void	setWriteChecksum(boolean flag)

Methods inherited from class org.apache.hadoop.fs.shell.WowFsCommand

cleanPath, getCommandName, redefineBaseDir, registerCommands, run, runAll

Methods inherited from class org.apache.hadoop.fs.shell.Command

displayError, displayError, displayWarning, exitCodeForError, expandArgument, expandArguments, getDepth, getDescription, getName, getReplacementCommand, getUsage, isDeprecated, isRecursive, postProcessPath, processArgument, processNonexistentPath, processPaths, processRawArguments, run, setName, setRecursive

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

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

USAGE

public static final String USAGE

See Also:

Constant Field Values

DESCRIPTION

public static final String DESCRIPTION

See Also:

Constant Field Values

dst

protected org.apache.hadoop.fs.shell.PathData dst

Constructor Detail

Rename

public Rename(org.apache.hadoop.conf.Configuration conf,
              String basePath,
              PrintStream out,
              PrintStream error)

Method Detail

processOptions

protected void processOptions(LinkedList<String> args)
                       throws IOException

Overrides:

processOptions in class org.apache.hadoop.fs.shell.Command

Throws:

IOException

processPath

protected void processPath(org.apache.hadoop.fs.shell.PathData src,
                           org.apache.hadoop.fs.shell.PathData target)
                    throws IOException

Called with a source and target destination pair

Parameters:

src - for the operation

target - for the operation

Throws:

IOException - if anything goes wrong

setOverwrite

protected void setOverwrite(boolean flag)

This method is used to enable the force(-f) option while copying the files.

Parameters:

flag - true/false

setLazyPersist

protected void setLazyPersist(boolean flag)

setVerifyChecksum

protected void setVerifyChecksum(boolean flag)

setWriteChecksum

protected void setWriteChecksum(boolean flag)

setPreserve

protected void setPreserve(boolean preserve)

If true, the last modified time, last access time, owner, group and permission information of the source file will be preserved as far as target FileSystem implementation allows.

preserve

protected void preserve(WowCommandWithDestination.FileAttribute fileAttribute)

Add file attributes that need to be preserved. This method may be called multiple times to add attributes.

Parameters:

fileAttribute - - Attribute to add, one at a time

getLocalDestination

protected void getLocalDestination(LinkedList<String> args)
                            throws IOException

The last arg is expected to be a local path, if only one argument is given then the destination will be the current directory

Parameters:

args - is the list of arguments

Throws:

IOException

getRemoteDestination

protected void getRemoteDestination(LinkedList<String> args)
                             throws IOException

The last arg is expected to be a remote path, if only one argument is given then the destination will be the remote user's directory

Parameters:

args - is the list of arguments

Throws:

org.apache.hadoop.fs.PathIOException - if path doesn't exist or matches too many times

IOException

processArguments

protected void processArguments(LinkedList<org.apache.hadoop.fs.shell.PathData> args)
                         throws IOException

Overrides:

processArguments in class org.apache.hadoop.fs.shell.Command

Throws:

IOException

processPathArgument

protected void processPathArgument(org.apache.hadoop.fs.shell.PathData src)
                            throws IOException

Overrides:

processPathArgument in class org.apache.hadoop.fs.shell.Command

Throws:

IOException

processPath

protected void processPath(org.apache.hadoop.fs.shell.PathData src)
                    throws IOException

Overrides:

processPath in class org.apache.hadoop.fs.shell.Command

Throws:

IOException

recursePath

protected void recursePath(org.apache.hadoop.fs.shell.PathData src)
                    throws IOException

Overrides:

recursePath in class org.apache.hadoop.fs.shell.Command

Throws:

IOException

getTargetPath

protected org.apache.hadoop.fs.shell.PathData getTargetPath(org.apache.hadoop.fs.shell.PathData src)
                                                     throws IOException

Throws:

IOException

copyFileToTarget

protected void copyFileToTarget(org.apache.hadoop.fs.shell.PathData src,
                                org.apache.hadoop.fs.shell.PathData target)
                         throws IOException

Copies the source file to the target.

Parameters:

src - item to copy

target - where to copy the item

Throws:

IOException - if copy fails

copyStreamToTarget

protected void copyStreamToTarget(InputStream in,
                                  org.apache.hadoop.fs.shell.PathData target)
                           throws IOException

Copies the stream contents to a temporary file. If the copy is successful, the temporary file will be renamed to the real path, else the temporary file will be deleted.

Parameters:

in - the input stream for the copy

target - where to store the contents of the stream

Throws:

IOException - if copy fails

preserveAttributes

protected void preserveAttributes(org.apache.hadoop.fs.shell.PathData src,
                                  org.apache.hadoop.fs.shell.PathData target,
                                  boolean preserveRawXAttrs)
                           throws IOException

Preserve the attributes of the source to the target. The method calls shouldPreserve(FileAttribute) to check what attribute to preserve.

Parameters:

src - source to preserve

target - where to preserve attributes

preserveRawXAttrs - true if raw.* xattrs should be preserved

Throws:

IOException - if fails to preserve attributes