org.springframework.data.hadoop.fs
Class FsShell

java.lang.Object
  extended by org.springframework.data.hadoop.fs.FsShell
All Implemented Interfaces:
Closeable, DisposableBean

public class FsShell
extends Object
implements Closeable, DisposableBean

HDFS FileSystem Shell supporting the 'hadoop fs/dfs [x]' commands as methods. See the official guide for more information.

This class mimics as much as possible the shell behavior yet it is meant to be used in a programmatic way, that is rather then printing out information, they return object or collections that one can iterate through. If the message is all that's needed then simply call the returned object Object.toString() explicitly or implicitly (by printing out or doing string concatenation).

Author:
Hadoop's FsShell authors, Costin Leau

Constructor Summary
FsShell(Configuration configuration)
          Constructs a new FsShell instance.
FsShell(Configuration configuration, FileSystem fs)
          Constructs a new FsShell instance.
 
Method Summary
 Collection<Path> cat(String... uris)
           
 Collection<Path> cat(String uri)
           
 void chgrp(boolean recursive, String group, String... uris)
           
 void chgrp(boolean recursive, String group, String uri)
           
 void chgrp(String group, String... uris)
           
 void chgrp(String group, String uri)
           
 void chgrpr(String group, String... uris)
           
 void chgrpr(String group, String uri)
           
 void chmod(boolean recursive, Integer mode, String... uris)
           
 void chmod(boolean recursive, Integer mode, String uri)
           
 void chmod(boolean recursive, String mode, String... uris)
           
 void chmod(boolean recursive, String mode, String uri)
           
 void chmod(Integer mode, String... uris)
           
 void chmod(Integer mode, String uri)
           
 void chmod(String mode, String... uris)
           
 void chmod(String mode, String uri)
           
 void chmodr(Integer mode, String... uris)
           
 void chmodr(Integer mode, String uri)
           
 void chmodr(String mode, String... uris)
           
 void chmodr(String mode, String uri)
           
 void chown(boolean recursive, String owner, String... uris)
           
 void chown(boolean recursive, String owner, String uri)
           
 void chown(String mode, String... uris)
           
 void chown(String mode, String uri)
           
 void chownr(String mode, String... uris)
           
 void chownr(String mode, String uri)
           
 void close()
           
 void copyFromLocal(String src, String dst)
           
 void copyFromLocal(String src, String src2, String... dst)
           
 void copyToLocal(boolean ignorecrc, boolean crc, String src, String localdst)
           
 void copyToLocal(String src, String localdst)
           
 Map<Path,ContentSummary> count(boolean quota, String... uris)
           
 Map<Path,ContentSummary> count(boolean quota, String uri)
           
 Map<Path,ContentSummary> count(String... uris)
           
 Map<Path,ContentSummary> count(String uri)
           
 void cp(String src, String dst)
           
 void cp(String src, String src2, String... dst)
           
 void destroy()
           
 Map<Path,Long> du(boolean summary, String... strings)
           
 Map<Path,Long> du(boolean summary, String string)
           
 Map<Path,Long> du(String... uris)
           
 Map<Path,Long> du(String uri)
           
 Map<Path,Long> dus(String... strings)
           
 Map<Path,Long> dus(String string)
           
 void expunge()
           
 void get(boolean ignorecrc, boolean crc, String src, String dst)
           
 void get(String src, String dst)
           
 void getmerge(String src, String localdst)
           
 void getmerge(String src, String localdst, boolean addnl)
           
 Collection<FileStatus> ls(boolean recursive, String... match)
           
 Collection<FileStatus> ls(boolean recursive, String match)
           
 Collection<FileStatus> ls(String... match)
           
 Collection<FileStatus> ls(String match)
           
 Collection<FileStatus> lsr(String... match)
           
 Collection<FileStatus> lsr(String match)
           
 void mkdir(String... uris)
           
 void mkdir(String uri)
           
 void moveFromLocal(String localsrc, String dst)
           
 void moveFromLocal(String localsrc, String localsrc2, String... dst)
           
 void moveToLocal(boolean crc, String src, String dst)
           
 void moveToLocal(String src, String dst)
           
 void mv(String src, String dst)
           
 void mv(String src, String src2, String... dst)
           
 void put(String localsrc, String dst)
           
 void put(String localsrc, String localsrc2, String... dst)
           
 void rm(boolean recursive, boolean skipTrash, String... uris)
           
 void rm(boolean recursive, String... uris)
           
 void rm(boolean recursive, String uri)
           
 void rm(String... uris)
           
 void rm(String uri)
           
 void rmr(boolean skipTrash, String... uris)
           
 void rmr(boolean skipTrash, String uri)
           
 void rmr(String... uris)
           
 void rmr(String uri)
           
 void setrep(boolean recursive, short replication, String... uris)
           
 void setrep(boolean recursive, short replication, String uri)
           
 void setrep(long secondsToWait, boolean recursive, short replication, String... uris)
           
 void setrep(long secondsToWait, boolean recursive, short replication, String uri)
           
 void setrep(short replication, String... uris)
           
 void setrep(short replication, String uri)
           
 void setrepr(long secondsToWait, short replication, String... uris)
           
 void setrepr(long secondsToWait, short replication, String uri)
           
 void setrepr(short replication, String... uris)
           
 void setrepr(short replication, String uri)
           
 boolean test(boolean exists, boolean zero, boolean directory, String uri)
           
 boolean test(String uri)
           
 Collection<String> text(String... uris)
           
 Collection<String> text(String uri)
           
 void touchz(String... uris)
           
 void touchz(String uri)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FsShell

public FsShell(Configuration configuration)
Constructs a new FsShell instance.

Parameters:
configuration - Hadoop configuration to use.

FsShell

public FsShell(Configuration configuration,
               FileSystem fs)
Constructs a new FsShell instance.

Parameters:
configuration - Hadoop configuration to use.
fs - Hadoop file system to use.
Method Detail

destroy

public void destroy()
             throws Exception
Specified by:
destroy in interface DisposableBean
Throws:
Exception

close

public void close()
           throws IOException
Specified by:
close in interface Closeable
Throws:
IOException

cat

public Collection<Path> cat(String uri)

cat

public Collection<Path> cat(String... uris)

chgrp

public void chgrp(String group,
                  String uri)

chgrp

public void chgrp(String group,
                  String... uris)

chgrpr

public void chgrpr(String group,
                   String uri)

chgrpr

public void chgrpr(String group,
                   String... uris)

chgrp

public void chgrp(boolean recursive,
                  String group,
                  String uri)

chgrp

public void chgrp(boolean recursive,
                  String group,
                  String... uris)

chmod

public void chmod(String mode,
                  String uri)

chmod

public void chmod(String mode,
                  String... uris)

chmodr

public void chmodr(String mode,
                   String uri)

chmodr

public void chmodr(String mode,
                   String... uris)

chmodr

public void chmodr(Integer mode,
                   String uri)

chmodr

public void chmodr(Integer mode,
                   String... uris)

chmod

public void chmod(Integer mode,
                  String uri)

chmod

public void chmod(Integer mode,
                  String... uris)

chmod

public void chmod(boolean recursive,
                  Integer mode,
                  String uri)

chmod

public void chmod(boolean recursive,
                  Integer mode,
                  String... uris)

chmod

public void chmod(boolean recursive,
                  String mode,
                  String uri)

chmod

public void chmod(boolean recursive,
                  String mode,
                  String... uris)

chown

public void chown(String mode,
                  String uri)

chown

public void chown(String mode,
                  String... uris)

chownr

public void chownr(String mode,
                   String uri)

chownr

public void chownr(String mode,
                   String... uris)

chown

public void chown(boolean recursive,
                  String owner,
                  String uri)

chown

public void chown(boolean recursive,
                  String owner,
                  String... uris)

copyFromLocal

public void copyFromLocal(String src,
                          String dst)

copyFromLocal

public void copyFromLocal(String src,
                          String src2,
                          String... dst)

copyToLocal

public void copyToLocal(String src,
                        String localdst)

copyToLocal

public void copyToLocal(boolean ignorecrc,
                        boolean crc,
                        String src,
                        String localdst)

count

public Map<Path,ContentSummary> count(String uri)

count

public Map<Path,ContentSummary> count(String... uris)

count

public Map<Path,ContentSummary> count(boolean quota,
                                      String uri)

count

public Map<Path,ContentSummary> count(boolean quota,
                                      String... uris)

cp

public void cp(String src,
               String dst)

cp

public void cp(String src,
               String src2,
               String... dst)

du

public Map<Path,Long> du(String uri)

du

public Map<Path,Long> du(String... uris)

du

public Map<Path,Long> du(boolean summary,
                         String string)

du

public Map<Path,Long> du(boolean summary,
                         String... strings)

dus

public Map<Path,Long> dus(String string)

dus

public Map<Path,Long> dus(String... strings)

expunge

public void expunge()

get

public void get(String src,
                String dst)

get

public void get(boolean ignorecrc,
                boolean crc,
                String src,
                String dst)

getmerge

public void getmerge(String src,
                     String localdst)

getmerge

public void getmerge(String src,
                     String localdst,
                     boolean addnl)

ls

public Collection<FileStatus> ls(String match)

ls

public Collection<FileStatus> ls(String... match)

ls

public Collection<FileStatus> ls(boolean recursive,
                                 String match)

ls

public Collection<FileStatus> ls(boolean recursive,
                                 String... match)

lsr

public Collection<FileStatus> lsr(String match)

lsr

public Collection<FileStatus> lsr(String... match)

mkdir

public void mkdir(String uri)

mkdir

public void mkdir(String... uris)

moveFromLocal

public void moveFromLocal(String localsrc,
                          String dst)

moveFromLocal

public void moveFromLocal(String localsrc,
                          String localsrc2,
                          String... dst)

moveToLocal

public void moveToLocal(String src,
                        String dst)

moveToLocal

public void moveToLocal(boolean crc,
                        String src,
                        String dst)

mv

public void mv(String src,
               String dst)

mv

public void mv(String src,
               String src2,
               String... dst)

put

public void put(String localsrc,
                String dst)

put

public void put(String localsrc,
                String localsrc2,
                String... dst)

rm

public void rm(String uri)

rm

public void rm(String... uris)

rm

public void rm(boolean recursive,
               String uri)

rm

public void rm(boolean recursive,
               String... uris)

rm

public void rm(boolean recursive,
               boolean skipTrash,
               String... uris)

rmr

public void rmr(String uri)

rmr

public void rmr(String... uris)

rmr

public void rmr(boolean skipTrash,
                String uri)

rmr

public void rmr(boolean skipTrash,
                String... uris)

setrep

public void setrep(short replication,
                   String uri)

setrep

public void setrep(short replication,
                   String... uris)

setrep

public void setrep(boolean recursive,
                   short replication,
                   String uri)

setrep

public void setrep(boolean recursive,
                   short replication,
                   String... uris)

setrepr

public void setrepr(short replication,
                    String... uris)

setrepr

public void setrepr(short replication,
                    String uri)

setrepr

public void setrepr(long secondsToWait,
                    short replication,
                    String uri)

setrepr

public void setrepr(long secondsToWait,
                    short replication,
                    String... uris)

setrep

public void setrep(long secondsToWait,
                   boolean recursive,
                   short replication,
                   String uri)

setrep

public void setrep(long secondsToWait,
                   boolean recursive,
                   short replication,
                   String... uris)

test

public boolean test(String uri)

test

public boolean test(boolean exists,
                    boolean zero,
                    boolean directory,
                    String uri)

text

public Collection<String> text(String uri)

text

public Collection<String> text(String... uris)

touchz

public void touchz(String uri)

touchz

public void touchz(String... uris)