alluxio.cli.fs.command

Class ConsistentHashCommand

java.lang.Object

alluxio.cli.fs.command.AbstractFileSystemCommand

alluxio.cli.fs.command.ConsistentHashCommand

All Implemented Interfaces:

Command, Closeable, AutoCloseable

@ThreadSafe
 @PublicApi
public final class ConsistentHashCommand
extends AbstractFileSystemCommand

Copies the specified file specified by "source path" to the path specified by "remote path". This command will fail if "remote path" already exists.

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.commons.cli.Option	CLEAN_CHECK_DATA
static org.apache.commons.cli.Option	COMPARE_CHECK_FILES
static org.apache.commons.cli.Option	CREATE_CHECK_FILE

Fields inherited from class alluxio.cli.fs.command.AbstractFileSystemCommand

mFileSystem, mFsContext

Constructor Summary

Constructors

Constructor and Description
ConsistentHashCommand(FileSystemContext fsContext)

Method Summary

Modifier and Type	Method and Description
void	cleanCheckData() Clean all the check data.
void	close() Used to close resources created by commands.
void	createCheckFile() Create the check file.
String	getCommandName() Gets the command name as input from the shell.
String	getDescription()
org.apache.commons.cli.Options	getOptions()
String	getUsage()
int	run(org.apache.commons.cli.CommandLine cl) Runs the command.
void	validateArgs(org.apache.commons.cli.CommandLine cl) Checks if the arguments are valid or throw InvalidArgumentException.

Methods inherited from class alluxio.cli.fs.command.AbstractFileSystemCommand

processHeader, runPlainPath, runWildCardCmd

Methods inherited from class java.lang.Object

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

Methods inherited from interface alluxio.cli.Command

getSubCommands, hasSubCommand, parseAndValidateArgs

Field Detail

CREATE_CHECK_FILE

public static final org.apache.commons.cli.Option CREATE_CHECK_FILE

COMPARE_CHECK_FILES

public static final org.apache.commons.cli.Option COMPARE_CHECK_FILES

CLEAN_CHECK_DATA

public static final org.apache.commons.cli.Option CLEAN_CHECK_DATA

Constructor Detail

ConsistentHashCommand

public ConsistentHashCommand(FileSystemContext fsContext)

Parameters:

fsContext - the filesystem of Alluxio

Method Detail

cleanCheckData

public void cleanCheckData()
                    throws IOException,
                           AlluxioException

Clean all the check data.

Throws:

IOException

AlluxioException

createCheckFile

public void createCheckFile()
                     throws IOException,
                            AlluxioException

Create the check file.

Throws:

IOException

AlluxioException

close

public void close()
           throws IOException

Description copied from interface: Command

Used to close resources created by commands.

Throws:

IOException - if closing resources fails

getCommandName

public String getCommandName()

Description copied from interface: Command

Gets the command name as input from the shell.

Returns:

the command name

getOptions

public org.apache.commons.cli.Options getOptions()

Returns:

the supported Options of the command

validateArgs

public void validateArgs(org.apache.commons.cli.CommandLine cl)
                  throws InvalidArgumentException

Description copied from interface: Command

Checks if the arguments are valid or throw InvalidArgumentException.

Parameters:

cl - the parsed command line for the arguments

Throws:

InvalidArgumentException - when arguments are not valid

run

public int run(org.apache.commons.cli.CommandLine cl)
        throws AlluxioException,
               IOException

Description copied from interface: Command

Runs the command.

Parameters:

cl - the parsed command line for the arguments

Returns:

the result of running the command

Throws:

AlluxioException

IOException

getUsage

public String getUsage()

Returns:

the usage information of the command

getDescription

public String getDescription()

Returns:

the description information of the command