alluxio.cli.fs

Class FileSystemShellUtils

java.lang.Object

alluxio.cli.fs.FileSystemShellUtils

@ThreadSafe
public final class FileSystemShellUtils
extends Object

Class for convenience methods used by FileSystemShell.

Method Summary

Modifier and Type	Method and Description
static List<AlluxioURI>	getAlluxioURIs(FileSystem alluxioClient, AlluxioURI inputURI) Gets all the AlluxioURIs that match inputURI.
static String	getFilePath(String path) Removes Constants.HEADER / Constants.HEADER_FT and hostname:port information from a path, leaving only the local file path.
static List<File>	getFiles(String inputPath) Gets the files (on the local filesystem) that match the given input path.
static long	getMs(String time) Converts the input time into millisecond unit.
static Map<String,Command>	loadCommands(FileSystem fileSystem) Gets all Command instances in the same package as FileSystemShell and load them into a map.
static boolean	match(String filePath, String patternPath) Returns whether or not filePath matches patternPath.
static String	validatePath(String path) Validates the path, verifying that it contains the Constants.HEADER or Constants.HEADER_FT and a hostname:port specified.

Methods inherited from class java.lang.Object

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

Method Detail

getFilePath

public static String getFilePath(String path)
                          throws IOException

Removes Constants.HEADER / Constants.HEADER_FT and hostname:port information from a path, leaving only the local file path.

Parameters:

path - the path to obtain the local path from

Returns:

the local path in string format

Throws:

IOException

validatePath

public static String validatePath(String path)
                           throws IOException

Validates the path, verifying that it contains the Constants.HEADER or Constants.HEADER_FT and a hostname:port specified.

Parameters:

path - the path to be verified

Returns:

the verified path in a form like alluxio://host:port/dir. If only the "/dir" or "dir" part is provided, the host and port are retrieved from property, alluxio.master.hostname and alluxio.master.port, respectively.

Throws:

IOException

getAlluxioURIs

public static List<AlluxioURI> getAlluxioURIs(FileSystem alluxioClient,
                                              AlluxioURI inputURI)
                                       throws IOException

Gets all the AlluxioURIs that match inputURI. If the path is a regular path, the returned list only contains the corresponding URI; Else if the path contains wildcards, the returned list contains all the matched URIs It supports any number of wildcards in inputURI

Parameters:

alluxioClient - the client used to fetch information of Alluxio files

inputURI - the input URI (could contain wildcards)

Returns:

a list of AlluxioURIs that matches the inputURI

Throws:

IOException

getFiles

public static List<File> getFiles(String inputPath)

Gets the files (on the local filesystem) that match the given input path. If the path is a regular path, the returned list only contains the corresponding file; Else if the path contains wildcards, the returned list contains all the matched Files.

Parameters:

inputPath - The input file path (could contain wildcards)

Returns:

a list of files that matches inputPath

loadCommands

public static Map<String,Command> loadCommands(FileSystem fileSystem)

Gets all Command instances in the same package as FileSystemShell and load them into a map. Provides a way to gain these commands information by their CommandName.

Parameters:

fileSystem - the FileSystem instance to construct the command

Returns:

a mapping from command name to command instance

getMs

public static long getMs(String time)

Converts the input time into millisecond unit.

Parameters:

time - the time to be converted into milliseconds

Returns:

the time in millisecond unit

match

public static boolean match(String filePath,
                            String patternPath)

Returns whether or not filePath matches patternPath.

Parameters:

filePath - path of a given file

patternPath - path that can contain wildcards

Returns:

true if matches; false if not