alluxio.cli.fs.command

Class LsCommand

java.lang.Object

alluxio.cli.fs.command.AbstractFileSystemCommand

alluxio.cli.fs.command.LsCommand

All Implemented Interfaces:

Command, Closeable, AutoCloseable

@ThreadSafe
 @PublicApi
public final class LsCommand
extends AbstractFileSystemCommand

Displays information for the path specified in args. Depends on different options, this command can also display the information for all directly children under the path, or recursively.

Field Summary

Fields

Modifier and Type	Field and Description
static String	IN_ALLUXIO_STATE_DIR
static String	IN_ALLUXIO_STATE_FILE_FORMAT
static String	LS_FORMAT
static String	LS_FORMAT_ALLUXIO_STATE
static String	LS_FORMAT_FILE_PATH
static String	LS_FORMAT_FILE_SIZE
static String	LS_FORMAT_GROUP_NAME
static String	LS_FORMAT_NO_ACL
static String	LS_FORMAT_PERMISSION
static String	LS_FORMAT_PERSISTENCE_STATE
static String	LS_FORMAT_TIMESTAMP
static String	LS_FORMAT_USER_NAME

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

mFileSystem, mFsContext

Constructor Summary

Constructors

Constructor and Description
LsCommand(FileSystemContext fsContext) Constructs a new instance to display information for all directories and files directly under the path specified in args.

Method Summary

Modifier and Type	Method and Description
static String	formatLsString(boolean hSize, boolean acl, boolean isFolder, String permission, String userName, String groupName, long size, long timestamp, int inAlluxioPercentage, String persistenceState, String path, String dateFormatPattern) Formats the ls result string.
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.
protected void	runPlainPath(AlluxioURI path, org.apache.commons.cli.CommandLine cl) Runs the command for a particular URI that does not contain wildcard in its path.
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, 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

close, getSubCommands, hasSubCommand, parseAndValidateArgs

Field Detail

IN_ALLUXIO_STATE_DIR

public static final String IN_ALLUXIO_STATE_DIR

See Also:

Constant Field Values

IN_ALLUXIO_STATE_FILE_FORMAT

public static final String IN_ALLUXIO_STATE_FILE_FORMAT

See Also:

Constant Field Values

LS_FORMAT_PERMISSION

public static final String LS_FORMAT_PERMISSION

See Also:

Constant Field Values

LS_FORMAT_FILE_SIZE

public static final String LS_FORMAT_FILE_SIZE

See Also:

Constant Field Values

LS_FORMAT_TIMESTAMP

public static final String LS_FORMAT_TIMESTAMP

See Also:

Constant Field Values

LS_FORMAT_ALLUXIO_STATE

public static final String LS_FORMAT_ALLUXIO_STATE

See Also:

Constant Field Values

LS_FORMAT_PERSISTENCE_STATE

public static final String LS_FORMAT_PERSISTENCE_STATE

See Also:

Constant Field Values

LS_FORMAT_USER_NAME

public static final String LS_FORMAT_USER_NAME

See Also:

Constant Field Values

LS_FORMAT_GROUP_NAME

public static final String LS_FORMAT_GROUP_NAME

See Also:

Constant Field Values

LS_FORMAT_FILE_PATH

public static final String LS_FORMAT_FILE_PATH

See Also:

Constant Field Values

LS_FORMAT_NO_ACL

public static final String LS_FORMAT_NO_ACL

See Also:

Constant Field Values

LS_FORMAT

public static final String LS_FORMAT

See Also:

Constant Field Values

Constructor Detail

LsCommand

public LsCommand(FileSystemContext fsContext)

Constructs a new instance to display information for all directories and files directly under the path specified in args.

Parameters:

fsContext - the filesystem of Alluxio

Method Detail

formatLsString

public static String formatLsString(boolean hSize,
                                    boolean acl,
                                    boolean isFolder,
                                    String permission,
                                    String userName,
                                    String groupName,
                                    long size,
                                    long timestamp,
                                    int inAlluxioPercentage,
                                    String persistenceState,
                                    String path,
                                    String dateFormatPattern)

Formats the ls result string.

Parameters:

hSize - print human-readable format sizes

acl - whether security is enabled

isFolder - whether this path is a file or a folder

permission - permission string

userName - user name

groupName - group name

size - size of the file in bytes

timestamp - the epoch time in ms

inAlluxioPercentage - whether the file is in Alluxio

persistenceState - the persistence state of the file

path - path of the file or folder

dateFormatPattern - the format to follow when printing dates

Returns:

the formatted string according to acl and isFolder

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

runPlainPath

protected void runPlainPath(AlluxioURI path,
                            org.apache.commons.cli.CommandLine cl)
                     throws AlluxioException,
                            IOException

Description copied from class: AbstractFileSystemCommand

Runs the command for a particular URI that does not contain wildcard in its path.

Overrides:

runPlainPath in class AbstractFileSystemCommand

Parameters:

path - an AlluxioURI that does not contain wildcard

cl - object containing the original commandLine

Throws:

AlluxioException

IOException

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

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