TfsShell (Tachyon Shell 0.8.2 API)

java.lang.Object
- tachyon.shell.TfsShell

All Implemented Interfaces:

Closeable, AutoCloseable
```
public class TfsShell
extends Object
implements Closeable
```
Class for handling command line inputs.

Constructor Summary

Constructors
Constructor and Description

TfsShell(TachyonConf tachyonConf)

Constructors
Constructor and Description
`TfsShell(TachyonConf tachyonConf)`

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`cat(TachyonURI path)` Prints the file's contents to the console.
`void`	`close()`
`static String`	`convertMsToDate(long Millis)`
`int`	`copyFileToLocal(TachyonURI srcPath, File dstFile)` Copies a file specified by argv from the filesystem to the local filesystem.
`int`	`copyFromLocal(File srcFile, TachyonURI dstPath)` Copies a file or directory specified by srcPath from the local filesystem to dstPath in the Tachyon filesystem space.
`int`	`copyFromLocalWildcard(List<File> srcFiles, TachyonURI dstPath)` Copies a list of files or directories specified by srcFiles from the local filesystem to dstPath in the Tachyon filesystem space.
`int`	`copyWildcardToLocal(List<TachyonURI> srcPaths, File dstFile)` Copies a list of files or directories specified by srcPaths from the Tachyon filesystem to dstPath in the local filesystem.
`int`	`count(TachyonURI path)` Displays the number of folders and files matching the specified prefix in argv.
`static Comparator<TachyonURI>`	`createTachyonURIComparator()`
`int`	`du(TachyonURI path)` Displays the size of a file or a directory specified by argv.
`int`	`fileinfo(TachyonURI path)` Displays the file's all blocks info
`int`	`free(TachyonURI path)` Free the given file or folder from tachyon in-memory (recursively freeing all children if a folder)
`int`	`getCapacityBytes()` Get the capacity of the TachyonFileSystem
`int`	`getNumOfArgs(String cmd)` Return the number of arguments a command should have
`int`	`getUsedBytes()` Get number of bytes used in the TachyonFileSystem
`int`	`load(TachyonURI filePath)` Load a file or directory in Tachyon space, makes it resident in memory.
`int`	`loadMetadata(TachyonURI path)` Loads metadata for the given Tachyon path from UFS.
`int`	`location(TachyonURI path)` Displays a list of hosts that have the file specified in argv stored.
`int`	`ls(TachyonURI path)` Displays information for all directories and files directly under the path specified in argv.
`int`	`lsr(TachyonURI path)` Displays information for all directories and files under the path specified in argv recursively.
`static void`	`main(String[] argv)` Main method, starts a new TfsShell
`int`	`mkdir(TachyonURI path)` Creates a new directory specified by the path in argv, including any parent folders that are required.
`int`	`mount(String[] argv)` Mounts a UFS path onto a Tachyon path.
`int`	`pin(TachyonURI path)` Pins the given file or folder (recursively pinning all children if a folder).
`void`	`printUsage()` Method which prints the method to use all the commands.
`int`	`rename(String[] argv)` Renames a file or directory specified by argv.
`int`	`report(TachyonURI path)`
`int`	`rm(TachyonURI path)` Removes the file specified by argv.
`int`	`rmr(TachyonURI path)` Removes the file or directory specified by argv.
`int`	`run(String[] argv)` Method which determines how to handle the user's request, will display usage help to the user if command format is incorrect.
`int`	`tail(TachyonURI path)` Prints the file's last 1KB of contents to the console.
`int`	`touch(TachyonURI path)` Creates a 0 byte file specified by argv.
`int`	`unmount(TachyonURI path)` Unmounts a Tachyon path.
`int`	`unpin(TachyonURI path)` Unpins the given file or folder (recursively unpinning all children if a folder).

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TfsShell
```
public TfsShell(TachyonConf tachyonConf)
```
- Method Detail
  - main
```
public static void main(String[] argv)
                 throws IOException
```
    Main method, starts a new TfsShell
    
    Parameters:
    argv - [] Array of arguments given by the user's input from the terminal
    
    Throws:
    
    IOException
  - close
```
public void close()
           throws IOException
```
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Throws:
    
    IOException
  - cat
```
public int cat(TachyonURI path)
        throws IOException
```
    Prints the file's contents to the console.
    
    Parameters:
    path - The TachyonURI path as the input of the command
    
    Returns:
    0 if command is successful, -1 if an error occurred
    
    Throws:
    
    IOException
  - load
```
public int load(TachyonURI filePath)
         throws IOException
```
    Load a file or directory in Tachyon space, makes it resident in memory.
    
    Parameters:
    filePath - The TachyonURI path to load into Tachyon memory
    
    Returns:
    0 if command is successful, -1 if an error occurred
    
    Throws:
    
    IOException
  - copyFromLocalWildcard
```
public int copyFromLocalWildcard(List<File> srcFiles,
                        TachyonURI dstPath)
                          throws IOException
```
    Copies a list of files or directories specified by srcFiles from the local filesystem to dstPath in the Tachyon filesystem space. This method is used when the input path contains wildcards.
    
    Parameters:
    srcFiles - The list of files in the local filesystem
    dstPath - The TachyonURI of the destination
    
    Returns:
    0 if command is successful, -1 if an error occurred
    
    Throws:
    
    IOException
  - copyFromLocal
```
public int copyFromLocal(File srcFile,
                TachyonURI dstPath)
                  throws IOException
```
    Copies a file or directory specified by srcPath from the local filesystem to dstPath in the Tachyon filesystem space. Will fail if the path given already exists in the filesystem.
    
    Parameters:
    srcFile - The source file in the local filesystem
    dstPath - The TachyonURI of the destination
    
    Returns:
    0 if command is successful, -1 if an error occurred
    
    Throws:
    
    IOException
  - copyWildcardToLocal
```
public int copyWildcardToLocal(List<TachyonURI> srcPaths,
                      File dstFile)
                        throws IOException
```
    Copies a list of files or directories specified by srcPaths from the Tachyon filesystem to dstPath in the local filesystem. This method is used when the input path contains wildcards.
    
    Parameters:
    srcPaths - The list of files in the Tachyon filesystem
    dstFile - The destination directory in the local filesystem
    
    Returns:
    0 if command is successful, -1 if an error occurred
    
    Throws:
    
    IOException
  - copyFileToLocal
```
public int copyFileToLocal(TachyonURI srcPath,
                  File dstFile)
                    throws IOException
```
    Copies a file specified by argv from the filesystem to the local filesystem. This is the utility function.
    
    Parameters:
    srcPath - The source TachyonURI (has to be a file)
    dstFile - The destination file in the local filesystem
    
    Returns:
    0 if command is successful, -1 if an error occurred
    
    Throws:
    
    IOException
  - count
```
public int count(TachyonURI path)
          throws IOException
```
    Displays the number of folders and files matching the specified prefix in argv.
    
    Parameters:
    path - The TachyonURI path as the input of the command
    
    Returns:
    0 if command is successful, -1 if an error occurred
    
    Throws:
    
    IOException
  - fileinfo
```
public int fileinfo(TachyonURI path)
             throws IOException
```
    Displays the file's all blocks info
    
    Parameters:
    path - The TachyonURI path as the input of the command
    
    Returns:
    0 if command is successful, -1 if an error occurred
    
    Throws:
    
    IOException
  - location
```
public int location(TachyonURI path)
             throws IOException
```
    Displays a list of hosts that have the file specified in argv stored.
    
    Parameters:
    path - The TachyonURI path as the input of the command
    
    Returns:
    0 if command is successful, -1 if an error occurred
    
    Throws:
    
    IOException
  - createTachyonURIComparator
```
public static Comparator<TachyonURI> createTachyonURIComparator()
```
  - ls
```
public int ls(TachyonURI path)
       throws IOException
```
    Displays information for all directories and files directly under the path specified in argv.
    
    Parameters:
    path - The TachyonURI path as the input of the command
    
    Returns:
    0 if command is successful, -1 if an error occurred
    
    Throws:
    
    IOException
  - convertMsToDate
```
public static String convertMsToDate(long Millis)
```
  - lsr
```
public int lsr(TachyonURI path)
        throws IOException
```
    Displays information for all directories and files under the path specified in argv recursively.
    
    Parameters:
    path - The TachyonURI path as the input of the command
    
    Returns:
    0 if command is successful, -1 if an error occurred
    
    Throws:
    
    IOException
  - mkdir
```
public int mkdir(TachyonURI path)
```
    Creates a new directory specified by the path in argv, including any parent folders that are required. This method fails if a directory or file with the same path already exists.
    
    Parameters:
    path - The TachyonURI path as the input of the command
    
    Returns:
    0 if command is successful, -1 if an error occurred
  - getUsedBytes
```
public int getUsedBytes()
```
    Get number of bytes used in the TachyonFileSystem
    
    Returns:
    0 if command is successful, -1 if an error occurred
  - getCapacityBytes
```
public int getCapacityBytes()
```
    Get the capacity of the TachyonFileSystem
    
    Returns:
    0 if command is successful, -1 if an error occurred
  - pin
```
public int pin(TachyonURI path)
```
    Pins the given file or folder (recursively pinning all children if a folder). Pinned files are never evicted from memory.
    
    Parameters:
    path - The TachyonURI path as the input of the command
    
    Returns:
    0 if command is successful, -1 if an error occurred
  - printUsage
```
public void printUsage()
```
    Method which prints the method to use all the commands.
  - getNumOfArgs
```
public int getNumOfArgs(String cmd)
```
    Return the number of arguments a command should have
    
    Parameters:
    cmd - The command
    
    Returns:
    The number of argument of the input command
  - mount
```
public int mount(String[] argv)
          throws IOException
```
    Mounts a UFS path onto a Tachyon path.
    
    Parameters:
    argv - Aaray of arguments given by the user's input from the terminal
    
    Returns:
    0 if command is successful, -1 if an error occurred
    
    Throws:
    
    IOException - if an I/O error occurs
  - unmount
```
public int unmount(TachyonURI path)
            throws IOException
```
    Unmounts a Tachyon path.
    
    Parameters:
    path - the TachyonURI path as the input of the command
    
    Returns:
    0 if command is successful, -1 if an error occurred
    
    Throws:
    
    IOException - if an I/O error occurs
  - loadMetadata
```
public int loadMetadata(TachyonURI path)
                 throws IOException
```
    Loads metadata for the given Tachyon path from UFS.
    
    Parameters:
    path - the TachyonURI path as the input of the command
    
    Returns:
    0 if command is successful, -1 if an error occurred
    
    Throws:
    
    IOException - if an I/O error occurs
  - rename
```
public int rename(String[] argv)
           throws IOException
```
    Renames a file or directory specified by argv. Will fail if the new path name already exists.
    
    Parameters:
    argv - [] Array of arguments given by the user's input from the terminal
    
    Returns:
    0 if command is successful, -1 if an error occurred
    
    Throws:
    
    IOException
  - report
```
public int report(TachyonURI path)
           throws IOException
```
    Throws:
    
    IOException
  - rm
```
public int rm(TachyonURI path)
       throws IOException
```
    Removes the file specified by argv.
    
    Parameters:
    path - The TachyonURI path as the input of the command
    
    Returns:
    0 if command is successful, -1 if an error occurred
    
    Throws:
    
    IOException
  - rmr
```
public int rmr(TachyonURI path)
```
    Removes the file or directory specified by argv. Will remove all files and directories in the directory if a directory is specified.
    
    Parameters:
    path - The TachyonURI path as the input of the command
    
    Returns:
    0 if command is successful, -1 if an error occurred
  - du
```
public int du(TachyonURI path)
       throws IOException
```
    Displays the size of a file or a directory specified by argv.
    
    Parameters:
    path - The TachyonURI path as the input of the command
    
    Returns:
    0 if command is successful, -1 if an error occurred
    
    Throws:
    
    IOException
  - run
```
public int run(String[] argv)
```
    Method which determines how to handle the user's request, will display usage help to the user if command format is incorrect.
    
    Parameters:
    argv - [] Array of arguments given by the user's input from the terminal
    
    Returns:
    0 if command is successful, -1 if an error occurred
  - tail
```
public int tail(TachyonURI path)
         throws IOException
```
    Prints the file's last 1KB of contents to the console.
    
    Parameters:
    path - The TachyonURI path as the input of the command
    
    Returns:
    0 if command is successful, -1 if an error occurred.f
    
    Throws:
    
    IOException
  - touch
```
public int touch(TachyonURI path)
          throws IOException
```
    Creates a 0 byte file specified by argv. The file will be written to UnderFileSystem.
    
    Parameters:
    path - The TachyonURI path as the input of the command
    
    Returns:
    0 if command if successful, -1 if an error occurred
    
    Throws:
    
    IOException
  - unpin
```
public int unpin(TachyonURI path)
          throws IOException
```
    Unpins the given file or folder (recursively unpinning all children if a folder). Pinned files are never evicted from memory, so this method will allow such files to be evicted.
    
    Parameters:
    path - The TachyonURI path as the input of the command
    
    Returns:
    0 if command is successful, -1 if an error occurred
    
    Throws:
    
    IOException
  - free
```
public int free(TachyonURI path)
         throws IOException
```
    Free the given file or folder from tachyon in-memory (recursively freeing all children if a folder)
    
    Parameters:
    path - The TachyonURI path as the input of the command
    
    Returns:
    0 if command if successful, -1 if an error occurred
    
    Throws:
    
    IOException

Class TfsShell

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TfsShell

Method Detail

main

close

cat

load

copyFromLocalWildcard

copyFromLocal

copyWildcardToLocal

copyFileToLocal

count

fileinfo

location

createTachyonURIComparator

ls

convertMsToDate

lsr

mkdir

getUsedBytes

getCapacityBytes

pin

printUsage

getNumOfArgs

mount

unmount

loadMetadata

rename

report

rm

rmr

du

run

tail

touch

unpin

free